Querying for Child Repository Object MetaData

You can query for child repository objects metadata, such as required fields, properties of each field, catalog URLs for grandchildren, response format, and so on, by appending the describe parameter to the object name.

The following request queries for metadata belonging to the child of the applet repository object called Control.

• URI: http://ServerName:port/siebel/v1.0/workspace/MAIN/Applet/{key}/Control/describe

• HTTP Method: GET

• Content-Type: application/json

• Authorization: Basic

• Request body: None

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": {
    "workspace_MAIN_Applet_{key}_Control_": {
      "type": "object",
      "required": [
        "Name",
        "Type",
        "Show Popup",
        "HTML Row Sensitive",
        "Parent Id",
        "HTML Default Control"
        ],
      "properties": {
        "ActiveX Bind Property": {
        "maxLength": 75,
        "x-siebel-precision": "0",
        "type": "string",
        "x-siebel-datatype": "DTYPE_TEXT",
        "x-siebel-scale": "0",
        "title": "ActiveX Bind Property"
       },
    "tags": [],
    "paths":{}
  }