TASKANA RESTful API Documentation

Message Variables

Type

accessId

String

attachmentId

String

classificationId

String

classificationKey

String

currentUserId

String

customHoliday

String

databaseProductName

String

domain

String

externalTaskId

String

historyEventId

String

malformedQueryParameters

MalformedQueryParameter[]

requiredCallbackStates

CallbackState[]

requiredPermissions

WorkbasketPermission[]

requiredTaskStates

TaskState[]

roles

TaskanaRole[]

taskCallbackState

CallbackState

taskCommentId

String

taskId

String

taskState

TaskState

workbasketId

String

workbasketKey

String

taskId

String

true

Unique Id.

externalId

String

true

External Id. Can be used to enforce idempotence at task creation. Can identify an external task.

created

String

true

The creation timestamp in the system.

claimed

String

true

The timestamp of the last claim-operation.

completed

String

true

The timestamp of the completion.

modified

String

true

The timestamp of the last modification.

planned

String

true

Planned start of the task. The actual completion of the task should be between PLANNED and DUE.

received

String

true

Timestamp when the task has been received. It notes when the surrounding process started and not just when the actual task was created.

due

String

true

Timestamp when the task is due. The actual completion of the task should be between PLANNED and DUE.

name

String

true

The name of the task.

creator

String

true

The creator of the task.

note

String

true

Note.

description

String

true

The description of the task.

priority

Integer

true

The priority of the task.

manualPriority

Integer

true

The manual priority of the task. If the value of manualPriority is zero or greater, the priority is automatically set to manualPriority. In this case, all computations of priority are disabled. If the value of manualPriority is negative, Tasks are not prioritized manually.

state

String

true

The current task state.

Must be one of [READY, CLAIMED, READY_FOR_REVIEW, IN_REVIEW, COMPLETED, CANCELLED, TERMINATED].

classificationSummary

Object

true

The classification of this task.

classificationSummary.classificationId

String

true

Unique Id.

classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

classificationSummary.domain

String

true

The domain for which this classification is specified.

classificationSummary.name

String

true

The name of the classification.

classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.priority

Integer

true

The priority of the classification.

classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

classificationSummary.custom1

String

true

A custom property with name "1".

classificationSummary.custom2

String

true

A custom property with name "2".

classificationSummary.custom3

String

true

A custom property with name "3".

classificationSummary.custom4

String

true

A custom property with name "4".

classificationSummary.custom5

String

true

A custom property with name "5".

classificationSummary.custom6

String

true

A custom property with name "6".

classificationSummary.custom7

String

true

A custom property with name "7".

classificationSummary.custom8

String

true

A custom property with name "8".

workbasketSummary

Object

true

The workbasket this task resides in.

workbasketSummary.workbasketId

String

true

Unique Id.

workbasketSummary.key

String

true

The professional key for the workbasket.

workbasketSummary.name

String

true

The name of the workbasket.

workbasketSummary.domain

String

true

The domain the workbasket belongs to.

workbasketSummary.type

String

true

The type of the workbasket.

Must be one of [GROUP, PERSONAL, TOPIC, CLEARANCE].

workbasketSummary.description

String

true

The description of the workbasket.

workbasketSummary.owner

String

true

The owner of the workbasket. The owner is responsible for the on-time completion of all tasks in the workbasket.

workbasketSummary.custom1

String

true

A custom property with name "1".

workbasketSummary.custom2

String

true

A custom property with name "2".

workbasketSummary.custom3

String

true

A custom property with name "3".

workbasketSummary.custom4

String

true

A custom property with name "4".

workbasketSummary.custom5

String

true

A custom property with name "5".

workbasketSummary.custom6

String

true

A custom property with name "6".

workbasketSummary.custom7

String

true

A custom property with name "7".

workbasketSummary.custom8

String

true

A custom property with name "8".

workbasketSummary.orgLevel1

String

true

The first Org Level (the top one).

The Org Level is an association with an org hierarchy level in the organization. The values are used for monitoring and statistical purposes and should reflect who is responsible of the tasks in the workbasket.

workbasketSummary.orgLevel2

String

true

The second Org Level.

workbasketSummary.orgLevel3

String

true

The third Org Level.

workbasketSummary.orgLevel4

String

true

The fourth Org Level (the lowest one).

workbasketSummary.markedForDeletion

Boolean

true

Identifier to tell if this workbasket can be deleted.

businessProcessId

String

true

The business process id.

parentBusinessProcessId

String

true

The parent business process id.

owner

String

true

The owner of the task. The owner is set upon claiming of the task.

ownerLongName

String

true

The long name of the task owner.

primaryObjRef

Object

true

The Objects primary ObjectReference.

primaryObjRef.id

String

true

Unique ID.

primaryObjRef.taskId

String

true

Task Id.

primaryObjRef.company

String

true

The company the referenced primary object belongs to.

primaryObjRef.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

primaryObjRef.systemInstance

String

true

The instance of the system where the referenced primary object is located.

primaryObjRef.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

primaryObjRef.value

String

true

The value of the primary object reference.

groupByCount

Integer

true

Number of Tasks that are grouped together with this Task during a groupBy.

custom1

String

true

A custom property with name "1".

custom2

String

true

A custom property with name "2".

custom3

String

true

A custom property with name "3".

custom4

String

true

A custom property with name "4".

custom5

String

true

A custom property with name "5".

custom6

String

true

A custom property with name "6".

custom7

String

true

A custom property with name "7".

custom8

String

true

A custom property with name "8".

custom9

String

true

A custom property with name "9".

custom10

String

true

A custom property with name "10".

custom11

String

true

A custom property with name "11".

custom12

String

true

A custom property with name "12".

custom13

String

true

A custom property with name "13".

custom14

String

true

A custom property with name "14".

custom15

String

true

A custom property with name "15".

custom16

String

true

A custom property with name "16".

customInt1

Integer

true

A custom int property with name "1".

customInt2

Integer

true

A custom int property with name "2".

customInt3

Integer

true

A custom int property with name "3".

customInt4

Integer

true

A custom int property with name "4".

customInt5

Integer

true

A custom int property with name "5".

customInt6

Integer

true

A custom int property with name "6".

customInt7

Integer

true

A custom int property with name "7".

customInt8

Integer

true

A custom int property with name "8".

secondaryObjectReferences

Array[Object]

true

Secondary object references of the task.

