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

Using Describe to Return Metadata for a Repository Object and Children Catalog URLs

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 repository object and children catalog URLs from the Siebel CRM Server:

• URI: http://ServerName:port/siebel/v1.0/workspace/main/Applet/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": [],
   "securityDefinitions": {},
   "externalDocs": {},
   "host": "host:port number",
   "basePath": "/siebel/v1.0",
   "definitions": {},
   "tags": [],
   "paths": {
     "/workspace/main/Applet/{key}/Applet Browser Script/describe": {
      "get": {
        "tags": [
          "workspace/main/Applet/{key}/Applet Browser Script/describe"
          ],
        "summary": "",
        "description": "",
        "operationId": "workspace/main/Applet/{key}/Applet Browser Script/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": [
         {
          "name": "key",
          "in": "path",
          "description": "",
          "required": true,
          "default": "key",
          "type": "string"
          }
          ],
        "security": [
        {
          "Basic Auth": [],
          "OAuth 2.0": []
        }
        ]
      }
    }
  }
}