|
Siebel REST API Guide > Overview of Using the Siebel REST API >
About Getting the Siebel REST API Specification in the OpenAPI 2.0 Standard Using Describe
Siebel REST APIs use the OpenAPI Specification (formerly the Swagger Specification) to define formats for REST requests and responses to the Siebel REST API servers. You can use the OpenAPI Specification Describe URI parameter to provide addition metadata information in the REST API response and request. The describe parameter returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition. The describe parameter allows you to discover additional metadata on the following:
- Siebel Business Objects. The Siebel Business Objects catalog contains a list of all Business Objects exposed as Base Integration Objects. The following is an example of a Siebel Business Objects URL request with a describe parameter:
host-name/siebel/v1.0/data/describe
- Siebel Business Services. The Siebel Business Services catalog contains list of all Siebel Business Service names, methods defined for business services, and links to each business service. The following is an example of a Siebel Business Services URL request with a describe parameter:
host-name/siebel/v1.0/service/describe
- Siebel Repository Objects. The Siebel Repository Objects catalog contains lists of all repository types and catalog links to their children. The following is an example of a Siebel Repository Objects URL request with a describe parameter:
host-name/siebel/v1.0/workspace/main/describe
In the response, pagination is implemented for a list of Business Objects, a list of Repository Objects, and a list of Business Services but not for the associated children. Table 8 contains the OpenAPI Objects supported by the Siebel REST API.
Table 8. OpenAPI Objects supported by the Siebel REST API
|
|
swagger |
Required. Specifies the Swagger Specification version being used. |
info |
Required. Provides metadata about the API. |
schemes object |
The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself. |
securityDefinitions |
Security scheme definitions that can be used across the specification. |
externalDocs |
Additional external documentation. |
host |
The host (name or ip) serving the API. This must be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating. |
basePath |
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. |
definitions |
An object to hold data types produced and consumed by operations. |
tags |
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared may be organized randomly or based on the tools' logic. Each tag name in the list must be unique. |
paths |
Required. The available paths and operations for the REST API. |
security |
A declaration of which security schemes are applied for the API as a whole. |
parameters |
A list of the parameters for the endpoint. |
responses |
A lists of the responses from the REST API request. |
|