secondaryObjectReferences[].id

String

true

Unique ID.

secondaryObjectReferences[].taskId

String

true

Task Id.

secondaryObjectReferences[].company

String

true

The company the referenced primary object belongs to.

secondaryObjectReferences[].system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

secondaryObjectReferences[].systemInstance

String

true

The instance of the system where the referenced primary object is located.

secondaryObjectReferences[].type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

secondaryObjectReferences[].value

String

true

The value of the primary object reference.

customAttributes

Array[Object]

true

Additional information of the task.

customAttributes[].key

String

true

The key of the custom attribute.

customAttributes[].value

String

true

The value of the custom attribute.

callbackInfo

Array[Object]

true

Callback Information of the task.

callbackInfo[].key

String

true

The key of the custom attribute.

callbackInfo[].value

String

true

The value of the custom attribute.

attachments

Array[Object]

true

Attachments of the task.

attachments[].attachmentId

String

true

Unique Id.

attachments[].taskId

String

true

The referenced task id.

attachments[].created

String

true

The creation timestamp in the system.

attachments[].modified

String

true

The timestamp of the last modification.

attachments[].received

String

true

The timestamp of the entry date.

attachments[].classificationSummary

Object

true

The classification of this attachment.

attachments[].classificationSummary.classificationId

String

true

Unique Id.

attachments[].classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

attachments[].classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

attachments[].classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.domain

String

true

The domain for which this classification is specified.

attachments[].classificationSummary.name

String

true

The name of the classification.

attachments[].classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.priority

Integer

true

The priority of the classification.

attachments[].classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

attachments[].classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.custom1

String

true

A custom property with name "1".

attachments[].classificationSummary.custom2

String

true

A custom property with name "2".

attachments[].classificationSummary.custom3

String

true

A custom property with name "3".

attachments[].classificationSummary.custom4

String

true

A custom property with name "4".

attachments[].classificationSummary.custom5

String

true

A custom property with name "5".

attachments[].classificationSummary.custom6

String

true

A custom property with name "6".

attachments[].classificationSummary.custom7

String

true

A custom property with name "7".

attachments[].classificationSummary.custom8

String

true

A custom property with name "8".

attachments[].objectReference

Object

true

The Objects primary ObjectReference.

attachments[].objectReference.id

String

true

Unique ID.

attachments[].objectReference.taskId

String

true

Task Id.

attachments[].objectReference.company

String

true

The company the referenced primary object belongs to.

attachments[].objectReference.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

attachments[].objectReference.systemInstance

String

true

The instance of the system where the referenced primary object is located.

attachments[].objectReference.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

attachments[].objectReference.value

String

true

The value of the primary object reference.

attachments[].channel

String

true

Determines on which channel this attachment was received.

attachments[].customAttributes

Map

true

All additional information of the Attachment.

read

Boolean

true

Indicator if the task has been read.

transferred

Boolean

true

Indicator if the task has been transferred.

taskId

String

true

Unique Id.

externalId

String

true

External Id. Can be used to enforce idempotence at task creation. Can identify an external task.

created

String

true

The creation timestamp in the system.

claimed

String

true

The timestamp of the last claim-operation.

completed

String

true

The timestamp of the completion.

modified

String

true

The timestamp of the last modification.

planned

String

true

Planned start of the task. The actual completion of the task should be between PLANNED and DUE.

received

String

true

Timestamp when the task has been received. It notes when the surrounding process started and not just when the actual task was created.

due

String

true

Timestamp when the task is due. The actual completion of the task should be between PLANNED and DUE.

name

String

true

The name of the task.

creator

String

true

The creator of the task.

note

String

true

Note.

description

String

true

The description of the task.

priority

Integer

true

The priority of the task.

manualPriority

Integer

true

The manual priority of the task. If the value of manualPriority is zero or greater, the priority is automatically set to manualPriority. In this case, all computations of priority are disabled. If the value of manualPriority is negative, Tasks are not prioritized manually.

state

String

true

The current task state.

Must be one of [READY, CLAIMED, READY_FOR_REVIEW, IN_REVIEW, COMPLETED, CANCELLED, TERMINATED].

classificationSummary

Object

true

The classification of this task.

classificationSummary.classificationId

String

true

Unique Id.

classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

classificationSummary.domain

String

true

The domain for which this classification is specified.

classificationSummary.name

String

true

The name of the classification.

classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.priority

Integer

true

The priority of the classification.

classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

classificationSummary.custom1

String

true

A custom property with name "1".

classificationSummary.custom2

String

true

A custom property with name "2".

classificationSummary.custom3

String

true

A custom property with name "3".

classificationSummary.custom4

String

true

A custom property with name "4".

classificationSummary.custom5

String

true

A custom property with name "5".

classificationSummary.custom6

String

true

A custom property with name "6".

classificationSummary.custom7

String

true

A custom property with name "7".

classificationSummary.custom8

String

true

A custom property with name "8".

workbasketSummary

Object

true

The workbasket this task resides in.

workbasketSummary.workbasketId

String

true

Unique Id.

workbasketSummary.key

String

true

The professional key for the workbasket.

workbasketSummary.name

String

true

The name of the workbasket.

workbasketSummary.domain

String

true

The domain the workbasket belongs to.

workbasketSummary.type

String

true

The type of the workbasket.

Must be one of [GROUP, PERSONAL, TOPIC, CLEARANCE].

workbasketSummary.description

String

true

The description of the workbasket.

workbasketSummary.owner

String

true

The owner of the workbasket. The owner is responsible for the on-time completion of all tasks in the workbasket.

workbasketSummary.custom1

String

true

A custom property with name "1".

workbasketSummary.custom2

String

true

A custom property with name "2".

workbasketSummary.custom3

String

true

A custom property with name "3".

workbasketSummary.custom4

String

true

A custom property with name "4".

workbasketSummary.custom5

String

true

A custom property with name "5".

workbasketSummary.custom6

String

true

A custom property with name "6".

workbasketSummary.custom7

String

true

A custom property with name "7".

workbasketSummary.custom8

String

true

A custom property with name "8".

workbasketSummary.orgLevel1

String

true

The first Org Level (the top one).

The Org Level is an association with an org hierarchy level in the organization. The values are used for monitoring and statistical purposes and should reflect who is responsible of the tasks in the workbasket.

workbasketSummary.orgLevel2

String

true

The second Org Level.

