Definitions

CaseDetails

Name Schema

closureGoal
optional

integer (int32)

cost
optional

integer (int32)

dataFields
optional

< DataFieldValue > array

dateClosed
optional

string (date-time)

dateCreated
optional

string (date-time)

dateDue
optional

string (date-time)

dateModified
optional

string (date-time)

id
optional

integer (int32)

isClosed
optional

boolean

isOverDue
optional

boolean

links
optional

< string, object > map

listValues
optional

< ProgramListValue > array

name
optional

string

postOverDueDateTime
optional

string (date-time)

preOverDueDateTime
optional

string (date-time)

roles
optional

< CaseRole > array

source
optional

CaseSource

triggerId
optional

integer (int32)

triggerName
optional

string

workflowId
optional

integer (int32)

CaseListItem

Name Schema

closureGoal
optional

integer (int32)

cost
optional

integer (int32)

dataFields
optional

< DataFieldValue > array

dateClosed
optional

string (date-time)

dateCreated
optional

string (date-time)

dateDue
optional

string (date-time)

dateModified
optional

string (date-time)

id
optional

integer (int32)

isClosed
optional

boolean

links
optional

< string, object > map

listValues
optional

< ProgramListValue > array

name
optional

string

roles
optional

< CaseRole > array

source
optional

CaseSource

triggerId
optional

integer (int32)

triggerName
optional

string

workflowId
optional

integer (int32)

workflowName
optional

string

CaseListProperty

A reference to a property on the case list item model

Name Description Schema

property
required

The name of the case property referenced
Minimum length : 1

string

propertyId
optional

(optional) An identifier for a specific item in a collection property

integer (int32)

CaseListQuery

A request for a filtered and paginated list of cases

Name Description Schema

filters
optional

(optional) Filters to apply on this request

< CaseListQueryFilter > array

include
optional

(optional) Case properties to include in the response

< CaseListProperty > array

orderBy
optional

CaseListProperty

orderByAscending
optional

(optional) Specifies whether to sort the list in ascending or descending order, using the property specified in OrderBy
Default : false

boolean

skip
optional

(optional) The number of items to skip for this request. Default is 0.
Default : 0

integer (int32)

top
optional

(optional) The number of items to return on this request, up to a maximum of 100. Default is 100.
Default : 100
Minimum value : 0
Maximum value : 100

integer (int32)

CaseListQueryFilter

Defines a filter to apply to the case list

Name Description Schema

property
required

The name of the case property referenced
Minimum length : 1

string

propertyId
optional

(optional) An identifier for a specific item in a collection property

integer (int32)

type
optional

QueryFilterType

value
optional

(optional) The value to filter the referenced property on

object

CaseNote

Name Schema

caseId
optional

integer (int32)

comments
optional

string

createdBy
optional

User

dateCreated
optional

string (date-time)

dateModified
optional

string (date-time)

id
optional

integer (int32)

isSystemGenerated
optional

boolean

links
optional

< string, object > map

modifiedBy
optional

User

CaseRole

Name Schema

caseId
optional

integer (int32)

id
optional

integer (int32)

name
optional

string

users
optional

< User > array

workflowRoleIsActive
optional

boolean

CaseSource

Name Schema

responseId
optional

string

sourceId
optional

string

surveyId
optional

string

DataFieldValue

Name Schema

caseId
optional

integer (int32)

id
optional

integer (int32)

name
optional

string

questionName
optional

string

value
optional

string

LookupType

Type : enum (status, severity, category, custom)

ProgramList

Name Schema

defaultItem
optional

integer (int32)

id
optional

integer (int32)

items
optional

< ProgramListItem > array

lastUpdated
optional

string (date-time)

links
optional
read-only

< string, object > map

name
optional

string

type
optional

LookupType

ProgramListItem

Name Schema

id
optional

integer (int32)

isHigh
optional

boolean

isOpen
optional

boolean

listId
optional

integer (int32)

name
optional

string

subCategories
optional

< ProgramSubCategory > array

type
optional

LookupType

ProgramListValue

Name Schema

id
optional

integer (int32)

isHigh
optional

boolean

isOpen
optional

boolean

listId
optional

integer (int32)

name
optional

string

subCategoryId
optional

integer (int32)

subCategoryName
optional

string

type
optional

LookupType

ProgramSubCategory

Name Schema

id
optional

integer (int32)

listId
optional

integer (int32)

listItemId
optional

integer (int32)

name
optional

string

PublicApiError

Name Schema

correlationId
optional

string

message
optional

string

QueryFilterType

Type : enum (equal, notEqual, null, notNull, in, range, search, category)

ResourceCollection[CaseListItem]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CaseListItem > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[CaseNote]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CaseNote > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[ProgramList]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< ProgramList > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Role]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Role > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

Role

Name Schema

id
optional

integer (int32)

lastUpdated
optional

string (date-time)

links
optional
read-only

< string, object > map

name
optional

string

User

Name Schema

id
optional

integer (int32)

isActive
optional

boolean

links
optional

< string, object > map

userName
optional

string