WebSphere Process Server, Version 6.2.0.1
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS
GET /v1/process/{piid}
None.
None.
The default content-type is application/json.
{ "description": "BFM Process", "type": "object", "properties": { "adminTaskID": {"type": "string", "description": "ID of the associated administration task." }, "completionTime": {"type": "string", "format": "date-time", "description": "Completion time of the process instance." }, "creationTime": {"type": "string", "format": "date-time", "description": "Creation time of the process instance." }, "customProperties" : {"type": "object", "additionalProperties": {"type": "string"}, "description": "List of custom property names and values." }, "description": {"type": "string", "description": "Description of the process instance." }, "displayName": {"type": "string", "description": "Display name of the associated process template." }, "executionState": {"type": "string", "description": "Execution state of the process instance.", "enum": [ "STATE_COMPENSATED", "STATE_COMPENSATION_FAILED", "STATE_COMPENSATING", "STATE_DELETED", "STATE_FAILED", "STATE_FAILING", "STATE_FINISHED", "STATE_INDOUBT", "STATE_READY", "STATE_RUNNING", "STATE_SUSPENDED", "STATE_TERMINATED", "STATE_TERMINATING" ] }, "faultName": {"type": "string", "description": "Name of the fault if the process instance ended with an unhandled fault. The value has the format {namespace}localname." }, "isBusinessRelevant": {"type": "boolean", "description": "States whether the process instance is a business relevant or an 'auxiliary' step." }, "isContinueOnError": {"type": "boolean", "description": "States whether the process instance stops in case of an unhandled error or not." }, "lastModificationTime": {"type": "string", "format": "date-time", "description": "Last time a property of the process instance changed." }, "lastStateChangeTime": {"type": "string", "format": "date-time", "description": "Last time the execution state of the process instance changed." }, "name": {"type": "string", "description": "Name of the process instance." }, "parentProcessInstanceName": {"type": "string", "description": "Name of the parent process instance." }, "parentProcessInstanceID": {"type": "string", "description": "ID of the parent process instance." }, "piid": {"type": "string", "description": "ID of the process instance." }, "processTemplateID": {"type": "string", "description": "ID of the process template this instance is derived from." }, "processTemplateName": {"type": "string", "description": "Name of the process template this instance is derived from." }, "resumptionTime": {"type": "string", "format": "date-time", "description": "Resumption time of the process instance if the process instance is suspended and is to be resumed automatically." }, "startTime": {"type": "string", "format": "date-time", "description": "Start time of the process instance." }, "starter": {"type": "string", "description": "Starter of the process instance." }, "topLevelProcessInstanceID": {"type": "string", "description": "ID of the topmost process instance in a hierarchy of processes." }, "topLevelProcessInstanceName": {"type": "string", "description": "Name of the topmost process instance in a hierarchy of processes." } } }
The default content-type is application/json.
{ "description": "BFM Error Response", "type": "object", "properties": { "errorNumber": {"type": "string", "description":"Message ID of the exception." }, "errorMessage": {"type": "string", "description":"Message text of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional, exception details, for example, a stack trace." } } }
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 process does not exist.
|
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
6.2
Parent Topic: Process Instance Resource