Workflow API: Cases

Retrieves one specific case

get
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases/{case}
200

OK

Checks for the existence of one specific case

head
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases/{case}
200

OK

Collects the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
administratorUserIdentifierstring · uuid | nullableOptional
employerGroupIdentifierstring · uuid | nullableOptional
caseClosedBystring · uuid | nullableOptional
caseOpenedBystring · uuid | nullableOptional
caseStatusIdentifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
lawyerUserIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
ownerUserIdentifierstring · uuid | nullableOptional
responseSessionIdentifierstring · uuid | nullableOptional
topicUserIdentifierstring · uuid | nullableOptional
caseDescriptionstring | nullableOptional
caseSourcestring | nullableOptional
caseStatusCategorystring | nullableOptional
caseTitlestring | nullableOptional
caseTypestring | nullableOptional
lastChangeTypestring | nullableOptional
attachmentCountinteger · int32 | nullableOptional
commentCountinteger · int32 | nullableOptional
groupCountinteger · int32 | nullableOptional
caseNumberinteger · int32 | nullableOptional
personCountinteger · int32 | nullableOptional
caseClosedstring · date-time | nullableOptional
caseOpenedstring · date-time | nullableOptional
caseReportedstring · date-time | nullableOptional
caseStatusEffectivestring · date-time | nullableOptional
lastChangeTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases/collect
200

OK

Counts the cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
administratorUserIdentifierstring · uuid | nullableOptional
employerGroupIdentifierstring · uuid | nullableOptional
caseClosedBystring · uuid | nullableOptional
caseOpenedBystring · uuid | nullableOptional
caseStatusIdentifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
lawyerUserIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
ownerUserIdentifierstring · uuid | nullableOptional
responseSessionIdentifierstring · uuid | nullableOptional
topicUserIdentifierstring · uuid | nullableOptional
caseDescriptionstring | nullableOptional
caseSourcestring | nullableOptional
caseStatusCategorystring | nullableOptional
caseTitlestring | nullableOptional
caseTypestring | nullableOptional
lastChangeTypestring | nullableOptional
attachmentCountinteger · int32 | nullableOptional
commentCountinteger · int32 | nullableOptional
groupCountinteger · int32 | nullableOptional
caseNumberinteger · int32 | nullableOptional
personCountinteger · int32 | nullableOptional
caseClosedstring · date-time | nullableOptional
caseOpenedstring · date-time | nullableOptional
caseReportedstring · date-time | nullableOptional
caseStatusEffectivestring · date-time | nullableOptional
lastChangeTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases/count
200

OK

Downloads the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
administratorUserIdentifierstring · uuid | nullableOptional
employerGroupIdentifierstring · uuid | nullableOptional
caseClosedBystring · uuid | nullableOptional
caseOpenedBystring · uuid | nullableOptional
caseStatusIdentifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
lawyerUserIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
ownerUserIdentifierstring · uuid | nullableOptional
responseSessionIdentifierstring · uuid | nullableOptional
topicUserIdentifierstring · uuid | nullableOptional
caseDescriptionstring | nullableOptional
caseSourcestring | nullableOptional
caseStatusCategorystring | nullableOptional
caseTitlestring | nullableOptional
caseTypestring | nullableOptional
lastChangeTypestring | nullableOptional
attachmentCountinteger · int32 | nullableOptional
commentCountinteger · int32 | nullableOptional
groupCountinteger · int32 | nullableOptional
caseNumberinteger · int32 | nullableOptional
personCountinteger · int32 | nullableOptional
caseClosedstring · date-time | nullableOptional
caseOpenedstring · date-time | nullableOptional
caseReportedstring · date-time | nullableOptional
caseStatusEffectivestring · date-time | nullableOptional
lastChangeTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases/download
200

OK

No content

