Search
K
Case Management

StepInstance

object
idstring

Unique identifier for the step instance.

labelstring

Business Friendly label for the step instance.

stepStatusstring

Current status of the step instance.

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDNOT_STARTED

stepResultstring

Step level decision outcome

eventRefarray[string]

List of event references associated with this step.

mappedTasksarray[string]

List of identifiers for tasks mapped to this step.

mappedExceptionsarray[string]

List of exception mapped to this step.

mappedDocumentsarray[string]

List of document id mapped to this step.

mappedCasesarray[string]

List of Case id mapped to this step.

mappedNotesarray[string]

List of identifiers for notes mapped to this step (RESERVED FOR FUTURE SCOPE).

multiInstanceboolean

Indicates whether step is multiple instance or not.

Default:false

instanceInfoobject

Contains information about the multi instance step

Show Child Parameters
createdAtstring(date-time)

Timestamp when the step instance was created.

updatedAtstring(date-time)

Timestamp when the step instance was last updated.

Example

ValidationResponse

object
statusCodeinteger(int32)

Example:400

timestampstring(date-time)
errorIdstring

Example:a4a57ed0-2c1b-4922-9959-3b85dd8a96d3

messagestring

Example:Template validation fails with errors

errorarray[string]

Example:Stage [0] Step [1] mandatory attribute label missing

Example

ResourceNotFoundResponse

object
timestampstring
statusinteger(int32)
errorstring
messagestring
pathstring
Example

AccessDeniedResponse

object
timestampinteger(int64)
statusinteger(int32)
errorstring
messagestring
pathstring
Example

UnauthorizedResponse

object
timestampinteger
statusinteger
errorstring
messagestring
pathstring
Example