workbasketSummary.orgLevel3

String

true

The third Org Level.

workbasketSummary.orgLevel4

String

true

The fourth Org Level (the lowest one).

workbasketSummary.markedForDeletion

Boolean

true

Identifier to tell if this workbasket can be deleted.

businessProcessId

String

true

The business process id.

parentBusinessProcessId

String

true

The parent business process id.

owner

String

true

The owner of the task. The owner is set upon claiming of the task.

ownerLongName

String

true

The long name of the task owner.

primaryObjRef

Object

true

The Objects primary ObjectReference.

primaryObjRef.id

String

true

Unique ID.

primaryObjRef.taskId

String

true

Task Id.

primaryObjRef.company

String

true

The company the referenced primary object belongs to.

primaryObjRef.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

primaryObjRef.systemInstance

String

true

The instance of the system where the referenced primary object is located.

primaryObjRef.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

primaryObjRef.value

String

true

The value of the primary object reference.

groupByCount

Integer

true

Number of Tasks that are grouped together with this Task during a groupBy.

custom1

String

true

A custom property with name "1".

custom2

String

true

A custom property with name "2".

custom3

String

true

A custom property with name "3".

custom4

String

true

A custom property with name "4".

custom5

String

true

A custom property with name "5".

custom6

String

true

A custom property with name "6".

custom7

String

true

A custom property with name "7".

custom8

String

true

A custom property with name "8".

custom9

String

true

A custom property with name "9".

custom10

String

true

A custom property with name "10".

custom11

String

true

A custom property with name "11".

custom12

String

true

A custom property with name "12".

custom13

String

true

A custom property with name "13".

custom14

String

true

A custom property with name "14".

custom15

String

true

A custom property with name "15".

custom16

String

true

A custom property with name "16".

customInt1

Integer

true

A custom int property with name "1".

customInt2

Integer

true

A custom int property with name "2".

customInt3

Integer

true

A custom int property with name "3".

customInt4

Integer

true

A custom int property with name "4".

customInt5

Integer

true

A custom int property with name "5".

customInt6

Integer

true

A custom int property with name "6".

customInt7

Integer

true

A custom int property with name "7".

customInt8

Integer

true

A custom int property with name "8".

secondaryObjectReferences

Array[Object]

true

Secondary object references of the task.

secondaryObjectReferences[].id

String

true

Unique ID.

secondaryObjectReferences[].taskId

String

true

Task Id.

secondaryObjectReferences[].company

String

true

The company the referenced primary object belongs to.

secondaryObjectReferences[].system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

secondaryObjectReferences[].systemInstance

String

true

The instance of the system where the referenced primary object is located.

secondaryObjectReferences[].type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

secondaryObjectReferences[].value

String

true

The value of the primary object reference.

customAttributes

Array[Object]

true

Additional information of the task.

customAttributes[].key

String

true

The key of the custom attribute.

customAttributes[].value

String

true

The value of the custom attribute.

callbackInfo

Array[Object]

true

Callback Information of the task.

callbackInfo[].key

String

true

The key of the custom attribute.

callbackInfo[].value

String

true

The value of the custom attribute.

attachments

Array[Object]

true

Attachments of the task.

attachments[].attachmentId

String

true

Unique Id.

attachments[].taskId

String

true

The referenced task id.

attachments[].created

String

true

The creation timestamp in the system.

attachments[].modified

String

true

The timestamp of the last modification.

attachments[].received

String

true

The timestamp of the entry date.

attachments[].classificationSummary

Object

true

The classification of this attachment.

attachments[].classificationSummary.classificationId

String

true

Unique Id.

attachments[].classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

attachments[].classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

attachments[].classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.domain

String

true

The domain for which this classification is specified.

attachments[].classificationSummary.name

String

true

The name of the classification.

attachments[].classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.priority

Integer

true

The priority of the classification.

attachments[].classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

attachments[].classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.custom1

String

true

A custom property with name "1".

attachments[].classificationSummary.custom2

String

true

A custom property with name "2".

attachments[].classificationSummary.custom3

String

true

A custom property with name "3".

attachments[].classificationSummary.custom4

String

true

A custom property with name "4".

attachments[].classificationSummary.custom5

String

true

A custom property with name "5".

attachments[].classificationSummary.custom6

String

true

A custom property with name "6".

attachments[].classificationSummary.custom7

String

true

A custom property with name "7".

attachments[].classificationSummary.custom8

String

true

A custom property with name "8".

attachments[].objectReference

Object

true

The Objects primary ObjectReference.

attachments[].objectReference.id

String

true

Unique ID.

attachments[].objectReference.taskId

String

true

Task Id.

attachments[].objectReference.company

String

true

The company the referenced primary object belongs to.

attachments[].objectReference.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

attachments[].objectReference.systemInstance

String

true

The instance of the system where the referenced primary object is located.

attachments[].objectReference.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

attachments[].objectReference.value

String

true

The value of the primary object reference.

attachments[].channel

String

true

Determines on which channel this attachment was received.

attachments[].customAttributes

Map

true

All additional information of the Attachment.

read

Boolean

true

Indicator if the task has been read.

transferred

Boolean

true

Indicator if the task has been transferred.

taskId

String

false

The Id of the requested Task.

taskId

String

true

Unique Id.

externalId

String

true

External Id. Can be used to enforce idempotence at task creation. Can identify an external task.

created

String

true

The creation timestamp in the system.

claimed

String

true

The timestamp of the last claim-operation.

completed

String

true

The timestamp of the completion.

modified

String

true

The timestamp of the last modification.

planned

String

true

Planned start of the task. The actual completion of the task should be between PLANNED and DUE.

received

String

true

Timestamp when the task has been received. It notes when the surrounding process started and not just when the actual task was created.

due

String

true

Timestamp when the task is due. The actual completion of the task should be between PLANNED and DUE.

name

String

true

The name of the task.

creator

String

true

The creator of the task.

note

String

true

Note.

description

String

true

The description of the task.

priority

Integer

true

The priority of the task.

manualPriority

Integer

true

The manual priority of the task. If the value of manualPriority is zero or greater, the priority is automatically set to manualPriority. In this case, all computations of priority are disabled. If the value of manualPriority is negative, Tasks are not prioritized manually.

state

String

true

The current task state.

Must be one of [READY, CLAIMED, READY_FOR_REVIEW, IN_REVIEW, COMPLETED, CANCELLED, TERMINATED].

