1. REST API Guide
  2. Using the Describe Parameter to Return OpenAPI Description of Multiple Object Operations

Using the Describe Parameter to Return OpenAPI Description of Multiple Object Operations

The OpenAPI resource, describe, is used to retrieve Business Component metadata. You can retrieve information on multiple object operations Siebel CRM business component API Doc by sending a single HTTP GET request to the resource's URI.

The following request retrieves the details of multiple object operations for Account APIs SWAGGER documentation.
Note: In this example, the query parameter describemultiobject=y indicates that the user is requesting an OpenAPI description for multiple object REST API.

  • URI: http://ServerName:port/siebel/v1.0/data/Account/Account/describe?describemultiobject=y

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Response body: This returns a description in OpenAPI (SWAGGER) format.