Swagger UI for decision runtime API
The decision runtime REST API is accessible from the Swagger UI facility.
You can access the Swagger UI facility with the following URL:
https://<server>/ads/runtime/api/swagger-ui/The resulting web page provides a user interface to execute decision service archives intuitively. For each execution request, the Swagger interface displays the resulting HTTP return code, along with the body of the response in the JSON format. The Swagger interface also generates and displays an equivalent CURL command for each execution request.
It also provides a user interface to explore the data model of the decision runtime REST API. For more information about the decision runtime REST API endpoints, see the Decision runtime REST API in Reference (available in the Swagger UI view).
Decision runtime operation IDs
To make each operation ID (operationId) consistent with its operation, some
operation IDs for the decision runtime OpenAPI have been renamed since Automation Decision Services 25.0.0.
| Path | Operation | Old operationId |
New operationId |
|---|---|---|---|
| /about | GET | about |
getAbout |
| /deploymentSpaces | GET | getdeploymentSpaceIds |
getDeploymentSpaceIds |
| /deploymentSpaces/{deploymentSpaceId} | DELETE | removeDeploymentSpace |
deleteDeploymentSpace |
| /deploymentSpaces/{deploymentSpaceId}/decisions | GET | getArchivesDecisions |
getDecisionIds |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/archive | DELETE | deleteArchive |
deleteDecisionArchive |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/archive | GET | getArchive |
getDecisionArchive |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/archive | POST | postArchive |
deployDecisionArchive |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/metadata | DELETE | removeMetadata |
deleteDecisionMetadata |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/metadata | GET | getMetadata |
getDecisionMetadata |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/metadata | PUT | setMetadata |
setDecisionMetadata |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/openapi | GET | openApi |
getDecisionOpenAPI |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations | GET | operations |
getDecisionOperationIds |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/exampleInput | GET | samplePayload |
getDecisionOperationExampleInput |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/execute | POST | execute |
executeDecisionOperation |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/extendedExecute | POST | decision |
extendedExecuteDecisionOperation |
| /deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/schemas | GET | schemas |
getDecisionOperationSchemas |
| /deploymentSpaces/{deploymentSpaceId}/metadata | GET | retrieveDeploymentSpaceMetadata |
getDeploymentSpaceDecisionsMetadata |
| /health | GET | health |
getHealth |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi | GET | decisionServiceVersionOpenApi |
getDecisionServiceVersionOpenAPI |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations | GET | decisionServiceVersionOperations |
getDecisionServiceVersionOperationIds |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput | GET | decisionServiceVersionSamplePayload |
getDecisionServiceVersionExampleInput |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute | POST | decisionServiceVersionExecute |
executeDecisionServiceVersion |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute | POST | decisionServiceVersionExecuteExtended |
extendedExecuteDecisionServiceVersion |
| /selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas | GET | decisionServiceVersionSchemas |
getDecisionServiceVersionSchemas |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/openapi | GET | lastDeployedVersionOpenApi |
getLastDeployedDecisionServiceVersionOpenAPI |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations | GET | lastDeployedVersionOperations |
getLastDeployedDecisionServiceVersionOperationIds |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput | GET | lastDeployedVersionSamplePayload |
getLastDeployedDecisionServiceVersionExamplePayload |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute | POST | lastDeployedVersionExecute |
executeLastDeployedDecisionServiceVersion |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute | POST | lastDeployedVersionExecuteExtended |
extendedExecuteLastDeployedDecisionServiceVersion |
| /selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas | GET | lastDeployedVersionSchemas |
getLastDeployedDecisionServiceVersionSchemas |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi | GET | lastSemanticVersionOpenApi |
getLastSemanticDecisionServiceVersionOpenAPI |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations | GET | lastSemanticVersionOperations |
getLastSemanticDecisionServiceVersionOperationIds |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput | GET | lastSemanticVersionSamplePayload |
getLastSemanticDecisionServiceVersionExampleInput |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute | POST | lastSemanticVersionExecute |
executeLastSemanticDecisionServiceVersion |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute | POST | lastSemanticVersionExecuteExtended |
extendedExecuteLastSemanticDecisionServiceVersion |
| /selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas | GET | lastSemanticVersionSchemas |
getLastSemanticDecisionServiceVersionShemas |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi | GET | lastSortedVersionOpenApi |
getLastSortedDecisionServiceVersionOpenAPI |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations | GET | lastSortedVersionOperations |
getLastSortedDecisionServiceVersionOperationIds |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput | GET | lastSortedVersionSamplePayload |
getLastSortedDecisionServiceVersionExamplePayload |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute | POST | lastSortedVersionExecute |
executeLastSortedDecisionServiceVersion |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute | POST | lastSortedVersionExecuteExtended |
extendedExecuteLastSortedDecisionServiceVersion |
| /selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas | GET | lastSortedVersionSchemas |
getLastSortedDecisionServiceVersionSchemas |
| /snapshot | GET | snapshot |
getSnapshot |