classificationSummary

Object

true

The classification of this task.

classificationSummary.classificationId

String

true

Unique Id.

classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

classificationSummary.domain

String

true

The domain for which this classification is specified.

classificationSummary.name

String

true

The name of the classification.

classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

classificationSummary.priority

Integer

true

The priority of the classification.

classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

classificationSummary.custom1

String

true

A custom property with name "1".

classificationSummary.custom2

String

true

A custom property with name "2".

classificationSummary.custom3

String

true

A custom property with name "3".

classificationSummary.custom4

String

true

A custom property with name "4".

classificationSummary.custom5

String

true

A custom property with name "5".

classificationSummary.custom6

String

true

A custom property with name "6".

classificationSummary.custom7

String

true

A custom property with name "7".

classificationSummary.custom8

String

true

A custom property with name "8".

workbasketSummary

Object

true

The workbasket this task resides in.

workbasketSummary.workbasketId

String

true

Unique Id.

workbasketSummary.key

String

true

The professional key for the workbasket.

workbasketSummary.name

String

true

The name of the workbasket.

workbasketSummary.domain

String

true

The domain the workbasket belongs to.

workbasketSummary.type

String

true

The type of the workbasket.

Must be one of [GROUP, PERSONAL, TOPIC, CLEARANCE].

workbasketSummary.description

String

true

The description of the workbasket.

workbasketSummary.owner

String

true

The owner of the workbasket. The owner is responsible for the on-time completion of all tasks in the workbasket.

workbasketSummary.custom1

String

true

A custom property with name "1".

workbasketSummary.custom2

String

true

A custom property with name "2".

workbasketSummary.custom3

String

true

A custom property with name "3".

workbasketSummary.custom4

String

true

A custom property with name "4".

workbasketSummary.custom5

String

true

A custom property with name "5".

workbasketSummary.custom6

String

true

A custom property with name "6".

workbasketSummary.custom7

String

true

A custom property with name "7".

workbasketSummary.custom8

String

true

A custom property with name "8".

workbasketSummary.orgLevel1

String

true

The first Org Level (the top one).

The Org Level is an association with an org hierarchy level in the organization. The values are used for monitoring and statistical purposes and should reflect who is responsible of the tasks in the workbasket.

workbasketSummary.orgLevel2

String

true

The second Org Level.

workbasketSummary.orgLevel3

String

true

The third Org Level.

workbasketSummary.orgLevel4

String

true

The fourth Org Level (the lowest one).

workbasketSummary.markedForDeletion

Boolean

true

Identifier to tell if this workbasket can be deleted.

businessProcessId

String

true

The business process id.

parentBusinessProcessId

String

true

The parent business process id.

owner

String

true

The owner of the task. The owner is set upon claiming of the task.

ownerLongName

String

true

The long name of the task owner.

primaryObjRef

Object

true

The Objects primary ObjectReference.

primaryObjRef.id

String

true

Unique ID.

primaryObjRef.taskId

String

true

Task Id.

primaryObjRef.company

String

true

The company the referenced primary object belongs to.

primaryObjRef.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

primaryObjRef.systemInstance

String

true

The instance of the system where the referenced primary object is located.

primaryObjRef.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

primaryObjRef.value

String

true

The value of the primary object reference.

groupByCount

Integer

true

Number of Tasks that are grouped together with this Task during a groupBy.

custom1

String

true

A custom property with name "1".

custom2

String

true

A custom property with name "2".

custom3

String

true

A custom property with name "3".

custom4

String

true

A custom property with name "4".

custom5

String

true

A custom property with name "5".

custom6

String

true

A custom property with name "6".

custom7

String

true

A custom property with name "7".

custom8

String

true

A custom property with name "8".

custom9

String

true

A custom property with name "9".

custom10

String

true

A custom property with name "10".

custom11

String

true

A custom property with name "11".

custom12

String

true

A custom property with name "12".

custom13

String

true

A custom property with name "13".

custom14

String

true

A custom property with name "14".

custom15

String

true

A custom property with name "15".

custom16

String

true

A custom property with name "16".

customInt1

Integer

true

A custom int property with name "1".

customInt2

Integer

true

A custom int property with name "2".

customInt3

Integer

true

A custom int property with name "3".

customInt4

Integer

true

A custom int property with name "4".

customInt5

Integer

true

A custom int property with name "5".

customInt6

Integer

true

A custom int property with name "6".

customInt7

Integer

true

A custom int property with name "7".

customInt8

Integer

true

A custom int property with name "8".

secondaryObjectReferences

Array[Object]

true

Secondary object references of the task.

secondaryObjectReferences[].id

String

true

Unique ID.

secondaryObjectReferences[].taskId

String

true

Task Id.

secondaryObjectReferences[].company

String

true

The company the referenced primary object belongs to.

secondaryObjectReferences[].system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

secondaryObjectReferences[].systemInstance

String

true

The instance of the system where the referenced primary object is located.

secondaryObjectReferences[].type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

secondaryObjectReferences[].value

String

true

The value of the primary object reference.

customAttributes

Array[Object]

true

Additional information of the task.

customAttributes[].key

String

true

The key of the custom attribute.

customAttributes[].value

String

true

The value of the custom attribute.

callbackInfo

Array[Object]

true

Callback Information of the task.

callbackInfo[].key

String

true

The key of the custom attribute.

callbackInfo[].value

String

true

The value of the custom attribute.

attachments

Array[Object]

true

Attachments of the task.

attachments[].attachmentId

String

true

Unique Id.

attachments[].taskId

String

true

The referenced task id.

attachments[].created

String

true

The creation timestamp in the system.

attachments[].modified

String

true

The timestamp of the last modification.

attachments[].received

String

true

The timestamp of the entry date.

attachments[].classificationSummary

Object

true

The classification of this attachment.

attachments[].classificationSummary.classificationId

String

true

Unique Id.

attachments[].classificationSummary.key

String

true

The key of the Classification. This is typically an externally known code or abbreviation of the Classification.

attachments[].classificationSummary.applicationEntryPoint

String

true

The logical name of the entry point. This is needed by the task list application to determine the redirect to work on a task of this Classification.

attachments[].classificationSummary.category

String

true

The category of the classification. Categories can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.domain

String

true

The domain for which this classification is specified.

attachments[].classificationSummary.name

String

true

The name of the classification.

