GET /rest/bpm/wle/v1/SCAServiceModel/{serviceId}[?snapshotId={string}][&branchId={string}]
snapshotId or branchId parameters.snapshotId parameter is specified, that specific snapshot is used, and the branchId parameter is ignored.branchId parameter is specified, the tip (current) snapshot of the specified branch (track) is used.| Name | Value Type | Description |
|---|---|---|
| snapshotId | string | The identifier of the snapshot associated with the advanced integration service. You must set one of the
snapshotId or branchId parameters. |
| branchId | string | The identifier of the branch associated with the advanced integration service. You must set one of the
snapshotId or branchId parameters. |
None
The default content type is application/json.
{
"status":"200",
"data":{
"id":{"type": "string", "description": "The ID of the advanced integration service."},
"name":{"type": "string", "description": "The name of the advanced integration service."},
"desc":{"type": "string", "description": "The description of the advanced integration service."},
"poId":{"type": "string", "description": "The persistent object ID of the advanced integration service."},
"poVersionId":{"type": "string", "description": "The persistent object version ID of the advanced integration service."},
"item":
{
"exportName": {"type": "string", "description": "The export name."},
"moduleName": {"type": "string", "description": "The module name."},
"operationName": {"type": "string", "description": "The operation name."},
"moduleVersion": {"type": "string", "description": "The module version."},
"isAsyncInvocation": {"type": "boolean"},
"guid":{"type": "string"},
"versionId":{"type": "string"},
},
"variables":
[
{
"poId":{"type": "string", "description": "The ID of the parameter type."},
"poName":{"type": "string", "description": "The name of the parameter type."},
"snapshotId":"2064.e1d396eb-8e73-4bb6-bd35-a84c6e8527fb",
"branchId":null,
"isList":{"type": "boolean", "description": "Specifies whether this parameter is a list."},
"type":{"type": "string", "description": "Specifies whether this parameter is input or output.",
enum":
[
"input",
"output"
]
},
"name":{"type": "string", "description": "The name of the parameter."}
}
]
}
}
{
"status":"200",
"data":{
"name":"AIS",
"desc":"AIS documentation",
"poId":"1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
"poVersionId":"a2c07628-3e78-4c91-b335-3b1918cdc5ac",
"id":"1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
"item":{
"isAsyncInvocation":false,
"guid":"guid:4d136293f40cc951:-157548c5:1328766f77f:-7f55",
"versionId":"7ecc26d0-969f-4a07-9b42-7c5c2482f2f5"
},
"variables":[{
"poName":"String",
"snapshotId":null,
"branchId":null,
"isList":true,
"type":"input",
"name":"input1"
},
{
"poId":"12.f3a52cf9-83c9-4900-9730-1229d8b37b43",
"poName":"Person",
"snapshotId":"2064.e1d396eb-8e73-4bb6-bd35-a84c6e8527fb",
"branchId":null,
"isList":false,
"type":"input",
"name":"input2"
},
{
"poName":"String",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"output",
"name":"output1"
},
{
"poName":"Boolean",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"private",
"name":"isImplemented"
},
{
"poName":"Boolean",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"private",
"name":"isInSync"
},
{
"poName":"Boolean",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"private",
"name":"isDeployed"
},
{
"poName":"Boolean",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"private",
"name":"isProcessCenter"
},
{
"poName":"Boolean",
"snapshotId":null,
"branchId":null,
"isList":false,
"type":"private",
"name":"modifedExecutionSaveState"
}
]
}
}
<?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"
xmlns:model="http://rest.bpm.ibm.com/v1/data/bpd/visual">
<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"/>
<import schemaLocation="ILOGVisualModel.xsd" namespace="http://rest.bpm.ibm.com/v1/data/bpd/visual"/>
<complexType name="SCAConnectorItem">
<annotation>
<documentation>For Service</documentation>
</annotation>
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="exportName" type="string"/>
<element name="moduleName" type="string"/>
<element name="operationName" type="string"/>
<element name="isAsyncInvocation" type="boolean"/>
<element name="moduleVersion" type="string"/>
<element name="guid" type="string"/>
<element name="versionId" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="AISType">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="name" type="string"/>
<element name="desc" type="string"/>
<element name="richDesc" type="string"/>
<element name="poId" type="string"/>
<element name="poVersionId" type="string"/>
<element name="id" type="string"/>
<element name="serviceType" type="string"/>
<element name="item" type="tns:SCAConnectorItem"/>
<element name="variables" type="model:Variable" minOccurs="0" maxOccurs="unbounded"/>
</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 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.1
Parent Topic: Advanced Integration Service Resource