Siebel REST API Guide > Using the Siebel REST API > Using Siebel REST API to Access Siebel Repository Resources JSON Examples >

Using the Describe Parameter to Return Top-Level Repository Objects

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 top-level repository objects from the Siebel CRM Server:

• URI: http://ServerName:port/siebel/v1.0/workspace/main/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": {
   },
   "schemes": [
     "http",
     "https"
   ],
   "securityDefinitions": {
     "Basic Auth": {
     "type": "basic"
     }
   },
   "externalDocs": {
     "description": "OpenAPI",
     "url": "https://openapis.org"
     },
   "host": "host:port number",
   "basePath": "/siebel/v1.0",
   "tags": [
   {
     "name": "workspace/main/Applet/describe",
     "description": "Catalogging of Applet",
     "externalDocs": {
       "description": "Find Out More",
       "url": ""
     }
   },
   {
     "name": "workspace/main/Application/describe",
     "description": "Catalogging of Application",
     "externalDocs": {
       "description": "Find Out More",
       "url": ""
     }
   }
   ],
   "paths": {
     "/workspace/main/Applet/describe": {
       "get": {
         "tags": [
           "workspace/main/Applet/describe"
           ],
         "summary": "",
         "description": "",
         "operationId": "workspace/main/Applet/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": []
         }
         ]
       }
     }
   }
}