Workflows API: Cases
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
get
/api/workflows/cases/{case}404
Not Found
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
200
OK
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
head
/api/workflows/cases/{case}No content
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200
OK
post
/api/workflows/cases/collect200
OK
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200
OK
post
/api/workflows/cases/count200
OK
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200
OK
post
/api/workflows/cases/download200
OK
No content
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200
OK
post
/api/workflows/cases/search200
OK
get
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
get
/api/workflows/cases-statuses/{statusId}404
Not Found
put
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Body
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
Responses
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
put
/api/workflows/cases-statuses/{statusId}404
Not Found
delete
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
204
No Content
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
delete
/api/workflows/cases-statuses/{statusId}No content
head
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
200
OK
404
Not Found
Typestring · nullableOptional
Titlestring · nullableOptional
Statusinteger · int32 · nullableOptional
Detailstring · nullableOptional
Instancestring · nullableOptional
Other propertiesanyOptional
head
/api/workflows/cases-statuses/{statusId}No content
get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdstring · uuidOptional
CaseTypeContainsstringOptional
CaseTypeExactstringOptional
StatusNameContainsstringOptional
StatusNameExactstringOptional
StatusCategoryContainsstringOptional
StatusCategoryExactstringOptional
ReportCategoryContainsstringOptional
ReportCategoryExactstringOptional
StatusSequenceSinceinteger · int32Optional
StatusSequenceBeforeinteger · int32Optional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
get
/api/workflows/cases-statuses/count200
OK
post
Authorizations
BearerstringRequired
Body
CaseTypeContainsstring · nullableOptional
CaseTypeExactstring · nullableOptional
StatusNameContainsstring · nullableOptional
StatusNameExactstring · nullableOptional
StatusCategoryContainsstring · nullableOptional
StatusCategoryExactstring · nullableOptional
ReportCategoryContainsstring · nullableOptional
ReportCategoryExactstring · nullableOptional
StatusSequenceSinceinteger · int32 · nullableOptional
StatusSequenceBeforeinteger · int32 · nullableOptional
Responses
200
OK
post
/api/workflows/cases-statuses/count200
OK
get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdstring · uuidOptional
CaseTypeContainsstringOptional
CaseTypeExactstringOptional
StatusNameContainsstringOptional
StatusNameExactstringOptional
StatusCategoryContainsstringOptional
StatusCategoryExactstringOptional
ReportCategoryContainsstringOptional
ReportCategoryExactstringOptional
StatusSequenceSinceinteger · int32Optional
StatusSequenceBeforeinteger · int32Optional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
get
/api/workflows/cases-statuses200
OK
post
Authorizations
BearerstringRequired
Body
CaseTypestring · nullableOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
Responses
201
Created
400
Bad Request
post
/api/workflows/cases-statusespost
Authorizations
BearerstringRequired
Body
CaseTypeContainsstring · nullableOptional
CaseTypeExactstring · nullableOptional
StatusNameContainsstring · nullableOptional
StatusNameExactstring · nullableOptional
StatusCategoryContainsstring · nullableOptional
StatusCategoryExactstring · nullableOptional
ReportCategoryContainsstring · nullableOptional
ReportCategoryExactstring · nullableOptional
StatusSequenceSinceinteger · int32 · nullableOptional
StatusSequenceBeforeinteger · int32 · nullableOptional
Responses
200
OK
post
/api/workflows/cases-statuses/collect200
OK
get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdstring · uuidOptional
CaseTypeContainsstringOptional
CaseTypeExactstringOptional
StatusNameContainsstringOptional
StatusNameExactstringOptional
StatusCategoryContainsstringOptional
StatusCategoryExactstringOptional
ReportCategoryContainsstringOptional
ReportCategoryExactstringOptional
StatusSequenceSinceinteger · int32Optional
StatusSequenceBeforeinteger · int32Optional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
get
/api/workflows/cases-statuses/search200
OK
post
Authorizations
BearerstringRequired
Body
CaseTypeContainsstring · nullableOptional
CaseTypeExactstring · nullableOptional
StatusNameContainsstring · nullableOptional
StatusNameExactstring · nullableOptional
StatusCategoryContainsstring · nullableOptional
StatusCategoryExactstring · nullableOptional
ReportCategoryContainsstring · nullableOptional
ReportCategoryExactstring · nullableOptional
StatusSequenceSinceinteger · int32 · nullableOptional
StatusSequenceBeforeinteger · int32 · nullableOptional
Responses
200
OK
post
/api/workflows/cases-statuses/search200
OK
get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdstring · uuidOptional
CaseTypeContainsstringOptional
CaseTypeExactstringOptional
StatusNameContainsstringOptional
StatusNameExactstringOptional
StatusCategoryContainsstringOptional
StatusCategoryExactstringOptional
ReportCategoryContainsstringOptional
ReportCategoryExactstringOptional
StatusSequenceSinceinteger · int32Optional
StatusSequenceBeforeinteger · int32Optional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
get
/api/workflows/cases-statuses/download200
OK
No content
post
Authorizations
BearerstringRequired
Body
CaseTypeContainsstring · nullableOptional
CaseTypeExactstring · nullableOptional
StatusNameContainsstring · nullableOptional
StatusNameExactstring · nullableOptional
StatusCategoryContainsstring · nullableOptional
StatusCategoryExactstring · nullableOptional
ReportCategoryContainsstring · nullableOptional
ReportCategoryExactstring · nullableOptional
StatusSequenceSinceinteger · int32 · nullableOptional
StatusSequenceBeforeinteger · int32 · nullableOptional
Responses
200
OK
post
/api/workflows/cases-statuses/download200
OK
No content
Last updated
Was this helpful?