REST API

value
optional

Example : "string"

string

name
optional

Example : "string"

string

type
optional

Example : "string"

string

fragments
optional

Example : [ "case-adhoc-fragment" ]

< case-adhoc-fragment > array

added-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

author
optional

Example : "string"

string

id
optional

Example : "string"

string

restricted-to
optional

Example : [ "string" ]

< string > array

text
optional

Example : "string"

string

comments
optional

Example : [ "case-comment" ]

< case-comment > array

adhoc-fragments
optional

Example : [ "case-adhoc-fragment" ]

< case-adhoc-fragment > array

case-id-prefix
optional

Example : "string"

string

container-id
optional

Example : "string"

string

id
optional

Example : "string"

string

milestones
optional

Example : [ "case-milestone-def" ]

< case-milestone-def > array

name
optional

Example : "string"

string

roles
optional

Example : { "string" : 0 }

< string, integer (int32) > map

stages
optional

Example : [ "case-stage-def" ]

< case-stage-def > array

version
optional

Example : "string"

string

definitions
optional

Example : [ "case-definition" ]

< case-definition > array

case-data
optional

Example : { "string" : "object" }

< string, object > map

case-data-restrictions
optional

Example : { "string" : [ "string" ] }

< string, < string > array > map

case-group-assignments
optional

Example : { "string" : "string" }

< string, string > map

case-user-assignments
optional

Example : { "string" : "string" }

< string, string > map

case-completed-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

case-completion-msg
optional

Example : "string"

string

case-definition-id
optional

Example : "string"

string

case-description
optional

Example : "string"

string

case-file
optional

Example : case-file

case-file

case-id
optional

Example : "string"

string

case-milestones
optional

Example : [ "case-milestone" ]

< case-milestone > array

case-owner
optional

Example : "string"

string

case-roles
optional

Example : [ "case-role-assignment" ]

< case-role-assignment > array

case-sla-compliance
optional

Example : 0

integer (int32)

case-sla-due-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

case-stages
optional

Example : [ "case-stage" ]

< case-stage > array

case-started-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

case-status
optional

Example : 0

integer (int32)

container-id
optional

Example : "string"

string

instances
optional

Example : [ "case-instance" ]

< case-instance > array

case-id
optional

Example : "string"

string

case-migration-end
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

case-migration-reports
optional

Example : [ "migration-report-instance" ]

< migration-report-instance > array

case-migration-start
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

case-migration-successful
optional

Example : true

boolean

milestone-achieved
optional

Example : true

boolean

milestone-achieved-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

milestone-id
optional

Example : "string"

string

milestone-name
optional

Example : "string"

string

milestone-status
optional

Example : "string"

string

milestone-id
optional

Example : "string"

string

milestone-mandatory
optional

Example : true

boolean

milestone-name
optional

Example : "string"

string

milestones
optional

Example : [ "case-milestone" ]

< case-milestone > array

groups
optional

Example : [ "string" ]

< string > array

name
optional

Example : "string"

string

users
optional

Example : [ "string" ]

< string > array

role-assignments
optional

Example : [ "case-role-assignment" ]

< case-role-assignment > array

active-nodes
optional

Example : [ "node-instance" ]

< node-instance > array

adhoc-fragments
optional

Example : [ "case-adhoc-fragment" ]

< case-adhoc-fragment > array

stage-id
optional

Example : "string"

string

stage-name
optional

Example : "string"

string

stage-status
optional

Example : "string"

string

adhoc-fragments
optional

Example : [ "case-adhoc-fragment" ]

< case-adhoc-fragment > array

stage-id
optional

Example : "string"

string

stage-name
optional

Example : "string"

string

stages
optional

Example : [ "case-stage" ]

< case-stage > array

document-content
optional

Example : [ "Ynl0ZQ==" ]

< string (byte) > array

document-id
optional

Example : "string"

string

document-last-mod
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

document-link
optional

Example : "string"

string

document-name
optional

Example : "string"

string

document-size
optional

Example : 0

integer (int64)

document-instances
optional

