GET /rest/bpm/wle/v1/serviceModel/{serviceId}[?parts={string}][&snapshotId={string}][&processAppId={string}]
snapshotId
parameter is specified, that specific snapshot is used, and the processAppId
parameter is ignored.processAppId
parameter is specified, the tip (current) snapshot of the default branch (track) within that process application is used.
Name | Value Type | Description |
---|---|---|
parts | string | A string indicating which parts of the response data should be returned. You can use the following values:
header , dataModel , diagram , all (the default), or none . |
snapshotId | string | The identifier of the snapshot for the service.
|
processAppId | string | The identifier of the process application for the service.
|
None
The default content type is application/json.
{ "description": "WLE Service Model", "type": "object", "properties": { "header": {"type": "object", "description": "The 'header' part of the service model." { "UUID": {"type": "string", "description": "The unique ID of the service." }, "type": {"type": "string", "description": "The type of the service." }, "name": {"type": "string", "description": "The name of the service." }, "description": {"type": "string", "description": "The description of the service." } } }, "diagram": {"type": "object", "description": "The 'diagram' part of the service model." { "steps": {"type": "[object]", "description": "The list of steps associated with the service." } } }, "dataModel": {"type": "object", "description": "The 'dataModel' part of the service model." { "properties": {"type": "object", "description": "An object representing the properties within the service. Each field is a property name. Each object is a short description of the property's type. The object contains the fields: type, isList, description, richDescription" }, "inputs": {"type": "object", "description": "An object representing the input variables within the service. Each field is a variable name. Each object is a short description of the variable's type. The object contains the fields: type, isList, description, richDescription" }, "outputs": {"type": "object", "description": "An object representing the output variables within the service. Each field is a variable name. Each object is a short description of the variable's type. The object contains the fields: type, isList, description, richDescription" }, "validation": {"type": "object", "description": "An object representing the types within the service. Each field is a the name of one of the types or a nested type in the service Each object is a detailed description of the type The object contains the fields: ID, description, properties, isShared, options, patterns, etc." } } } } }
{ "status":"200", "data":{ "header":{ "type":"HUMAN", "name":"Submit Requisition", "UUID":"guid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7ed5" }, "diagram":{ "adhocs":[ "Initialize Output" ], "step":[ { "name":"Position type", "x":429, "y":167, "type":"Switch", "ID":"ProcessItem.7be7fd5e-41ec-4796-81eb-855a633fe9ff" }, { "name":"Confirm job position", "x":571, "y":219, "type":"Coach", "ID":"ProcessItem.374e086a-825f-4271-8a88-de6d3d03e944" }, { "name":"Create job requisition", "x":253, "y":152, "type":"Coach", "ID":"ProcessItem.e73c6fc9-6944-4595-9d53-88fbc1741243" }, { "name":"Initialize Output", "x":112, "y":152, "type":"Script", "ID":"ProcessItem.313f9bd7-b14e-49e7-9868-b9374cb29540" }, { "name":"Replace existing job position", "x":571, "y":89, "type":"Coach", "ID":"ProcessItem.b3c192c9-7907-43b3-8f5d-3b491a35cacd" }, { "name":"End", "x":788, "y":235, "type":"ExitPoint", "ID":"ProcessItem.749e03a4-fc6b-4d74-b269-5e11beb3665d" } ] }, "dataModel":{ "properties":{ "instanceId":{ "isList":false, "name":"String" }, "currentPosition":{ "isList":false, "name":"Position" }, "requisition":{ "isList":false, "name":"Requisition" } }, "inputs":{ "instanceId":{ "isList":false, "name":"String" } }, "outputs":{ "currentPosition":{ "isList":false, "name":"Position" }, "requisition":{ "isList":false, "name":"Requisition" } }, "validation":{ "String":{ "type":"string", "description":"String Type" }, "Person":{ "properties":{ "startDate":{ "isList":false, "name":"Date" }, "lastName":{ "isList":false, "name":"String" }, "notes":{ "isList":false, "name":"String" }, "payType":{ "isList":false, "name":"String" }, "supervisor":{ "isList":false, "name":"String" }, "firstName":{ "isList":false, "name":"String" }, "payLevel":{ "isList":false, "name":"String" } }, "type":"object" }, "Boolean":{ "type":"boolean", "description":"Boolean Type" }, "Position":{ "properties":{ "replacement":{ "isList":false, "name":"Person" }, "positionType":{ "isList":false, "name":"String" }, "iId":{ "isList":false, "name":"String" }, "jobTitle":{ "isList":false, "name":"String" } }, "type":"object" }, "Requisition":{ "properties":{ "instanceId":{ "isList":false, "name":"String" }, "requestor":{ "isList":false, "name":"String" }, "status":{ "isList":false, "name":"String" }, "department":{ "isList":false, "name":"String" }, "location":{ "isList":false, "name":"String" }, "reqNum":{ "isList":false, "name":"String" }, "approvalNeeded":{ "isList":false, "name":"Boolean" }, "gmApproval":{ "isList":false, "name":"String" }, "gmComments":{ "isList":false, "name":"String" }, "date":{ "isList":false, "name":"Date" }, "empNum":{ "isList":false, "name":"Integer" } }, "type":"object" }, "Date":{ "type":"date", "description":"Date Type" }, "Integer":{ "type":"integer", "description":"Integer Type" } } } } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/service" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/service" xmlns:pref="http://rest.bpm.ibm.com/v1/data/root" xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common"> <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"/> <!-- This type represents a service model. --> <complexType name="ServiceModel"> <complexContent> <extension base="pref:Data"> <sequence> <!-- This field corresponds to the "header" part of the service model --> <element name="header" type="tns:Header"/> <!-- This field corresponds to the "diagram" part of the service model --> <element name="diagram" type="tns:Diagram"/> <!-- This field corresponds to the "dataModel" part of the service model --> <element name="dataModel" type="tns:DataModel"/> </sequence> </extension> </complexContent> </complexType> <complexType name="Header"> <sequence> <!-- The unique ID of the service --> <element name="UUID" type="string" /> <!-- The type of the service --> <element name="type" type="string" /> <!-- The name of the service --> <element name="name" type="string" /> <!-- The description of the service --> <element name="description" type="string" /> <element name="richDescription" type="string" /> <!-- The snapshot ID of the service --> <element name="snapshotId" type="string" /> <!-- Warning --> <element name="warning" type="string" /> <!-- not used --> <element name="startTaskURL" type="string" /> <!-- not used --> <element name="startServiceURL" type="string" /> </sequence> </complexType> <complexType name="Diagram"> <sequence> <!-- The list of steps associated with the service --> <element name="step" type="tns:ServiceStep" minOccurs="0" maxOccurs="unbounded" /> </sequence> </complexType> <complexType name="DataModel"> <sequence> <!-- The variables (properties) associated with the service The key is the name of the property. The value containing a description of the property: * type (name of the type) * isList * description * richDescription --> <element name="properties" type="cmn:Map" /> <!-- The input variables associated with the service The key is the name of the variable. The value containing a description of the parameter: * type (name of the type) * isList * description * richDescription --> <element name="inputs" type="cmn:Map" /> <!-- The output variables associated with the service The key is the name of the variable. TThe value containing a description of the parameter: * type (name of the type) * isList * description * richDescription --> <element name="outputs" type="cmn:Map" /> <!-- Detailed information about the types referenced by the service. Each type referenced above and nested types are described. The key is the name of the type. The value is an map of information about the type Here are some of the fields: * ID, pattern, properties, isShared, options, min, max, description, fixedLength --> <!-- A structure explaining the data model of the service --> <element name="validation" type="cmn:Map" /> </sequence> </complexType> <!-- This type represents a step associated with a service. --> <complexType name="ServiceStep"> <sequence> <!-- The step ID --> <element name="ID" type="string" /> <!-- The step name --> <element name="name" type="string" /> <!-- The X, Y coordinate of the center point of the step within the diagram --> <element name="x" type="int" /> <element name="y" type="int" /> <!-- The step type --> <element name="type" type="string" /> <!-- Web Service Integration Data --> <element name="data" type="tns:WSIntegrationData" /> <!-- The set of lines extending out from this step within the diagram --> <element name="lines" type="tns:ServiceStepLines" /> </sequence> </complexType> <!-- This type represents webservices integration data --> <complexType name="WSIntegrationData"> <sequence> <element name="wsdlURI" type="string" /> <element name="serviceName" type="string" /> <element name="portName" type="string" /> <element name="operationName" type="string" /> <element name="isProtectedWSDL" type="boolean" /> <element name="isOverrideEndpointAddress" type="boolean" /> <element name="endpointAddressURL" type="string" /> </sequence> </complexType> <!-- This type represents a set of lines associated with a service step --> <complexType name="ServiceStepLines"> <sequence> <element name="stepLine" minOccurs="0" maxOccurs="unbounded" type="tns:ServiceStepLine" /> </sequence> </complexType> <!-- This type represents a single line associated with a service step --> <complexType name="ServiceStepLine"> <sequence> <!-- The ID of the step to which this line extends --> <element name="to" type="string" /> <!-- A string containing a comma-separated list of coordinates through which this line extends. The list of points must contain the first point (coordinate of the "fromPort") and the last point (coordinate of the "toPort"). --> <element name="points" type="string" /> </sequence> </complexType> <!-- This type contains information related to a running service --> <complexType name="ServiceRunModel"> <complexContent> <extension base="pref:Data"> <sequence> <!-- The status of the service; values: "end", "running", "coach", "error", "debug" --> <element name="serviceStatus" type="string" /> <!-- The ID of the running service or task instance. This is the ID to be used when resuming the service or task. --> <element name="key" type="string" /> <!-- The ID of the current step within the context of the running service --> <element name="step" type="string" /> <!-- The flag to determine if it was reset back to a certain step --> <element name="reset" type="boolean" /> <!-- The unique ID of the current step within the context of the running service --> <element name="stepId" type="string" /> <!-- The ID of the PO that implements the step --> <element name="poId" type="string" /> <!-- The ID of the processItem of the step --> <element name="processItemId" type="string" /> <!-- The data (symbol table) associated with the running service --> <element name="data" type="anyType" /> <!-- If the service status is "coach", this field contains the coach XML data --> <element name="coach" type="string" /> <!-- If the service status is "coach", this field contains a Map of evaluated coach values --> <element name="coachEvals" type="cmn:Map" /> <!-- If the service status is "coach", this field contains a list of available actions (end point) --> <element name="actions" type="string" minOccurs="0" maxOccurs="unbounded" /> <!-- If the service status is "coach", this field contains a map of actions and associated labels --> <element name="actionsMap" type="cmn:Map" /> </sequence> </extension> </complexContent> </complexType> <complexType name="CoachEval"> <sequence> <element name="ID" type="string" /> <element name="value" type="string" /> </sequence> </complexType> <!-- This type represents a list of currently running services --> <complexType name="CurrentlyRunning"> <complexContent> <extension base="pref:Data"> <sequence> <!-- A list of keys of services that are currently running for the current user --> <element name="instanceIDs" type="string" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents the result obtained from evaluating a javascript expression within the context of a currently running service --> <complexType name="Result"> <complexContent> <extension base="pref:Data"> <sequence> <element name="result" type="string" minOccurs="0" maxOccurs="1" /> <!-- Data information stored in an actual Map --> <element name="resultMap" type="cmn:Map" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType> </schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bpm:ResponseData xmlns:bpm='http://rest.bpm.ibm.com/v1/data'> <status>200</status> <data xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:svc='http://rest.bpm.ibm.com/v1/data/service' xsi:type='svc:ServiceModel'> <header> <UUID>guid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7ed5</UUID> <type>HUMAN</type> <name>Submit Requisition</name> </header> <diagram> <adhocs>Initialize Output</adhocs> <step> <ID>ProcessItem.7be7fd5e-41ec-4796-81eb-855a633fe9ff</ID> <name>Position type</name> <x>429</x> <y>167</y> <type>Switch</type> </step> <step> <ID>ProcessItem.374e086a-825f-4271-8a88-de6d3d03e944</ID> <name>Confirm job position</name> <x>571</x> <y>219</y> <type>Coach</type> </step> <step> <ID>ProcessItem.e73c6fc9-6944-4595-9d53-88fbc1741243</ID> <name>Create job requisition</name> <x>253</x> <y>152</y> <type>Coach</type> </step> <step> <ID>ProcessItem.313f9bd7-b14e-49e7-9868-b9374cb29540</ID> <name>Initialize Output</name> <x>112</x> <y>152</y> <type>Script</type> </step> <step> <ID>ProcessItem.b3c192c9-7907-43b3-8f5d-3b491a35cacd</ID> <name>Replace existing job position</name> <x>571</x> <y>89</y> <type>Coach</type> </step> <step> <ID>ProcessItem.749e03a4-fc6b-4d74-b269-5e11beb3665d</ID> <name>End</name> <x>788</x> <y>235</y> <type>ExitPoint</type> </step> </diagram> <dataModel> <properties> <item key='instanceId'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='currentPosition'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Position</value> </item> </value> </item> <item key='requisition'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Requisition</value> </item> </value> </item> </properties> <inputs> <item key='instanceId'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> </value> </item> </inputs> <outputs> <item key='requisition'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Requisition</value> </item> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> </value> </item> <item key='currentPosition'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Position</value> </item> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> </value> </item> </outputs> <validation> <item key='String'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>string</value> </item> <item key='description'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String Type</value> </item> </value> </item> <item key='Person'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='properties'> <value xsi:type='cmn:Map'> <item key='startDate'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Date</value> </item> </value> </item> <item key='notes'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='lastName'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='payType'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='supervisor'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='firstName'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='payLevel'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> </value> </item> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>object</value> </item> </value> </item> <item key='Boolean'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>boolean</value> </item> <item key='description'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Boolean Type</value> </item> </value> </item> <item key='Position'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='properties'> <value xsi:type='cmn:Map'> <item key='replacement'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Person</value> </item> </value> </item> <item key='positionType'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='iId'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='jobTitle'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> </value> </item> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>object</value> </item> </value> </item> <item key='Requisition'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='properties'> <value xsi:type='cmn:Map'> <item key='instanceId'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='department'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='status'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='requestor'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='location'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='approvalNeeded'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Boolean</value> </item> </value> </item> <item key='reqNum'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='gmApproval'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='gmComments'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>String</value> </item> </value> </item> <item key='empNum'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Integer</value> </item> </value> </item> <item key='date'> <value xsi:type='cmn:Map'> <item key='isList'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:boolean'>false</value> </item> <item key='name'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Date</value> </item> </value> </item> </value> </item> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>object</value> </item> </value> </item> <item key='Integer'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>integer</value> </item> <item key='description'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Integer Type</value> </item> </value> </item> <item key='Date'> <value xsi:type='cmn:Map' xmlns:cmn='http://rest.bpm.ibm.com/v1/data/common'> <item key='type'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>date</value> </item> <item key='description'> <value xmlns:ns6='http://www.w3.org/2001/XMLSchema' xsi:type='ns6:string'>Date Type</value> </item> </value> </item> </validation> </dataModel> </data> </bpm:ResponseData>
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." } } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception" xmlns:dat="http://rest.bpm.ibm.com/v1/data/root"> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" /> <!-- This type represents an error response. --> <element name="RestRuntimeException"> <complexType> <sequence> <element name="status" type="string"/> <element name="Data" type="tns:ExceptionData"> </element> </sequence> </complexType> </element> <!-- This type contains detailed error information associated with an exception. --> <complexType name="ExceptionData"> <sequence> <element name="status" type="string"/> <!-- This specifies the java class name of the exception --> <element name="exceptionType" type="string"/> <!-- The message ID of the error message --> <element name="errorNumber" type="string" minOccurs="0"/> <!-- The complete error message --> <element name="errorMessage" type="string"/> <!-- The list of strings inserted into the error message --> <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/> <!-- The stacktrace associated with the exception. Note that this will be omitted unless the "server-stacktrace-enabled" property is enabled in the server's 100Custom.xml file. --> <element name="programmersDetails" type="string"></element> <!-- Prior responses. Set if a bulk command was used --> <element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element> <element name="errorData" type="tns:ErrorData" minOccurs="0" /> </sequence> </complexType> <complexType name="ErrorData"> <sequence> <element name="code" type="string" /> <element name="data" type="string" minOccurs="0" /> </sequence> </complexType> </schema>
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 service model 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. |
7.5.0
Parent Topic: Service Model Resource