Siebel REST API Guide > Using the Siebel REST API > Using Siebel REST API to Access Siebel Business Services JSON Examples >
Using Describe to Return a Catalog of URLs for All Available Business Services
You can use the OpenAPI Describe parameter by appending Describe to an HTTP GET request to the resource's URI. The following details are for a Describe request to return a catalog of URLs for all available business services from the Siebel CRM Server:
- URI: http://ServerName:port/siebel/v1.0/workspace/main/Applet/{key}/Control/describe
- HTTP Method: GET
- Content-Type: application/json
- Authorization: Basic
- Request body:
The following are the details for the response to a successful request:
- HTTP Code: 200
- Content-Type:
- Response body:
{ "swagger": "2.0", "info": { }, "schemes": [ "http", "https" ], "securityDefinitions": { "Basic Auth": { "type": "basic" } }, "externalDocs": { "description": "OpenAPI", "url": "https://openapis.org" }, "host": "host:port number", "basePath": "/siebel/v1.0", "tags": [ { "name": "service/ABO Bulk Request Explode Service/describe", "description": "Catalogging of ABO Bulk Request Explode Service", "externalDocs": { "description": "Find Out More", "url": "" } }, { "name": "service/nextSet/describe", "description": "Catalogging of nextSet", "externalDocs": { "description": "Find Out More", "url": "" } } ], "paths": { "/service/ABO Bulk Request Explode Service/describe": { "get": { "tags": [ "service/ABO Bulk Request Explode Service/describe" ], "summary": "", "description": "", "operationId": "service/ABO Bulk Request Explode Service/describe", "produces": [ "application/xml", "application/json" ], "responses": { "200": {"description": "Successful Operation"}, "204": {"description": "No Resource Found"}, "404": {"description": "There is no data for the requested resource"}, "500": {"description": "Internal Server Error"} }, "parameters": [], "security": [ { "Basic Auth": [], "OAuth 2.0": [] } ] } }, "/service/describe?PageSize=10&StartRowNum=10": { "get": { "tags": [ "service/nextSet/describe" ], "summary": "", "description": "", "operationId": "service/nextSet/describe", "produces": [ "application/xml", "application/json" ], "responses": { "200": {"description": "Successful Operation"}, "204": {"description": "No Resource Found"}, "404": {"description": "There is no data for the requested resource"}, "500": {"description": "Internal Server Error"} }, "parameters": [], "security": [ { "Basic Auth": [], "OAuth 2.0": [] } ] } } } }
|