Example : [ "document-instance" ]

< document-instance > array

error-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

error-instance-id
optional

Example : 0

integer (int64)

error-message
optional

Example : "string"

string

error-stacktrace
optional

Example : "string"

string

request-instance-id
optional

Example : 0

integer (int64)

error-info-instance
optional

Example : [ "error-info-instance" ]

< error-info-instance > array

acknowledged
optional

Example : true

boolean

acknowledged-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

acknowledged-by
optional

Example : "string"

string

activity-id
optional

Example : 0

integer (int64)

activity-name
optional

Example : "string"

string

container-id
optional

Example : "string"

string

error
optional

Example : "string"

string

error-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

error-msg
optional

Example : "string"

string

id
optional

Example : "string"

string

job-id
optional

Example : 0

integer (int64)

process-id
optional

Example : "string"

string

process-instance-id
optional

Example : 0

integer (int64)

type
optional

Example : "string"

string

error-instance
optional

Example : [ "execution-error" ]

< execution-error > array

content
optional

Example : [ "string" ]

< string > array

severity
optional

Example : "INFO"

enum (INFO, WARN, ERROR)

timestamp
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

migration-end
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

migration-logs
optional

Example : [ "string" ]

< string > array

migration-process-instance
optional

Example : 0

integer (int64)

migration-start
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

migration-successful
optional

Example : true

boolean

migration-report-instance
optional

Example : [ "migration-report-instance" ]

< migration-report-instance > array

id
optional

Example : 0

integer (int64)

name
optional

Example : "string"

string

type
optional

Example : "string"

string

unique-id
optional

Example : "string"

string

container-id
optional

Example : "string"

string

node-completed
optional

Example : true

boolean

node-connection
optional

Example : "string"

string

node-id
optional

Example : "string"

string

node-instance-id
optional

Example : 0

integer (int64)

node-name
optional

Example : "string"

string

node-type
optional

Example : "string"

string

process-instance-id
optional

Example : 0

integer (int64)

reference-id
optional

Example : 0

integer (int64)

sla-compliance
optional

Example : 0

integer (int32)

sla-due-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

start-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

work-item-id
optional

Example : 0

integer (int64)

node-instance
optional

Example : [ "node-instance" ]

< node-instance > array

associatedEntities
optional

Example : { "string" : [ "string" ] }

< string, < string > array > map

associatedEntities
optional

Example : { "string" : [ "string" ] }

< string, < string > array > map

container-id
optional

Example : "string"

string

dynamic
optional

Example : true

boolean

nodes
optional

Example : [ "node-definition" ]

< node-definition > array

package
optional

Example : "string"

string

process-id
optional

Example : "string"

string

process-name
optional

Example : "string"

string

process-version
optional

Example : "string"

string

processVariables
optional

Example : { "string" : "string" }

< string, string > map

reusableSubProcesses
optional

Example : [ "string" ]

< string > array

serviceTasks
optional

Example : { "string" : "string" }

< string, string > map

timers
optional

Example : [ "timer-definition" ]

< timer-definition > array

processes
optional

Example : [ "process-definition" ]

< process-definition > array

active-user-tasks
optional

Example : task-summary-list

task-summary-list

container-id
optional

Example : "string"

string

correlation-key
optional

Example : "string"

string

initiator
optional

Example : "string"

string

parent-instance-id
optional

Example : 0

integer (int64)

process-id
optional

Example : "string"

string

process-instance-desc
optional

Example : "string"

string

process-instance-id
optional

Example : 0

integer (int64)

process-instance-state
optional

Example : 0

integer (int32)

process-instance-variables
optional

Example : { "string" : "object" }

< string, object > map

process-name
optional

Example : "string"

string

process-version
optional

Example : "string"

string

sla-compliance
optional

Example : 0

integer (int32)

sla-due-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

start-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

process-instance
optional

Example : [ "process-instance" ]

< process-instance > array

id
optional

Example : 0

integer (int64)

name
optional

Example : "string"

string

process-id
optional

Example : "string"

string

