IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/webservice/{wsId}[?snapshotId={string}][&branchId={string}]
| Name | Value Type | Description |
|---|---|---|
| snapshotId | string | The ID of the snapshot associated with the web service. Either 'snapshotId' or 'branchId' must be specified.
|
| branchId | string | The ID of the branch associated with the web service. Either 'snapshotId' or 'branchId' must be specified.
|
None
The default content type is application/json.
{
"status":"200",
"data":{
"wsId":{"type": "string", "description": "The ID of the web service."},
"name":{"type": "string", "description": "The name of the web service."},
"desc":{"type": "string", "description": "The description of the web service."},
"wsdlUrl":{"type": "string", "description": "The WSDL URL of the web service."},
"operations":[{
"name":{"type": "string", "description": "The name of the operation."},
"operationId":{"type": "string", "description": "The ID of the operation."},
"seq":{"type": "integer", "description": "The operation sequence when there is more than one operation."},
"serviceId":{"type": "string", "description": "The ID of the attached service."},
"serviceName":{"type": "string", "description": "The name of the attached service."},
"serviceSnapshotId":{"type": "string", "description": "The ID of the snapshot associated with the attached service.
Either 'snapshotId' or 'branchId' must be specified."},
"serviceBranchId":{"type": "string", "description": "The ID of the branch associated with the attached service.
Either 'snapshotId' or 'branchId' must be specified."}
"desc":{"type": "string", "description": "The description of the operation."}
}
],
"protected":{"type": "boolean"}
}
}
{
"status":"200",
"data":{
"wsId":"7.6c38f27f-0db6-4af5-b589-0b5acc2b7f6c",
"name":"WebService1",
"desc":"WebService1 documentation",
"wsdlUrl":"http://yiwang2vm.torolab.ibm.com:9080/teamworks/webservices/HSS/v6.2/WebService1.tws?WSDL",
"operations":[{
"name":"operation1",
"operationId":"2052.1a60c654-521e-450e-ac46-dce886f7dd23",
"seq":1,
"serviceId":"1.f1489677-912e-42bb-b17a-f779115fbe41",
"serviceName":"GS1",
"serviceSnapshotId":"2064.c0b74305-f5e8-41d7-8b1c-cc143368fe7a",
"serviceBranchId":null,
"desc":"operation1 documentation"
},
{
"name":"operation2",
"operationId":"2052.a0030dcd-1d68-4055-88e1-4392c91eb9c9",
"seq":2,
"serviceId":"1.254a0925-652c-4e75-a377-3b6528c69fb2",
"serviceName":"Default System Service",
"serviceSnapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
"serviceBranchId":null,
"desc":"operation2 documentation"
}
],
"protected":true
}
}
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/ws" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/ws" 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" /> <complexType name="WSOperationType"> <sequence> <element name="name" type="string" /> <element name="operationId" type="string" /> <element name="seq" type="int" /> <element name="serviceId" type="string" /> <sequence> <element name="inputParameters" type="tns:WSInputParameter" minOccurs="0" maxOccurs="unbounded" /> </sequence> <sequence> <element name="outputParameters" type="tns:WSOutputParameter" minOccurs="0" maxOccurs="unbounded" /> </sequence> <element name="serviceName" type="string"/> <element name="serviceSnapshotId" type="string"/> <element name="serviceBranchId" type="string"/> <element name="desc" type="string" /> <element name="richDesc" type="string" /> </sequence> </complexType> <complexType name="WebServiceType"> <complexContent> <extension base="pref:Data"> <sequence> <element name="wsId" type="string" /> <element name="name" type="string" /> <element name="protected" type="boolean" /> <element name="desc" type="string" /> <element name="richDesc" type="string" /> <element name="wsdlUrl" type="string" /> <element name="operations" type="tns:WSOperationType" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType> <complexType name="WSInputParameter"> <attribute name="name" type="string" /> <attribute name="javaType" type="string" /> <attribute name="hasDefault" type="boolean" /> </complexType> <complexType name="WSOutputParameter"> <attribute name="name" type="string" /> <attribute name="javaType" type="string" /> </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 | Successful completion - detailed report returned.
|
| 400 Bad Request | The parameters are not valid or they are missing. |
| 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. |
7.5.1
Parent Topic: Web Service Resource