GET /rest/bpm/federated/htm/v1/task/{tkiid}?systemID={string}| Name | Value Type | Description |
|---|---|---|
| systemID | string | ID of the IBM Business Process Manager (BPEL runtime and/or BPD runtime) system hosting the resource. |
None.
The default content-type is application/json.
{ "description": "Task",
"type": "object",
"properties":
{ "activationTime": {"type": "string", "format": "date-time",
"description": "Time the task instance is set into the ready state - this also happens when the task is restarted or when a claim is canceled."
},
"applicationDefaultsID": {"type": "string", "optional": true,
"description": "ID of the application component that specifies the defaults for the task."
},
"applicationName": {"type": "string", "optional": true,
"description": "Name of the application the task is part of."
},
"assignedTo": {"type": "string", "optional": true,
"description": "The task owner."
},
"assignedToType": {"type": "string", "optional": true,
"description": "Group or User."
},
"assignmentType": {"type": "string", "optional": true,
"description": "States whether the task can be assigned to a single person only or to multiple persons in parallel.",
"enum":
[
"ASSIGNMENT_TYPE_SINGLE",
"ASSIGNMENT_TYPE_PARALLEL"
]
},
"autoDeletionMode": {"type": "string", "optional": true,
"description": "States whether the task instance is automatically or conditionally deleted when it reaches an end execution state."
},
"binaryCustomPropertiesMetadata": {"type": "object", "additionalProperties": {"type": "string"}, "optional": true,
"description": "Metadata for binary custom properties associated with this task."
},
"calendarName": {"type": "string", "optional": true,
"description": "Name of the calendar used, for example, for expiration calculations."
},
"clientTypes": {"type": ["string"],
"description": "A user-defined client type to specify UI client information, for example, Web, Portal, Custom, or IBM_WLE_Coach."
},
"completionTime": {"type": "string", "format": "date-time",
"description": "Time when the task instance reached an end state."
},
"containmentContextID": {"type": "string",
"description": "ID of the context which embraces the task instance."
},
"contextAuthorizationOfOwner": {"type": "string", "optional": true,
"description": "Authorization rights of the task owner to the associated context."
},
"customProperties": {"type": "object", "additionalProperties": {"type": "string"}, "optional": true,
"description": "List of custom property names and values."
},
"customText1": {"type": "string", "optional": true,
"description": "Inline custom property 1."
},
"customText2": {"type": "string", "optional": true,
"description": "Inline custom property 2."
},
"customText3": {"type": "string", "optional": true,
"description": "Inline custom property 3."
},
"customText4": {"type": "string", "optional": true,
"description": "Inline custom property 4."
},
"customText5": {"type": "string", "optional": true,
"description": "Inline custom property 5."
},
"customText6": {"type": "string", "optional": true,
"description": "Inline custom property 6."
},
"customText7": {"type": "string", "optional": true,
"description": "Inline custom property 7."
},
"customText8": {"type": "string", "optional": true,
"description": "Inline custom property 8."
},
"data": {"type": "object", "optional": true,
"description": "Task instance data."
},
"definitionName": {"type": "string", "optional": true,
"description": "Name of the task definition in the TEL."
},
"definitionNamespace": {"type": "string", "optional": true,
"description": "XML schema namespace of the task definition in the TEL."
},
"deletionTime": {"type": "string", "format": "date-time", "optional": true,
"description": "Time when the task is deleted."
},
"description": {"type": "string",
"description": "Description of the task."
},
"displayName": {"type": "string",
"description": "Display name of the task."
},
"dueTime": {"type": "string", "format": "date-time",
"description": "Time when the task is due."
},
"durationUntilDeleted": {"type": "string", "optional": true,
"description": "Duration that the task is kept after it has reached an end state."
},
"durationUntilDue": {"type": "string", "optional": true,
"description": "Duration when the task becomes due."
},
"durationUntilExpires": {"type": "string", "optional": true,
"description": "Duration when the task expires once it is activated."
},
"eventHandlerName": {"type": "string", "optional": true,
"description": "Name of the associated event handler."
},
"expirationTime": {"type": "string", "format": "date-time", "optional": true,
"description": "Time when the task instance will expire or was due to expire."
},
"externalActivityID": {"type": "object", "optional": true,
"description": "ID of the external activity."
},
"firstActivationTime": {"type": "string", "format": "date-time", "optional": true,
"description": "Time the task instance is set into the ready state for the first time."
},
"followOnTaskID": {"type": "string", "optional": true,
"description": "ID of the next task instance in a sequence."
},
"inheritedAuthorization": {"type": "string", "optional": true,
"description": "States for a subtask which kind of authorization is inherited from a parent task.",
"enum":
[
"INHERITED_AUTH_NONE",
"INHERITED_AUTH_ADMINISTRATOR",
"INHERITED_AUTH_ALL"
]
},
"inputMessageTypeName": {"type": "string", "optional": true,
"description": "Name of the input message type. The value has the format {namespace}localname."
},
"invokedInstanceID": {"type": "string", "optional": true,
"description": "The object ID of the invoked service."
},
"invokedInstanceType": {"type": "string", "optional": true,
"description": "The type of service called by this task.",
"enum":
[
"INVOKED_INSTANCE_TYPE_PROCESS",
"INVOKED_INSTANCE_TYPE_TASK",
"INVOKED_INSTANCE_TYPE_EVENT",
"INVOKED_INSTANCE_TYPE_ACTIVITY",
"INVOKED_INSTANCE_TYPE_NOT_SET"
]
},
"isAdHoc": {"type": "boolean", "optional": true,
"description": "States whether the task has been created ad-hoc."
},
"isBusinessRelevant": {"type": "boolean", "optional": true,
"description": "States whether the task is a business relevant or an 'auxiliary' step."
},
"isBusinessRelevanceUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the business relevance property can be changed for the kind and current state of the object."
},
"isChild": {"type": "boolean", "optional": true,
"description": "States for standalone tasks whether the task instance runs dependently of its parent or not."
},
"isContextAuthorizationOfOwnerUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the context authorization property can be changed for the kind and current state of the object."
},
"isDeletionTimeUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the deletion time property can be changed for the kind and current state of the object."
},
"isDescriptionUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the description property can be changed for the kind and current state of the object."
},
"isDisplayNameUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the display name property can be changed for the kind and current state of the object."
},
"isDueTimeUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the due time property can be changed for the kind and current state of the object."
},
"isDurationUntilDeletedUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the duration until deleted property can be changed for the kind and current state of the object."
},
"isDurationUntilDueUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the duration until due property can be changed for the kind and current state of the object."
},
"isDurationUntilExpiresUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the duration until expires property can be changed for the kind and current state of the object."
},
"isEscalated": {"type": "boolean", "optional": true,
"description": "States whether an escalation occurred."
},
"isEscalatedUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the isEscalated property can be changed for the kind and current state of the object."
},
"isEventHandlerNameUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the event handler name property can be changed for the kind and current state of the object."
},
"isExpirationTimeUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the expiration time property can be changed for the kind and current state of the object."
},
"isInline": {"type": "boolean", "optional": true,
"description": "States whether the task is an inline task."
},
"isNameUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the name property can be changed for the kind and current state of the object."
},
"isNamespaceUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the namespace property can be changed for the kind and current state of the object."
},
"isParentContextIDUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the parent context ID property can be changed for the kind and current state of the object."
},
"isPriorityUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the priority property can be changed for the kind and current state of the object."
},
"isRead": {"type": "boolean", "optional": true,
"description": "States whether the task instance is marked read."
},
"isReadUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the isRead property can be changed for the kind and current state of the object."
},
"isSupportsClaimIfSuspendedUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the supports claim suspended property can be changed for the kind and current state of the object."
},
"isSupportsDelegationUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the supports delegation property can be changed for the kind and current state of the object."
},
"isSupportsFollowOnTasksUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the supports follow on task property can be changed for the kind and current state of the object."
},
"isSupportsSubTasksUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the supports sub task property can be changed for the kind and current state of the object."
},
"isSuspended": {"type": "boolean", "optional": true,
"description": "States whether the task instance is suspended."
},
"isTransferredToWorkBasket": {"type": "boolean", "optional": true,
"description": "States whether the task instance had been transferred to some work basket."
},
"isTypeUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the type property can be changed for the kind and current state of the object."
},
"isWaitingForSubTask": {"type": "boolean", "optional": true,
"description": "States whether the task is waiting for the completion of a subtask."
},
"isWorkBasketNameUpdateable": {"type": "boolean", "optional": true,
"description": "Signals whether the work basket property can be changed for the kind and current state of the object."
},
"jndiNameOfCalendar": {"type": "string", "optional": true,
"description": "JNDI name of a user-defined calendar."
},
"jndiNameOfStaffPluginProvider": {"type": "string", "optional": true,
"description": "JNDI name of a user-defined people directory configuation."
},
"kind": {"type": "string",
"description": "Kind of the task."
},
"lastModificationTime":{"type": "string", "format": "date-time",
"description": "Last time a property of the task instance changed."
},
"lastStateChangeTime": {"type": "string", "format": "date-time", "optional": true,
"description": "Last time the state of the task instance changed."
},
"milestone": {"type": "string", "optional": true,
"description": "The milestone the task is associated with."
},
"name": {"type": "string",
"description": "Name of the task instance."
},
"namespace": {"type": "string",
"description": "Namespace that categorizes the task instance."
},
"originator": {"type": "string",
"description": "ID of the user that created the task instance or on whose behalf the task instance was created."
},
"outputMessageTypeName": {"type": "string", "optional": true,
"description": "Name of the output message type. The value has the format {namespace}localname."
},
"owner": {"type": "string",
"description": "Owner of the task instance."
},
"parentContextID": {"type": "string",
"description": "ID of the parent context of the task instance."
},
"positionInHierarchy": {"type": "string", "optional": true,
"description": "Position in a possible task instance hierarchy.",
"enum":
[
"HIERARCHY_POSITION_FOLLOW_ON_TASK",
"HIERARCHY_POSITION_SUB_TASK",
"HIERARCHY_POSITION_TOP_TASK"
]
},
"priority": {"type": "integer",
"description": "Priority of the task instance."
},
"priorityName": {"type": "string", "optional": true,
"description": "Task priority (e.g., Low, Normal, High)."
},
"resumptionTime": {"type": "string", "format": "date-time", "optional": true,
"description": "Resumption time of the task instance if the task instance is suspended and is to be resumed automatically."
},
"roles": {"type": ["string"], "optional": true,
"description": "Roles of the current user."
},
"runURL": {"type": "object", "optional": true,
"description": "An URL that defines how to run the service/task."
},
"serviceID": {"type": "object", "optional": true,
"description": "ID of the service."
},
"starter": {"type": "string", "optional": true,
"description": "Starter of the task instance."
},
"startTime": {"type": "string", "format": "date-time",
"description": "Time when the task was claimed or when an invocation task enters the running state."
},
"state": {"type": "string",
"description": "State of the task instance.",
"enum":
[
"STATE_CLAIMED",
"STATE_EXPIRED",
"STATE_FAILED",
"STATE_FINISHED",
"STATE_FORWARDED",
"STATE_INACTIVE",
"STATE_READY",
"STATE_RUNNING",
"STATE_SUSPENDED_BY_PARENT",
"STATE_TERMINATED"
]
},
"status": {"type": "string", "optional": true,
"description": "Status of the task."
},
"substitutionPolicy": {"type": "string", "optional": true,
"description": "Substitution policy that takes place when people assignments are performed."
},
"supportsAutomaticClaim": {"type": "boolean", "optional": true,
"description": "States whether the task is claimed automatically when it becomes ready."
},
"supportsClaimIfSuspended": {"type": "boolean", "optional": true,
"description": "States whether the task can be claimed even if it is suspended."
},
"supportsDelegation": {"type": "boolean", "optional": true,
"description": "States whether the task supports delegation, for example, by transferring work items."
},
"supportsFollowOnTasks": {"type": "boolean", "optional": true,
"description": "States whether the task supports the creation of follow-on tasks."
},
"supportsSubTasks": {"type": "boolean", "optional": true,
"description": "States whether the task supports the creation of subtasks."
},
"taskTemplateID": {"type": "string",
"description": "ID of the task template this instance is derived from."
},
"taskTemplateName": {"type": "string", "optional": true,
"description": "Name of the task template this instance is derived from."
},
"tkiid": {"type": "string",
"description": "Task instance ID."
},
"topLevelTaskID": {"type": "string", "optional": true,
"description": "ID of the topmost task instance in a hierarchy of tasks."
},
"type": {"type": "string", "optional": true,
"description": "Type of the task."
},
"workBasketName": {"type": "string", "optional": true,
"description": "The name of the work basket the task belongs to."
}
}
}
The default content-type is application/json.
{ "description": "Error Response",
"type": "object",
"properties":
{ "federationResult":
[
{ "systemID": {"type": "string",
"description": "ID of the individual system the request was sent to."
},
"statusCode": {"type": "integer",
"description": "HTTP Status Code returned from this system."
},
"errorNumber": {"type": "string", "optional": true,
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string", "optional": true,
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description": "Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description": "Additional, exception details, for example, a stack trace."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of the exception."
}
}
],
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description": "Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description": "Additional, exception details, for example, a stack trace."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of the exception."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The task does not exist.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
| 503 Service Unavailable | The federated request could not be delivered to individual federation targets. |
| 504 Gateway Timeout | The federated response has partial content due to missing individual responses. |
| Release | Description |
|---|---|
| 7.5.1 | The returned task instance object contains new properties:
|
7.5
Parent Topic: Task Instance Resource