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

Using Describe to Return the Siebel Base Business Object Catalog

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 Siebel Base Business Object from the the Siebel CRM Server:

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

{
   "swagger":"2.0",
   "info":{
      "description":"Siebel REST API",
      "version":"1.0",
      "title":"Siebel REST API",
      "contact":{
        "email":"sample@sample.com"
      }
   },
   "schemes":[
      "http",
      "https"
   ],
   "securityDefinitions":{
      "Basic Auth":{
        "type":"basic"
   },
      "OAuth 2.0":{
        "type":"oauth2",
       "authorizationUrl":"http://openAPI.io/",
       "flow":"implicit",
       "scopes":{
          "write:":"modify",
          "read:":"read only"
          }
        }
      },
   "externalDocs":{
      "description":"OpenAPI",
      "url":"https://openapis.org"
      },
   "host": "host:port number",
   "basePath":"/siebel/v1.0",
   "tags":[
   {
      "name":"data/Account/describe",
      "description":"Catalogging of Account",
      "externalDocs":{
        "description":"Find Out More",
        "url":""
        }
     },
     {
      "name":"data/Service Request/describe",
      "description":"Catalogging of Service Request",
      "externalDocs":{
        "description":"Find Out More",
        "url":""
        }
      },
      "paths":{
        "/data/Account/describe":{
          "get":{
            "tags":[
               "data/Account/describe"
                ],
            "summary":"",
            "description":"",
            "operationId":"data/Account/describe",
            "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":[
            ],
            "security":[
            {
              "Basic Auth":[],
              "OAuth 2.0":[]
              }
            ]
            }
          },
        "/data/Service Request/describe":{
          "get":{
            "tags":[
              "data/Service Request/describe"
              ],
            "summary":"",
            "description":"",
            "operationId":"data/Service Request/describe",
            "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":[],
            "security":[
            {
              "Basic Auth":[],
              "OAuth 2.0":[]
            }
            ]
            },
          "post":{
            "tags":[
              "data_Account_Account_"
               ],
            "summary":"",
            "description":"",
            "operationId":"data_Account_Account_/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_"
            }
            }
            ],
            "security":[
              {
              "Basic Auth":[],
              "OAuth 2.0":[]
              }
            ]
          }
        }
      }
}