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 Metadata for a Parent Business Component and Catalog of Child Business Components

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 Metadata for a parent Business Component and catalog of Child Business Components from the Siebel CRM Server:

• URI: http://ServerName:port/siebel/v1.0/data/Account/Account/1-6/Contact/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_{key}_Contact_":{
        "type":"object",
        "required":[],
        "properties":[],
        "tags":[
         {
          "name":"data/Account/Account/{key}/Contact/",
          "description":"Operations available on data/Account/Account/{key}/Contact/",
          "externalDocs":{
            "description":"Find Out More",
            "url":""
            }
         },
         "paths":{
          "/data/Account/Account/{key}/Contact/":{
            "get":{
              "tags":[
                 "data_Account_Account_{key}_Contact_"
                  ],
              "summary":"",
              "description":"",
              "operationId":"data_Account_Account_{key}_Contact_/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":[]
                }
                ]
            },
            "post":{
              "tags":[
                "data_Account_Account_{key}_Contact_"
              ],
              "summary":"",
              "description":"",
              "operationId":"data_Account_Account_{key}_Contact_/post",
              "produces":[
                "application/xml",
                "application/json"
                ],
              "consumes":[
                "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":[
              {
                "in":"body",
                "name":"body",
                "description":"",
                "required":true,
                "schema":{
                "$ref":"#/definitions/data_Account_Account_{key}_Contact_"
              }
              }
              ],
              "security":[
              {
                "Basic Auth":[],
                "OAuth 2.0":[]
              }
              ]
            }
         }
    }
}