Using the Describe Parameter to Return Business Component Metadata

The OpenAPI resource, describe, is used to retrieve Business Component metadata. The result contains a catalog of fields configured in the Business Component, and it also lists the operations which can be performed on the Business Component, request and response structure, path to catalog of all child Business Components, and so on.

The following request retrieves the metadata description of an Account Business Component using the describe parameter in OpenAPI 2.0 format:

• URI: http://ServerName:port/siebel/v1.0/data/Account/Account/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:

• Response body:

   { 
    "definitions":{
      "data_Account_Account_":{
       "type":"object",
       "required":
       "properties":
       }
    },
    "tags":[
    {
      "name":"data/Account/Account/",
      "description":"Operations available on data/Account/Account/",
      "externalDocs":{
      "description":"Find Out More",
      "url":""
    }
    },
    "paths":{
      "/data/Account/Account/":{
      "get":{
     "tags":[
     "data_Account_Account_"
     ],
    "summary":"",
    "description":"",
    "operationId":"data_Account_Account_/get",
    "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":[
    {
      "name":"key",
      "in":"path",
      "description":"",
      "required":true,
      "type":"string"
    }
    ],
    "security":[
    {
      "Basic Auth":[],
      "OAuth 2.0":[]
    }
    ]
    }  
   }
  }
  }

The following request retrieves the metadata description of an Account Business Component using the describe parameter in OpenAPI 3.0 format:

• URI: http://ServerName:port/siebel/v1.0/data/Account/Account/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:

• Response body:

{
    "openapi": "3.0.1",
    "info": {
        "version": "1.0"
    },
    "externalDocs": {
        "description": "OpenAPI",
        "url": "https://openapis.org"
    },
    "servers": [{
        "url": "https://host:port number/siebel/v1.0"
    }],
    "tags": [{
        "name": "data/Account/Account/"
    }],
    "paths": {
        "/data/Account/Account/": {
            "get": {
                "tags": [
                    "data/Account/Account/"
                ],
                "operationId": "data_Account_Account__get",
                "parameters": [{
                    "name": "childlinks",
                    "in": "query",
                    "schema": {
                        "type": "string"
                    }
                }],
                "responses": {
                    "200": {
                        "description": "Successful Operation",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/data_Account_Account_get_all_response"
                                }
                            },
                            "application/xml": {
                                "schema": {
                                    "$ref": "#/components/schemas/data_Account_Account_get_all_response"
                                }
                            }
                        }
                    },
                    "204": {
                        "description": "No Resource Found",
                        "content": {}
                    },
                    "401": {
                        "description": "Unauthorized",
                        "content": {}
                    },
                    "404": {
                        "description": "There is no data for the requested resource",
                        "content": {}
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "content": {}
                    }
                },
                "security": [{
                    "basicAuth": [],
                    "oAuth2.0": []
                }]
            }
        }
    },
    "components": {
        "schemas": {
            "data_Account_Account_": {
                "required": [],
                "type": "object"
            }
        }
    },
    "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"
}