IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/bpddata/{bpdId}[?snapshotId={string}][&branchId={string}]
Name | Value Type | Description |
---|---|---|
snapshotId | string | The ID of the snapshot for the business process definition. Either 'snapshotId' or 'branchId' must be specified.
|
branchId | string | The ID of the branch for the business process definition. Either 'snapshotId' or 'branchId' must be specified.
|
None
The default content type is application/json.
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/bpddata" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pref="http://rest.bpm.ibm.com/v1/data/root" xmlns:tns="http://rest.bpm.ibm.com/v1/data/bpddata"> <import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/> <complexType name="DataList"> <sequence> <element name="item" minOccurs="0" maxOccurs="unbounded" type="tns:Item"> </element> </sequence> </complexType> <complexType name="Item"> <attribute name="value" type="string" use="required" /> <attribute name="occurrences" type="int" use="required" /> </complexType> <complexType name="ActivityList"> <sequence> <element name="activity" minOccurs="0" maxOccurs="unbounded" type="tns:Activity"> </element> </sequence> </complexType> <complexType name="Activity"> <sequence> <element name="variables" minOccurs="0" maxOccurs="unbounded" type="tns:VariableData"> </element> </sequence> <attribute name="BpmnObjectId" type="string" use="required" /> </complexType> <complexType name="VariableData"> <attribute name="value" type="string" use="required" /> <attribute name="usedAs" type="string" use="required" /> </complexType> <complexType name="BPDModelData"> <complexContent> <extension base="pref:Data"> <sequence> <element name="inputs" type="tns:DataList" /> <element name="outputs" type="tns:DataList" /> <element name="privateVariables" type="tns:DataList" /> <element name="Activities" type="tns:ActivityList" /> </sequence> </extension> </complexContent> </complexType> </schema>
The default content type is application/json.
{ "description": "WLE Error Response", "type": "object", "properties": { "status": {"type": "string", "description": "The status of the previous API call." }, "exceptionType": {"type": "string", "description": "The classname associated with 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." } } }
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 resource 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. |
8.0.1
Parent Topic: BPD Data Resource