Querying for Repository Resource Metadata

You can query for the description of any repository object by appending the describe parameter to the object name. The response lists all the fields, paths for child objects, various responses with HTTP codes, and so on.

The following request returns applet repository object metadata using the describe parameter:

• URI: http://ServerName:port/siebel/v1.0/workspace/MAIN/Applet/describe

• HTTP Method: GET

• Content-Type: application/json

• Authorization: Basic

• Request body:

Here are the response details for a successful request:

• HTTP Code: 200

• Content-Type: application/json

• 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": []
    }
    ]
    }
    }
   }
  }