1. REST API Guide
  2. Using the Describe Parameter to Return the OpenAPI Specification of a Business Service Method

Using the Describe Parameter to Return the OpenAPI Specification of a Business Service Method

You can use the describe parameter to retrieve the OpenAPI specification of a business service method, as shown in the following request:

  • URI: http://ServerName:port/siebel/v1.0/service/Siebel Account/QueryById/describe

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Request body: None

Here are the response details for a successful request:

  • HTTP Code: 200

  • Content-Type: application/json

  • Response body: The response body contains the OpenAPI specification of the business service method, all its input and output arguments, and its integration objects, if applicable.