IBM DataPower Operations Dashboard v1.0.13.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

DevOps Portal REST API

Prerequisites

Requires admin or operator access, an operator user will also need specific user role that allows the operation (for example - validate remote WSDL)
Unauthorized requests will receive a "401 Unauthorized" response.


The following API calls do NOT execute the operation, they just add it to the execution queue.
The operation may not be executed at all (For example - the device was not accessible). you can view the operation result in the Services Portal Execution Status Page

Validate Remote WSDL

POST  /op/api/v1/servicesportal/validateRemoteWsdl?deviceName=idg76_2&domainName=DMZ&serviceName=myServiceName&newRemoteWsdlAddress=http://new/wsdl/address

newRemoteWsdlAddress- optional parameter with the address of the new remote WSDL, you can omit this parameter to use the current address

Successful Response

{
"resultCode": "SUCCESS",
"resultMessage": "SUCCESS",
"executionId": 69,
"executionUUID": "E77225BB-7945-4E42-B1F6-041D1E109349"
}

Error Response

{
"resultCode": "ERROR",
"resultMessage": "There is already an in-progress action for this service, please wait until it is done."
}

Promote Remote WSDL

POST  /op/api/v1/servicesportal/promoteRemoteWsdl?deviceName=idg76_2&domainName=DMZ&serviceName=myServiceName&newRemoteWsdlAddress=http://new/wsdl/address

newRemoteWsdlAddress- optional parameter with the address of the new remote WSDL, you can omit this parameter to use the current address

Successful Response

{
"resultCode": "SUCCESS",
"resultMessage": "SUCCESS",
"executionId": 69,
"executionUUID": "E77225BB-7945-4E42-B1F6-041D1E109349"
}

Error Response

{
"resultCode": "ERROR",
"resultMessage": "There is already an in-progress action for this service, please wait until it is done."
}

Validate Local WSDL

POST  /op/api/v1/servicesportal/validateLocalWsdl?deviceName=idg76_2&domainName=DMZ&serviceName=myServiceName&filesPath=/myFolder/new&newWsdlFileName=myWsdl.svc.wsdl

filesPath - a folder that contains the WSDL and XSD files, it needs to be accessible to DPOD
newWsdlFileName - the name of the base WSDL file in the filesPath folder

Successful Response

{
"resultCode": "SUCCESS",
"resultMessage": "SUCCESS",
"executionId": 69,
"executionUUID": "E77225BB-7945-4E42-B1F6-041D1E109349"
}

Error Response

{
"resultCode": "ERROR",
"resultMessage": "New WSDL file with name=myWsdl.svc.wsdl was not found in /myFolder/new"
}

Promote Local WSDL

POST  /op/api/v1/servicesportal/promoteLocalWsdl?deviceName=idg76_2&domainName=DMZ&serviceName=myServiceName&filesPath= /myFolder/new&newWsdlFileName=myWsdl.svc.wsdl

filesPath - a folder that contains the WSDL and XSD files, it needs to be accessible to DPOD
newWsdlFileName - the name of the base WSDL files in the filesPath folder

Successful Response

{
"resultCode": "SUCCESS",
"resultMessage": "SUCCESS",
"executionId": 69,
"executionUUID": "E77225BB-7945-4E42-B1F6-041D1E109349"
}

Error Response

{
"resultCode": "ERROR",
"resultMessage": "New WSDL file with name=myWsdl.svc.wsdl was not found in /myFolder/new"
}

IBM DataPower Operations Dashboard (DPOD) v1.0.13.0