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 Child Repository Objects and Catalog URLs for Grand Child 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 metadata for child repository objects and grand child catalog URLs from the Siebel CRM Server:

  • URI: http://ServerName:port/siebel/v1.0/workspace/main/Applet/{key}/Control/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": {
    "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":{}
}

Siebel REST API Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.