Searches for the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
administratorUserIdentifierstring · uuid | nullableOptional
employerGroupIdentifierstring · uuid | nullableOptional
caseClosedBystring · uuid | nullableOptional
caseOpenedBystring · uuid | nullableOptional
caseStatusIdentifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
lawyerUserIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
ownerUserIdentifierstring · uuid | nullableOptional
responseSessionIdentifierstring · uuid | nullableOptional
topicUserIdentifierstring · uuid | nullableOptional
caseDescriptionstring | nullableOptional
caseSourcestring | nullableOptional
caseStatusCategorystring | nullableOptional
caseTitlestring | nullableOptional
caseTypestring | nullableOptional
lastChangeTypestring | nullableOptional
attachmentCountinteger · int32 | nullableOptional
commentCountinteger · int32 | nullableOptional
groupCountinteger · int32 | nullableOptional
caseNumberinteger · int32 | nullableOptional
personCountinteger · int32 | nullableOptional
caseClosedstring · date-time | nullableOptional
caseOpenedstring · date-time | nullableOptional
caseReportedstring · date-time | nullableOptional
caseStatusEffectivestring · date-time | nullableOptional
lastChangeTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases/search
200

OK

Retrieves one specific case document

get
Authorizations
BearerstringRequired
Path parameters
attachmentstring · uuidRequired
documentstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases-documents/{document}
200

OK

Checks for the existence of one specific case document

head
Authorizations
BearerstringRequired
Path parameters
attachmentstring · uuidRequired
documentstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases-documents/{document}
200

OK

Collects the list of case documents that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
fileIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
posterIdentifierstring · uuid | nullableOptional
fileNamestring | nullableOptional
fileTypestring | nullableOptional
attachmentPostedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents/collect
200

OK

Counts the case documents that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
fileIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
posterIdentifierstring · uuid | nullableOptional
fileNamestring | nullableOptional
fileTypestring | nullableOptional
attachmentPostedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents/count
200

OK

Downloads the list of case documents that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
fileIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
posterIdentifierstring · uuid | nullableOptional
fileNamestring | nullableOptional
fileTypestring | nullableOptional
attachmentPostedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases-documents/download
200

OK

No content

Searches for the list of case documents that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
fileIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
posterIdentifierstring · uuid | nullableOptional
fileNamestring | nullableOptional
fileTypestring | nullableOptional
attachmentPostedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents/search
200

OK

Retrieves one specific case document request

get
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
requestedFileCategorystringRequired
relationshipstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases-documents-requests/{relationship}
200

OK

Checks for the existence of one specific case document request

head
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
requestedFileCategorystringRequired
relationshipstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases-documents-requests/{relationship}
200

OK

Collects the list of case document requests that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
requestedUserIdentifierstring · uuid | nullableOptional
requestedFileDescriptionstring | nullableOptional
requestedFileSubcategorystring | nullableOptional
requestedFromstring | nullableOptional
requestedTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents-requests/collect
200

OK

Counts the case document requests that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
requestedUserIdentifierstring · uuid | nullableOptional
requestedFileDescriptionstring | nullableOptional
requestedFileSubcategorystring | nullableOptional
requestedFromstring | nullableOptional
requestedTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents-requests/count
200

OK

Downloads the list of case document requests that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
requestedUserIdentifierstring · uuid | nullableOptional
requestedFileDescriptionstring | nullableOptional
requestedFileSubcategorystring | nullableOptional
requestedFromstring | nullableOptional
requestedTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases-documents-requests/download
200

OK

No content

Searches for the list of case document requests that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
requestedUserIdentifierstring · uuid | nullableOptional
requestedFileDescriptionstring | nullableOptional
requestedFileSubcategorystring | nullableOptional
requestedFromstring | nullableOptional
requestedTimestring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-documents-requests/search
200

OK

Retrieves one specific case group

get
Authorizations
BearerstringRequired
Path parameters
joinstring · uuidRequired
relationshipstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases-groups/{relationship}
200

OK

Checks for the existence of one specific case group

head
Authorizations
BearerstringRequired
Path parameters
joinstring · uuidRequired
relationshipstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases-groups/{relationship}
200

OK

Collects the list of case groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
groupIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-groups/collect
200

OK

Counts the case groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
groupIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-groups/count
200

OK

Downloads the list of case groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
groupIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases-groups/download
200

OK

No content

Searches for the list of case groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
groupIdentifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-groups/search
200