attachments[].classificationSummary.parentId

String

true

The Id of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.parentKey

String

true

The key of the parent classification. Empty string ("") if this is a root classification.

attachments[].classificationSummary.priority

Integer

true

The priority of the classification.

attachments[].classificationSummary.serviceLevel

String

true

The service level of the classification.

This is stated according to ISO 8601.

attachments[].classificationSummary.type

String

true

The type of classification. Types can be configured in the file 'taskana.properties'.

attachments[].classificationSummary.custom1

String

true

A custom property with name "1".

attachments[].classificationSummary.custom2

String

true

A custom property with name "2".

attachments[].classificationSummary.custom3

String

true

A custom property with name "3".

attachments[].classificationSummary.custom4

String

true

A custom property with name "4".

attachments[].classificationSummary.custom5

String

true

A custom property with name "5".

attachments[].classificationSummary.custom6

String

true

A custom property with name "6".

attachments[].classificationSummary.custom7

String

true

A custom property with name "7".

attachments[].classificationSummary.custom8

String

true

A custom property with name "8".

attachments[].objectReference

Object

true

The Objects primary ObjectReference.

attachments[].objectReference.id

String

true

Unique ID.

attachments[].objectReference.taskId

String

true

Task Id.

attachments[].objectReference.company

String

true

The company the referenced primary object belongs to.

attachments[].objectReference.system

String

true

The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, …​).

attachments[].objectReference.systemInstance

String

true

The instance of the system where the referenced primary object is located.

attachments[].objectReference.type

String

true

The type of the referenced primary object (contract, claim, policy, customer, …​).

attachments[].objectReference.value

String

true

The value of the primary object reference.

attachments[].channel

String

true

Determines on which channel this attachment was received.

attachments[].customAttributes

Map

true

All additional information of the Attachment.

read

Boolean

true

Indicator if the task has been read.

transferred

Boolean

true

Indicator if the task has been transferred.

task-id

Array[String]

true

Filter by task id. This is an exact match.

task-id-not

Array[String]

true

Filter by what the task id shouldn’t be. This is an exact match.

external-id

Array[String]

true

Filter by the external id of the Task. This is an exact match.

external-id-not

Array[String]

true

Filter by what the external id of the Task shouldn’t be. This is an exact match.

received

Array[String]

true

Filter by a time interval within which the Task was received. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'received-from' or 'received-until'.

received-from

String

true

Filter since a given received timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'received'.

received-until

String

true

Filter until a given received timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'received'.

received-not

Array[String]

true

Filter by a time interval within which the Task wasn’t received. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'received-not-in-from' or 'received-not-in-until'.

received-from-not

String

true

Filter since a given timestamp where it wasn’t received.

The format is ISO-8601.

This parameter can’t be used together with 'received-not-in'.

received-until-not

String

true

Filter until a given timestamp where it wasn’t received.

The format is ISO-8601.

This parameter can’t be used together with 'received-not-in'.

created

Array[String]

true

Filter by a time interval within which the Task was created. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'created-from' or 'created-until'.

created-from

String

true

Filter since a given created timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'created'.

created-until

String

true

Filter until a given created timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'created'.

created-not

Array[String]

true

Filter by a time interval within which the Task wasn’t created. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'created-not-in-from' or 'created-not-in-until'.

created-from-not

String

true

Filter not since a given timestamp where it wasn’t created.

The format is ISO-8601.

This parameter can’t be used together with 'created-not-in'.

created-until-not

String

true

Filter not until a given timestamp where it wasn’t created.

The format is ISO-8601.

This parameter can’t be used together with 'created-not-in'.

claimed

Array[String]

true

Filter by a time interval within which the Task was claimed. To create an open interval you can just leave it blank.

The format is ISO-8601.

claimed-not

Array[String]

true

Filter by a time interval within which the Task wasn’t claimed. To create an open interval you can just leave it blank.

The format is ISO-8601.

modified

Array[String]

true

Filter by a time interval within which the Task was modified. To create an open interval you can just leave it blank.

The format is ISO-8601.

modified-not

Array[String]

true

Filter by a time interval within which the Task wasn’t modified. To create an open interval you can just leave it blank.

The format is ISO-8601.

planned

Array[String]

true

Filter by a time interval within which the Task was planned. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'planned-from' or 'planned-until'.

planned-from

String

true

Filter since a given planned timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'planned'.

planned-until

String

true

Filter until a given planned timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'planned'.

planned-not

Array[String]

true

Filter by a time interval within which the Task was planned. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'planned-not-in-from' or 'planned-not-in-until'.

planned-from-not

String

true

Filter since a given timestamp where it wasn’t planned.

The format is ISO-8601.

This parameter can’t be used together with 'planned-not-in'.

planned-until-not

String

true

Filter until a given timestamp where it wasn’t planned.

The format is ISO-8601.

This parameter can’t be used together with 'planned-not-in'.

due

Array[String]

true

Filter by a time interval within which the Task was due. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'due-from' or 'due-until'.

due-from

String

true

Filter since a given due timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'due'.

due-until

String

true

Filter until a given due timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'due'.

due-not

Array[String]

true

Filter by a time interval within which the Task wasn’t due. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'due-not-in-from' or 'due-not-in-until'.

due-from-not

String

true

Filter since a given timestamp where it isn’t due.

The format is ISO-8601.

This parameter can’t be used together with 'due-not-in'.

due-until-not

String

true

Filter until a given timestamp where it isn’t due.

The format is ISO-8601.

This parameter can’t be used together with 'due-not-in'.

completed

Array[String]

true

Filter by a time interval within which the Task was completed. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'completed-from' or 'completed-until'.

completed-from

String

true

Filter since a given completed timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'completed'.

completed-until

String

true

Filter until a given completed timestamp.

The format is ISO-8601.

This parameter can’t be used together with 'completed'.

completed-not

Array[String]

true

Filter by a time interval within which the Task wasn’t completed. To create an open interval you can just leave it blank.

The format is ISO-8601.

This parameter can’t be used together with 'completed-not-in-from' or 'completed-not-in-until'.

completed-from-not

String

true

Filter since a given timestamp where it wasn’t completed.

The format is ISO-8601.

This parameter can’t be used together with 'completed-not-in'.

completed-until-not

String

true

Filter until a given timestamp where it wasn’t completed.

The format is ISO-8601.