type
optional

Example : "string"

string

process-node
optional

Example : [ "process-node" ]

< process-node > array

serviceTasks
optional

Example : { "string" : "string" }

< string, string > map

subProcesses
optional

Example : [ "string" ]

< string > array

taskInputs
optional

Example : { "string" : "string" }

< string, string > map

taskOutputs
optional

Example : { "string" : "string" }

< string, string > map

variables
optional

Example : { "string" : "string" }

< string, string > map

query-columns
optional

Example : { "string" : "string" }

< string, string > map

query-expression
optional

Example : "string"

string

query-name
optional

Example : "string"

string

query-source
optional

Example : "string"

string

query-target
optional

Example : "string"

string

queries
optional

Example : [ "query-definition" ]

< query-definition > array

request-business-key
optional

Example : "string"

string

request-command
optional

Example : "string"

string

request-container-id
optional

Example : "string"

string

request-data
optional

Example : { "string" : "object" }

< string, object > map

request-errors
optional

Example : error-info-instance-list

error-info-instance-list

request-executions
optional

Example : 0

integer (int32)

request-instance-id
optional

Example : 0

integer (int64)

request-message
optional

Example : "string"

string

request-retries
optional

Example : 0

integer (int32)

request-scheduled-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

request-status
optional

Example : "string"

string

response-data
optional

Example : { "string" : "object" }

< string, object > map

request-info-instance
optional

Example : [ "request-info-instance" ]

< request-info-instance > array

msg
optional

Example : "string"

string

type
optional

Example : "SUCCESS"

enum (SUCCESS, FAILURE, NO_RESPONSE)

response
optional

Example : [ "response" ]

< response > array

best-solution
optional

Example : "object"

object

container-id
optional

Example : "string"

string

score
optional

Example : ScoreWrapper

ScoreWrapper

solver-config-file
optional

Example : "string"

string

solver-id
optional

Example : "string"

string

status
optional

Example : "NOT_SOLVING"

enum (NOT_SOLVING, TERMINATING_EARLY, SOLVING)

solver
optional

Example : [ "solver-instance" ]

< solver-instance > array

attachment-added-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

attachment-added-by
optional

Example : "string"

string

attachment-content-id
optional

Example : 0

integer (int64)

attachment-id
optional

Example : 0

integer (int64)

attachment-name
optional

Example : "string"

string

attachment-size
optional

Example : 0

integer (int32)

attachment-type
optional

Example : "string"

string

task-attachment
optional

Example : [ "task-attachment" ]

< task-attachment > array

comment
optional

Example : "string"

string

comment-added-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

comment-added-by
optional

Example : "string"

string

comment-id
optional

Example : 0

integer (int64)

task-comment
optional

Example : [ "task-comment" ]

< task-comment > array

task-event-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-event-id
optional

Example : 0

integer (int64)

task-event-message
optional

Example : "string"

string

task-event-type
optional

Example : "string"

string

task-event-user
optional

Example : "string"

string

task-id
optional

Example : 0

integer (int64)

task-process-instance-id
optional

Example : 0

integer (int64)

task-work-item-id
optional

Example : 0

integer (int64)

task-event-instance
optional

Example : [ "task-event-instance" ]

< task-event-instance > array

sla-compliance
optional

Example : 0

integer (int32)

sla-due-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-activation-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-actual-owner
optional

Example : "string"

string

task-business-admins
optional

Example : [ "string" ]

< string > array

task-container-id
optional

Example : "string"

string

task-created-by
optional

Example : "string"

string

task-created-on
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-description
optional

Example : "string"

string

task-excl-owners
optional

Example : [ "string" ]

< string > array

task-expiration-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-form
optional

Example : "string"

string

task-id
optional

Example : 0

integer (int64)

task-input-data
optional

Example : { "string" : "object" }

< string, object > map

task-name
optional

Example : "string"

string

task-output-data
optional

Example : { "string" : "object" }

< string, object > map

task-parent-id
optional

Example : 0

integer (int64)

task-pot-owners
optional