OK

get
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases-statuses/{statusId}
200

OK

put
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Body
statusNamestring | nullableOptional
statusSequenceinteger · int32Optional
statusCategorystring | nullableOptional
reportCategorystring | nullableOptional
statusDescriptionstring | nullableOptional
Responses
chevron-right
200

OK

put
/api/workflow/cases-statuses/{statusId}
delete
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
delete
/api/workflow/cases-statuses/{statusId}

No content

head
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases-statuses/{statusId}
200

OK

get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdentifierstring · 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
chevron-right
200

OK

get
/api/workflow/cases-statuses/count
200

OK

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseTypeContainsstring | nullableOptional
caseTypeExactstring | nullableOptional
statusNameContainsstring | nullableOptional
statusNameExactstring | nullableOptional
statusCategoryContainsstring | nullableOptional
statusCategoryExactstring | nullableOptional
reportCategoryContainsstring | nullableOptional
reportCategoryExactstring | nullableOptional
statusSequenceSinceinteger · int32 | nullableOptional
statusSequenceBeforeinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-statuses/count
200

OK

get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdentifierstring · 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
chevron-right
200

OK

get
/api/workflow/cases-statuses
200

OK

post
Authorizations
BearerstringRequired
Body
caseTypestring | nullableOptional
statusNamestring | nullableOptional
statusSequenceinteger · int32Optional
statusCategorystring | nullableOptional
reportCategorystring | nullableOptional
statusDescriptionstring | nullableOptional
Responses
post
/api/workflow/cases-statuses
post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseTypeContainsstring | nullableOptional
caseTypeExactstring | nullableOptional
statusNameContainsstring | nullableOptional
statusNameExactstring | nullableOptional
statusCategoryContainsstring | nullableOptional
statusCategoryExactstring | nullableOptional
reportCategoryContainsstring | nullableOptional
reportCategoryExactstring | nullableOptional
statusSequenceSinceinteger · int32 | nullableOptional
statusSequenceBeforeinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-statuses/collect
200

OK

Authorizations
BearerstringRequired
Query parameters
OrganizationIdentifierstring · 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
chevron-right
200

OK

get
/api/workflow/cases-statuses/search
200

OK

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseTypeContainsstring | nullableOptional
caseTypeExactstring | nullableOptional
statusNameContainsstring | nullableOptional
statusNameExactstring | nullableOptional
statusCategoryContainsstring | nullableOptional
statusCategoryExactstring | nullableOptional
reportCategoryContainsstring | nullableOptional
reportCategoryExactstring | nullableOptional
statusSequenceSinceinteger · int32 | nullableOptional
statusSequenceBeforeinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-statuses/search
200

OK

get
Authorizations
BearerstringRequired
Query parameters
OrganizationIdentifierstring · 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
chevron-right
200

OK

No content

get
/api/workflow/cases-statuses/download
200

OK

No content

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
caseTypeContainsstring | nullableOptional
caseTypeExactstring | nullableOptional
statusNameContainsstring | nullableOptional
statusNameExactstring | nullableOptional
statusCategoryContainsstring | nullableOptional
statusCategoryExactstring | nullableOptional
reportCategoryContainsstring | nullableOptional
reportCategoryExactstring | nullableOptional
statusSequenceSinceinteger · int32 | nullableOptional
statusSequenceBeforeinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases-statuses/download
200

OK

No content

Retrieves one specific case user

get
Authorizations
BearerstringRequired
Path parameters
joinstring · uuidRequired
relationshipstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/cases-users/{relationship}
200

OK

Checks for the existence of one specific case user

head
Authorizations
BearerstringRequired
Path parameters
joinstring · uuidRequired
relationshipstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/cases-users/{relationship}
200

OK

Collects the list of case users that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
userIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-users/collect
200

OK

Counts the case users that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
userIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-users/count
200

OK

Downloads the list of case users that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
userIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/cases-users/download
200

OK

No content

Searches for the list of case users that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
caseIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
userIdentifierstring · uuid | nullableOptional
caseRolestring | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/cases-users/search
200

OK

Last updated

Was this helpful?