This parameter can’t be used together with 'completed-not-in'.

name

Array[String]

true

Filter by the name of the Task. This is an exact match.

name-not

Array[String]

true

Filter by what the name of the Task shouldn’t be. This is an exact match.

name-like

Array[String]

true

Filter by the name of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

name-not-like

Array[String]

true

Filter by what the name of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

creator

Array[String]

true

Filter by creator of the Task. This is an exact match.

creator-not

Array[String]

true

Filter by what the creator of the Task shouldn’t be. This is an exact match.

creator-like

Array[String]

true

Filter by the creator of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

creator-not-like

Array[String]

true

Filter by what the creator of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

note-like

Array[String]

true

Filter by the note of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

note-not-like

Array[String]

true

Filter by what the note of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

description-like

Array[String]

true

Filter by the description of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

description-not-like

Array[String]

true

Filter by what the description of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

priority

Array[Integer]

true

Filter by the priority of the Task. This is an exact match.

priority-not

Array[Integer]

true

Filter by what the priority of the Task shouldn’t be. This is an exact match.

priority-within

Array[Integer]

true

Filter by the range of values of the priority field of the Task.

priority-from

Integer

true

Filter by priority starting from the given value (inclusive).

priority-until

Integer

true

Filter by priority up to the given value (inclusive).

priority-not-within

Array[Integer]

true

Filter by exclusing the range of values of the priority field of the Task.

priority-not-from

Integer

true

Filter by excluding priority starting from the given value (inclusive).

priority-not-until

Integer

true

Filter by excluding priority up to the given value (inclusive).

state

Array[String]

true

Filter by the Task state. This is an exact match.

Must be one of [READY, CLAIMED, READY_FOR_REVIEW, IN_REVIEW, COMPLETED, CANCELLED, TERMINATED].

state-not

Array[String]

true

Filter by what the Task state shouldn’t be. This is an exact match.

Must be one of [READY, CLAIMED, READY_FOR_REVIEW, IN_REVIEW, COMPLETED, CANCELLED, TERMINATED].

classification-id

Array[String]

true

Filter by the classification id of the Task. This is an exact match.

classification-id-not

Array[String]

true

Filter by what the classification id of the Task shouldn’t be. This is an exact match.

classification-key

Array[String]

true

Filter by the classification key of the Task. This is an exact match.

classification-key-not

Array[String]

true

Filter by the classification key of the Task. This is an exact match.

classification-key-like

Array[String]

true

Filter by the classification key of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-key-not-like

Array[String]

true

Filter by what the classification key of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-parent-key

Array[String]

true

Filter by the key of the parent Classification of the Classification of the Task. This is an exact match.

classification-parent-key-not

Array[String]

true

Filter by what the key of the parent Classification of the Classification of the Task shouldn’t be. This is an exact match.

classification-parent-key-like

Array[String]

true

Filter by the key of the parent Classification of the Classification of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-parent-key-not-like

Array[String]

true

Filter by what the key of the parent Classification of the Classification of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-category

Array[String]

true

Filter by the classification category of the Task. This is an exact match.

classification-category-not

Array[String]

true

Filter by what the classification category of the Task shouldn’t be. This is an exact match.

classification-category-like

Array[String]

true

Filter by the classification category of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-category-not-like

Array[String]

true

Filter by what the classification category of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-name

Array[String]

true

Filter by the classification name of the Task. This is an exact match.

classification-name-not

Array[String]

true

Filter by what the classification name of the Task shouldn’t be. This is an exact match.

classification-name-like

Array[String]

true

Filter by the classification name of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

classification-name-not-like

Array[String]

true

Filter by what the classification name of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

workbasket-id

Array[String]

true

Filter by workbasket id of the Task. This is an exact match.

workbasket-id-not

Array[String]

true

Filter by what the workbasket id of the Task shouldn’t be. This is an exact match.

workbasket-key

Array[String]

true

Filter by workbasket keys of the Task. This parameter can only be used in combination with 'domain'.

workbasket-key-not

Array[String]

true

Filter by what the workbasket keys of the Task aren’t. This parameter can only be used in combination with 'domain'.

domain

String

true

Filter by domain of the Task. This is an exact match.

business-process-id

Array[String]

true

Filter by the business process id of the Task. This is an exact match.

business-process-id-not

Array[String]

true

Filter by what the business process id of the Task shouldn’t be. This is an exact match.

business-process-id-like

Array[String]

true

Filter by the business process id of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

business-process-id-not-like

Array[String]

true

Filter by the business process id of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

parent-business-process-id

Array[String]

true

Filter by the parent business process id of the Task. This is an exact match.

parent-business-process-id-not

Array[String]

true

Filter by what the parent business process id of the Task shouldn’t be. This is an exact match.

parent-business-process-id-like

Array[String]

true

Filter by the parent business process id of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

parent-business-process-id-not-like

Array[String]

true

Filter by the parent business process id of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

owner

Array[String]

true

Filter by owner of the Task. This is an exact match.

owner-not

Array[String]

true

Filter by what the owner of the Task shouldn’t be. This is an exact match.

owner-like

Array[String]

true

Filter by the owner of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

owner-not-like

Array[String]

true

Filter by what the owner of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

owner-is-null

String

true

Filter by tasks that have no owner. The parameter should exactly be "owner-is-null" without being followed by "=…​".

por

Array[Object]

true

Filter by the primary object reference of the Task. This is an exact match. "por" is a parameter of complex type. Its following attributes from por[].id to por[].value can be specified according to the description of complex parameters in the overview, e.g. por={"value":"exampleValue"}.

por[].value

String

true

por[].id

String

true

por[].type

String

true

por[].system

String

true

por[].company

String

true

por[].systemInstance

String

true

por[].taskId

String

true

por-company

Array[String]

true

Filter by the company of the primary object reference of the Task. This is an exact match.

por-company-not

Array[String]

true

Filter by what the company of the primary object reference of the Task shouldn’t be. This is an exact match.

por-company-like

Array[String]

true

Filter by the company of the primary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-company-not-like

Array[String]

true

Filter by what the company of the primary object reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-system

Array[String]

true

Filter by the system of the primary object reference of the Task. This is an exact match.

por-system-not

Array[String]

true

Filter by what the system of the primary object reference of the Task shouldn’t be. This is an exact match.

por-system-like

Array[String]

true

Filter by the system of the primary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-system-not-like