Example : [ "string" ]

< string > array

task-priority
optional

Example : 0

integer (int32)

task-process-id
optional

Example : "string"

string

task-process-instance-id
optional

Example : 0

integer (int64)

task-skippable
optional

Example : true

boolean

task-status
optional

Example : "string"

string

task-subject
optional

Example : "string"

string

task-type
optional

Example : "string"

string

task-workitem-id
optional

Example : 0

integer (int64)

active
optional

Example : true

boolean

content
optional

Example : "string"

string

groups
optional

Example : [ "string" ]

< string > array

id
optional

Example : 0

integer (int64)

name
optional

Example : "string"

string

notify-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

subject
optional

Example : "string"

string

users
optional

Example : [ "string" ]

< string > array

task-notification
optional

Example : [ "task-notification" ]

< task-notification > array

active
optional

Example : true

boolean

groups
optional

Example : [ "string" ]

< string > array

id
optional

Example : 0

integer (int64)

name
optional

Example : "string"

string

reassign-at
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

users
optional

Example : [ "string" ]

< string > array

task-reassignment
optional

Example : [ "task-reassignment" ]

< task-reassignment > array

task-activation-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-actual-owner
optional

Example : "string"

string

task-container-id
optional

Example : "string"

string

task-created-by
optional

Example : "string"

string

task-created-on
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-description
optional

Example : "string"

string

task-expiration-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

task-id
optional

Example : 0

integer (int64)

task-is-skipable
optional

Example : true

boolean

task-name
optional

Example : "string"

string

task-parent-id
optional

Example : 0

integer (int64)

task-priority
optional

Example : 0

integer (int32)

task-proc-def-id
optional

Example : "string"

string

task-proc-inst-id
optional

Example : 0

integer (int64)

task-status
optional

Example : "string"

string

task-subject
optional

Example : "string"

string

task-summary
optional

Example : [ "task-summary" ]

< task-summary > array

id
optional

Example : 0

integer (int64)

node-name
optional

Example : "string"

string

nodeId
optional

Example : 0

integer (int64)

unique-id
optional

Example : "string"

string

activation-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

delay
optional

Example : 0

integer (int64)

id
optional

Example : 0

integer (int64)

last-fire-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

name
optional

Example : "string"

string

next-fire-time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

period
optional

Example : 0

integer (int64)

process-instance-id
optional

Example : 0

integer (int64)

repeat-limit
optional

Example : 0

integer (int32)

session-id
optional

Example : 0

integer (int64)

timer-id
optional

Example : 0

integer (int64)

timer-instance
optional

Example : [ "timer-instance" ]

< timer-instance > array

associatedEntities
optional

Example : [ "string" ]

< string > array

task-comment
optional

Example : "string"

string

task-created-by
optional

Example : "string"

string

task-form-name
optional

Example : "string"

string

task-id
optional

Example : "string"

string

task-name
optional

Example : "string"

string

task-priority
optional

Example : 0

integer (int32)

task-skippable
optional

Example : true

boolean

taskInputMappings
optional

Example : { "string" : "string" }

< string, string > map

taskOutputMappings
optional

Example : { "string" : "string" }

< string, string > map

task
optional

Example : [ "user-task-definition" ]

< user-task-definition > array

modification-date
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

name
optional

Example : "string"

string

old-value
optional

Example : "string"

string

process-instance-id
optional

Example : 0

integer (int64)

value
optional

Example : "string"

string

variable-instance
optional

Example : [ "variable-instance" ]

< variable-instance > array

container-id
optional

Example : "string"

string

node-id
optional

Example : 0

integer (int64)

node-instance-id
optional

Example : 0

integer (int64)

process-instance-id
optional

Example : 0

integer (int64)

work-item-id
optional

Example : 0

integer (int64)

work-item-name
optional

Example : "string"

string

work-item-params
optional

Example : { "string" : "object" }

< string, object > map

work-item-state
optional

Example : 0

integer (int32)

work-item-instance
optional

Example : [ "work-item-instance" ]

< work-item-instance > array