Siebel REST API Guide > Using the Siebel REST API > Using Siebel REST API to Access Siebel Business Objects JSON Examples >

Using the Describe Parameter to Return the Business Object Catalog of a Parent Business Component


You can use the OpenAPI Describe parameter by appending Describe to an HTTP GET request to the resource's URI.

The following details are for a Describe request to return the Business Object Catalog of a parent Business Component from the Siebel CRM Server:

  • URI: http://ServerName:port/siebel/v1.0/data/Account/Account/describe
  • HTTP Method: GET
  • Content-Type: application/json
  • Authorization: Basic
  • Request body:

The following are the details for the response to 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":[]
          }
        ]
     }
   }
  }
}

Siebel REST API Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.