Using the Describe Parameter to Return a Catalog of Paths for All Available Business Services
You can use the OpenAPI describe parameter to retrieve path to all available Business Services exposed over REST by appending it to a HTTP GET request.
The following request uses the describe parameter to return a catalog of URLs for all available Business Services from the Siebel CRM Server in OpenAPI 2.0 format:
URI: http://ServerName:port/siebel/v1.0/service/describe?openapiversion=2
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request body:
Here are the response details for a successful request:
HTTP Code: 200
Content-Type: application/json
- Response body:
{ "swagger": "2.0", //Existing Swagger specification version "info": { //Metadata about API }, "schemes": [ "http", "https" ], "securityDefinitions": { //information about the authorization schemes "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": { //links "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": { //links "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": [] } ] } } } }
The following request uses the describe parameter to return a catalog of URLs for all available Business Services from the Siebel CRM Server in OpenAPI 3.0 format:
-
URI: http://ServerName:port/siebel/v1.0/service/describe
-
HTTP Method: GET
-
Content-Type: application/json
-
Authorization: Basic
-
Request body:
Here are the response details for a successful request:
-
HTTP Code: 200
-
Content-Type: application/json
-
Response body:
{
"openapi": "3.0.1",
"info": {
"version": "1.0"
},
"externalDocs": {
"description": "OpenAPI",
"url": "https://openapis.org"
},
"servers": [{
"url": "http://host:port/siebel/v1.0"
},
{
"url": "http://host:port/siebel/v1.0"
}
],
"tags": [{
"name": "service/04-EQ1Y1/describe"
},
{
"name": "service/ABO Bulk Request Explode Service/describe"
}
],
"paths": {
"/service/04-EQ1Y1/describe": {
"get": {
"tags": [
"service/04-EQ1Y1/describe"
],
"operationId": "service/04-EQ1Y1/describe",
"parameters": [{
"name": "openapiversion",
"in": "query",
"schema": {
"type": "string",
"default": "3.0"
}
}],
"responses": {
"200": {
"description": "Successful Operation",
"content": {}
},
"204": {
"description": "No Resource Found",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Access Forbidden",
"content": {}
},
"404": {
"description": "There is no data for the requested resource",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [{
"basicAuth": [],
"oAuth2.0": []
}]
}
},
"/service/ABO Bulk Request Explode Service/describe": {
"get": {
"tags": [
"service/ABO Bulk Request Explode Service/describe"
],
"operationId": "service/ABO_Bulk_Request_Explode_Service/describe",
"parameters": [{
"name": "openapiversion",
"in": "query",
"schema": {
"type": "string",
"default": "3.0"
}
}],
"responses": {
"200": {
"description": "Successful Operation",
"content": {}
},
"204": {
"description": "No Resource Found",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Access Forbidden",
"content": {}
},
"404": {
"description": "There is no data for the requested resource",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [{
"basicAuth": [],
"oAuth2.0": []
}]
}
},
"/service/describe?PageSize=10&StartRowNum=10": {
"get": {
"tags": [
"service/nextSet/describe"
],
"operationId": "service/nextSet/describe",
"parameters": [{
"name": "openapiversion",
"in": "query",
"schema": {
"type": "string",
"default": "3.0"
}
}],
"responses": {
"200": {
"description": "Successful Operation",
"content": {}
},
"204": {
"description": "No Resource Found",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Access Forbidden",
"content": {}
},
"404": {
"description": "There is no data for the requested resource",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [{
"basicAuth": [],
"oAuth2.0": []
}]
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
},
"oAuth2.0": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "http://openAPI.io/",
"scopes": {
"write:": "modify",
"read:": "read only"
}
}
}
}
}
},
"x-original-swagger-version": "2.0"
}