REST interface for federated IBM BPM resources - Process instance Resource - GET Method

Use this method to retrieve details of a specified process instance.

Sample method invocation

GET /rest/bpm/federated/bfm/v1/process/{piid}?systemID={string}

Parameters

Required Federation Parameter

Name	Value Type	Description
systemID	string	ID of the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) system hosting the resource.

Request Content

None

Response Content

Process instance details.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Process", 
   "type": "object",
   "properties":
   {  "adminTaskID": {"type": "string", "optional": true,
         "description": "ID of the associated administration task."
      },
      "comments": {"type": "[object]", "optional": true,
         "description": "List of comments on this instance."
      },
      "completionTime": {"type": "string", "format": "date-time", "optional": true,
         "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"}, "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": "Data of this instance."
      },
      "description": {"type": "string",
         "description": "Description of the process instance."
      },
      "diagram": {"type": "object", "optional": true,
         "description": "BPD diagram of this instance, including existing tokens for the instance."
      },
      "displayName": {"type": "string", "optional": true,
         "description": "Display name of the associated process template."
      },
      "documents": {"type": "[object]", "optional": true,
         "description": "List of documents on this instance."
      },
      "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", "optional": true,
         "description": "Name of the fault if the process instance ended with an unhandled fault. The value has the format {namespace}localname."
      },
      "instanceDueDate": {"type": "string", "optional": true,
         "description": "Due date of the instance."
      },
      "instanceError": {"type": "string", "optional": true,
         "description": "Error message for failed instances."
      },
      "instancePredictedDueDate": {"type": "string", "optional": true,
         "description": "Predicted due date of the instance."
      },
      "instanceProcessApplication": {"type": "string", "optional": true,
         "description": "Name of the process application this instance is part of."
      },
      "instanceSnapshot": {"type": "string", "optional": true,
         "description": "Name of the snapshot this instance is part of."
      },
      "instanceSnapshotID": {"type": "string", "optional": true,
         "description": "ID of the snapshot this instance is part of."
      },
      "isBusinessRelevant": {"type": "boolean", "optional": true,
         "description": "States whether the process instance is a business relevant or an 'auxiliary' step."
      },
      "isContinueOnError": {"type": "boolean", "optional": true,
         "description": "States whether the process instance stops in case of an unhandled error or not."
      },
      "isMigrated": {"type": "boolean", "optional": true,
         "description": "States whether the process instance has been migrated."
      },
      "lastModificationTime": {"type": "string", "format": "date-time",
         "description": "Last time a property of the process instance changed."
      },
      "lastStateChangeTime": {"type": "string", "format": "date-time", "optional": true,
         "description": "Last time the execution state of the process instance changed."
      },
      "name": {"type": "string",
         "description": "Name of the process instance."
      },
      "parentProcessInstanceName": {"type": "string", "optional": true,
         "description": "Name of the parent process instance."
      },
      "parentProcessInstanceID": {"type": "string", "optional": true,
         "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", "optional": true,
         "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", "optional": true,
         "description": "Start time of the process instance."
      },
      "starter": {"type": "string", "optional": true,
         "description": "Starter of the process instance."
      },
      "tasks": {"type": "[object]", "optional": true,
         "description": "List of tasks with the same data model."
      },
      "topLevelProcessInstanceID": {"type": "string", "optional": true,
         "description": "ID of the topmost process instance in a hierarchy of processes."
      },
      "topLevelProcessInstanceName": {"type": "string", "optional": true,
         "description": "Name of the topmost process instance in a hierarchy of processes."
      }
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "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."
      }      
   }
}

Status codes

The method returns one of the following status codes:

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.
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 because of missing individual responses.

Change history

The following changes have been applied to this method:

Release	Description
7.5.1	The returned process instance object contains new properties: `"customText1"` ... `"customText8"`

Available since

7.5

Parent topic: Process instance Resource