Array[String]

true

Filter by what the system of the primary object reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-instance

Array[String]

true

Filter by the system instance of the primary object reference of the Task. This is an exact match.

por-instance-not

Array[String]

true

Filter by what the system instance of the primary object reference of the Task shouldn’t be. This is an exact match.

por-instance-like

Array[String]

true

Filter by the system instance of the primary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-instance-not-like

Array[String]

true

Filter by what the system instance of the primary object reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-type

Array[String]

true

Filter by the type of the primary object reference of the Task. This is an exact match.

por-type-not

Array[String]

true

Filter by what the type of the primary object reference of the Task shouldn’t be. This is an exact match.

por-type-like

Array[String]

true

Filter by the type of the primary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-type-not-like

Array[String]

true

Filter by what the type of the primary object reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-value

Array[String]

true

Filter by the value of the primary object reference of the Task. This is an exact match.

por-value-not

Array[String]

true

Filter by what the value of the primary object reference of the Task shouldn’t be. This is an exact match.

por-value-like

Array[String]

true

Filter by the value of the primary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

por-value-not-like

Array[String]

true

Filter by what the value of the primary object reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

sor

Array[Object]

true

Filter by the primary object reference of the Task. This is an exact match. "sor" is a parameter of complex type. Its following attributes from sor[].id to sor[].value can be specified according to the description of complex parameters in the overview, e.g. sor={"value":"exampleValue"}.

sor[].value

String

true

sor[].id

String

true

sor[].type

String

true

sor[].system

String

true

sor[].company

String

true

sor[].systemInstance

String

true

sor[].taskId

String

true

sor-company

Array[String]

true

Filter by the company of the secondary object reference of the Task. This is an exact match.

sor-company-like

Array[String]

true

Filter by the company of the secondary object references of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

sor-system

Array[String]

true

Filter by the system of the secondary object reference of the Task. This is an exact match.

sor-system-like

Array[String]

true

Filter by the system of the secondary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

sor-instance

Array[String]

true

Filter by the system instance of the secondary object reference of the Task. This is an exact match.

sor-instance-like

Array[String]

true

Filter by the system instance of the secondary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

sor-type

Array[String]

true

Filter by the type of the secondary object reference of the Task. This is an exact match.

sor-type-like

Array[String]

true

Filter by the type of the secondary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

sor-value

Array[String]

true

Filter by the value of the secondary object reference of the Task. This is an exact match.

sor-value-like

Array[String]

true

Filter by the value of the secondary object reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

is-read

Boolean

true

Filter by the is read flag of the Task. This is an exact match.

is-transferred

Boolean

true

Filter by the is transferred flag of the Task. This is an exact match.

attachment-classification-id

Array[String]

true

Filter by the attachment classification id of the Task. This is an exact match.

attachment-classification-id-not

Array[String]

true

Filter by what the attachment classification id of the Task shouldn’t be. This is an exact match.

attachment-classification-key

Array[String]

true

Filter by the attachment classification key of the Task. This is an exact match.

attachment-classification-key-not

Array[String]

true

Filter by what the attachment classification key of the Task shouldn’t be. This is an exact match.

attachment-classification-key-like

Array[String]

true

Filter by the attachment classification key of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-classification-key-not-like

Array[String]

true

Filter by what the attachment classification key of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-classification-name

Array[String]

true

Filter by the attachment classification name of the Task. This is an exact match.

attachment-classification-name-not

Array[String]

true

Filter by what the attachment classification name of the Task shouldn’t be. This is an exact match.

attachment-classification-name-like

Array[String]

true

Filter by the attachment classification name of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-classification-name-not-like

Array[String]

true

Filter by what the attachment classification name of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-channel

Array[String]

true

Filter by the attachment channel of the Task. This is an exact match.

attachment-channel-not

Array[String]

true

Filter by what the attachment channel of the Task shouldn’t be. This is an exact match.

attachment-channel-like

Array[String]

true

Filter by the attachment channel of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-channel-not-like

Array[String]

true

Filter by what the attachment channel of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-reference

Array[String]

true

Filter by the attachment reference of the Task. This is an exact match.

attachment-reference-not

Array[String]

true

Filter by what the attachment reference of the Task shouldn’t be. This is an exact match.

attachment-reference-like

Array[String]

true

Filter by the attachment reference of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-reference-not-like

Array[String]

true

Filter by what the attachment reference of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

attachment-received

Array[String]

true

Filter by a time interval within which the attachment of the Task was received. To create an open interval you can just leave it blank.

The format is ISO-8601.

attachment-received-not

Array[String]

true

Filter by a time interval within which the attachment of the Task wasn’t received. To create an open interval you can just leave it blank.

The format is ISO-8601.

without-attachment

Boolean

true

In order to filter Tasks that don’t have any Attachments, set 'without-attachment' to 'true'. Any other value for 'without-attachment' is invalid.

callback-state

Array[String]

true

Filter by the callback state of the Task. This is an exact match.

Must be one of [NONE, CALLBACK_PROCESSING_REQUIRED, CLAIMED, CALLBACK_PROCESSING_COMPLETED].

callback-state-not

Array[String]

true

Filter by what the callback state of the Task shouldn’t be. This is an exact match.

Must be one of [NONE, CALLBACK_PROCESSING_REQUIRED, CLAIMED, CALLBACK_PROCESSING_COMPLETED].

wildcard-search-fields

Array[String]

true

Filter by wildcard search field of the Task.

This must be used in combination with 'wildcard-search-value'.

Must be one of [NAME, DESCRIPTION, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, CUSTOM_6, CUSTOM_7, CUSTOM_8, CUSTOM_9, CUSTOM_10, CUSTOM_11, CUSTOM_12, CUSTOM_13, CUSTOM_14, CUSTOM_15, CUSTOM_16].

wildcard-search-value

String

true

Filter by wildcard search field of the Task. This is an exact match.

This must be used in combination with 'wildcard-search-fields'.

custom-1

Array[String]

true

Filter by the value of the field custom1 of the Task. This is an exact match.

custom-1-not

Array[String]

true

Exclude values of the field custom1 of the Task.

custom-1-like

Array[String]

true

Filter by the custom1 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-1-not-like

Array[String]

true

Filter by what the custom1 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-2

Array[String]

true

Filter by the value of the field custom2 of the Task. This is an exact match.

custom-2-not

Array[String]

true

