GET /rest/bpm/wle/v1/playback/server[?snapshotId={string}][&branchId={string}]
| Name | Value Type | Description |
|---|---|---|
| snapshotId | string | Use this parameter to only return playback servers.
|
| branchId | string | Use this parameter to only return playback servers for the tip of the branch.
|
None
The default content type is application/json.
{ "description": "WLE Server Details",
"type": "object",
"properties":
{
"Server": {"type": "[object]",
"description": "List of playback server available for the snapshot."
[
{
"ID": {"type": "string",
"description": "The Server identifier."
},
"name": {"type": "string",
"description": "The server name."
},
"type": {"type": "string",
"description": "The server type."
},
"isOffline": {"type": "boolean",
"description": "The server's online status."
},
"targetEnvironment": {"type": "string",
"description": "The server's target environment"
},
"endpoints":
[
{
"name": {
"type": "string",
"description": "The endpoint name."
},
"url": {
"type": "string",
"description": "The endpoint URL."
}
}
]
}
]
}
}
}
{
"status": "200",
"data": {
"server": [{
"id": "2068.3e945357-22b3-4e08-ad49-05a0f197e890",
"name": "dev",
"type": "TEST",
"isOffline": false,
"targetEnvironment": "BAW_tWAS",
"endpoints": [{
"name": "bpm_endpoint_socialbus",
"url": "https://hgartner.canlab.ibm.com:9083/bpm/notification"
}, {
"name": "bpm_endpoint_coachflow",
"url": "https://hgartner.canlab.ibm.com:9083/bpm/cf"
}, {
"name": "bpm_endpoint_portal",
"url": "https://hgartner.canlab.ibm.com:9083/ProcessPortal"
}, {
"name": "bpm_endpoint_bpmrest",
"url": "https://hgartner.canlab.ibm.com:9083/rest/bpm/wle"
}
]
}, {
"id": "2068.d85c0328-779c-49b5-88fd-4c4aa506c28d",
"name": "Workflow Center",
"type": "PLAYBACK",
"isOffline": false,
"targetEnvironment": "BAW_tWAS",
"endpoints": null
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/playback" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/playback" xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/> <complexType name="ServerDetails"> <complexContent> <extension base="pref:Data"> <sequence> <!-- The process instance data --> <element name="server" type="tns:ServerDetail" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType> <complexType name="ServerDetail"> <complexContent> <extension base="pref:Data"> <sequence> <element name="id" type="string" /> <element name="name" type="string" /> <element name="type" type="string" /> <element name="isOffline" type="boolean" /> <element name="targetEnvironment" type="string" /> <element name="address" type="string" /> <element name="authenticationUrl" type="string" /> <element name="authenticationClientId" type="string" /> <element name="zenUrl" type="string" /> <element name="endpoints" type="tns:EndpointDetail" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType> <complexType name="EndpointDetail"> <complexContent> <extension base="pref:Data"> <sequence> <element name="name" type="string" /> <element name="url" type="string" /> </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" xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception">
<status>200</status>
<data xsi:type="playback:ServerDetails" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:playback="http://rest.bpm.ibm.com/v1/data/playback">
<server>
<id>2068.3e945357-22b3-4e08-ad49-05a0f197e890</id>
<name>dev</name>
<type>TEST</type>
<isOffline>false</isOffline>
<targetEnvironment>BAW_tWAS</targetEnvironment>
<endpoints>
<name>bpm_endpoint_socialbus</name>
<url>https://hgartner.canlab.ibm.com:9083/bpm/notification</url>
</endpoints>
<endpoints>
<name>bpm_endpoint_coachflow</name>
<url>https://hgartner.canlab.ibm.com:9083/bpm/cf</url>
</endpoints>
<endpoints>
<name>bpm_endpoint_portal</name>
<url>https://hgartner.canlab.ibm.com:9083/ProcessPortal</url>
</endpoints>
<endpoints>
<name>bpm_endpoint_bpmrest</name>
<url>https://hgartner.canlab.ibm.com:9083/rest/bpm/wle</url>
</endpoints>
</server>
<server>
<id>2068.d85c0328-779c-49b5-88fd-4c4aa506c28d</id>
<name>Workflow Center</name>
<type>PLAYBACK</type>
<isOffline>false</isOffline>
<targetEnvironment>BAW_tWAS</targetEnvironment>
</server>
</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. |
| 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.6.0
Parent Topic: Server Resource