Filter out by values of the field custom2 of the Task. This is an exact match.

custom-2-like

Array[String]

true

Filter by the custom2 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-2-not-like

Array[String]

true

Filter by what the custom2 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-3

Array[String]

true

Filter by the value of the field custom3 of the Task. This is an exact match.

custom-3-not

Array[String]

true

Filter out by values of the field custom3 of the Task. This is an exact match.

custom-3-like

Array[String]

true

Filter by the custom3 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-3-not-like

Array[String]

true

Filter by what the custom3 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-4

Array[String]

true

Filter by the value of the field custom4 of the Task. This is an exact match.

custom-4-not

Array[String]

true

Filter out by values of the field custom4 of the Task. This is an exact match.

custom-4-like

Array[String]

true

Filter by the custom4 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-4-not-like

Array[String]

true

Filter by what the custom4 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-5

Array[String]

true

Filter by the value of the field custom5 of the Task. This is an exact match.

custom-5-not

Array[String]

true

Filter out by values of the field custom5 of the Task. This is an exact match.

custom-5-like

Array[String]

true

Filter by the custom5 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-5-not-like

Array[String]

true

Filter by what the custom5 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-6

Array[String]

true

Filter by the value of the field custom6 of the Task. This is an exact match.

custom-6-not

Array[String]

true

Filter out by values of the field custom6 of the Task. This is an exact match.

custom-6-like

Array[String]

true

Filter by the custom6 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-6-not-like

Array[String]

true

Filter by what the custom6 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-7

Array[String]

true

Filter by the value of the field custom7 of the Task. This is an exact match.

custom-7-not

Array[String]

true

Filter out by values of the field custom7 of the Task. This is an exact match.

custom-7-like

Array[String]

true

Filter by the custom7 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-7-not-like

Array[String]

true

Filter by what the custom7 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-8

Array[String]

true

Filter by the value of the field custom8 of the Task. This is an exact match.

custom-8-not

Array[String]

true

Filter out by values of the field custom8 of the Task. This is an exact match.

custom-8-like

Array[String]

true

Filter by the custom8 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-8-not-like

Array[String]

true

Filter by what the custom8 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-9

Array[String]

true

Filter by the value of the field custom9 of the Task. This is an exact match.

custom-9-not

Array[String]

true

Filter out by values of the field custom9 of the Task. This is an exact match.

custom-9-like

Array[String]

true

Filter by the custom9 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-9-not-like

Array[String]

true

Filter by what the custom9 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-10

Array[String]

true

Filter by the value of the field custom10 of the Task. This is an exact match.

custom-10-not

Array[String]

true

Filter out by values of the field custom10 of the Task. This is an exact match.

custom-10-like

Array[String]

true

Filter by the custom10 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-10-not-like

Array[String]

true

Filter by what the custom10 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-11

Array[String]

true

Filter by the value of the field custom11 of the Task. This is an exact match.

custom-11-not

Array[String]

true

Filter out by values of the field custom11 of the Task. This is an exact match.

custom-11-like

Array[String]

true

Filter by the custom11 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-11-not-like

Array[String]

true

Filter by what the custom11 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-12

Array[String]

true

Filter by the value of the field custom12 of the Task. This is an exact match.

custom-12-not

Array[String]

true

Filter out by values of the field custom12 of the Task. This is an exact match.

custom-12-like

Array[String]

true

Filter by the custom12 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-12-not-like

Array[String]

true

Filter by what the custom12 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-13

Array[String]

true

Filter by the value of the field custom13 of the Task. This is an exact match.

custom-13-not

Array[String]

true

Filter out by values of the field custom13 of the Task. This is an exact match.

custom-13-like

Array[String]

true

Filter by the custom13 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-13-not-like

Array[String]

true

Filter by what the custom13 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-14

Array[String]

true

Filter by the value of the field custom14 of the Task. This is an exact match.

custom-14-not

Array[String]

true

Filter out by values of the field custom14 of the Task. This is an exact match.

custom-14-like

Array[String]

true

Filter by the custom14 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-14-not-like

Array[String]

true

Filter by what the custom14 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-15

Array[String]

true

Filter by the value of the field custom15 of the Task. This is an exact match.

custom-15-not

Array[String]

true

Filter out by values of the field custom15 of the Task. This is an exact match.

custom-15-like

Array[String]

true

Filter by the custom15 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-15-not-like

Array[String]

true

Filter by what the custom15 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-16

Array[String]

true

Filter by the value of the field custom16 of the Task. This is an exact match.

custom-16-not

Array[String]

true

Filter out by values of the field custom16 of the Task. This is an exact match.

custom-16-like

Array[String]

true

Filter by the custom16 field of the Task. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-16-not-like

Array[String]

true

Filter by what the custom16 field of the Task shouldn’t be. This results in a substring search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved correctly.

custom-int-1

Array[Integer]

true

Filter by the value of the field customInt1 of the Task. This is an exact match.

custom-int-1-not

Array[Integer]

true

Exclude values of the field customInt1 of the Task.

custom-int-1-within

Array[Integer]

true

Filter by the range of value of the field customInt1 of the Task.

custom-int-1-not-within

Array[Integer]

true

Exclude range of values of the field customInt1 of the Task.

custom-int-1-from

Integer

true

Filter by lower bound of customInt1.

This parameter can’t be used together with 'custom-int-1-within'.

custom-int-1-from-not

Integer

true

Exclude values from a lower bound of the field customInt1 of the Task.

custom-int-1-to

Integer

true

Filter by upper bound of customInt1.

This parameter can’t be used together with 'custom-int-1-within'.

custom-int-1-to-not

Integer

true

Exclude values to an upper bound of the field customInt1 of the Task.

custom-int-2

Array[Integer]

true

Filter by the value of the field customInt2 of the Task. This is an exact match.

custom-int-2-not

Array[Integer]

true

Exclude values of the field customInt2 of the Task.

custom-int-2-within

Array[Integer]

true

Filter by the range of value of the field customInt2 of the Task.

custom-int-2-not-within

Array[Integer]

true

Exclude range of values of the field customInt2 of the Task.

custom-int-2-from

Integer

true

Filter by lower bound of customInt2.

This parameter can’t be used together with 'custom-int-2-within'.

custom-int-2-from-not

Integer

true

Exclude values from a lower bound of the field customInt2 of the Task.

custom-int-2-to

Integer