Using the Describe Parameter to Return a Catalog of Repository Objects

You can query for a catalog of top level repository objects in a given workspace by sending a HTTP GET request with the describe parameter appended.

The following query requests a catalog of all top level repository objects, paths to retrieve definitions or catalog of each object, various responses to the request with HTTP codes, and so on in OpenAPI 2.0 format.

• URI: http://ServerName:port/siebel/v1.0/workspace/MAIN/describe?openapiversion=2

• 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": 
    [
      "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": "Cataloging of Applet",
      "externalDocs": 
      {
        "description": "Find Out More",
        "url": ""
      }
    },
    {
      "name": "workspace/MAIN/Application/describe",
      "description": "Cataloging 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": []
    }
    ]
    }
   }
  }

The following query requests a catalog of all top level repository objects, paths to retrieve definitions or catalog of each object, various responses to the request with HTTP codes, and so on in OpenAPI 3.0 format.

• URI: http://ServerName:port/siebel/v1.0/workspace/MAIN/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:

{
    "openapi": "3.0.1",
    "info": {
        "version": "1.0"
    },
    "externalDocs": {
        "description": "OpenAPI",
        "url": "https://openapis.org"
    },
    "servers": [
        {
            "url": "https://host:port number/siebel/v1.0"
        }
    ],
    "tags": [
        {
            "name": "workspace/MAIN/Applet/describe"
        }],
    "paths": {
        "/workspace/MAIN/Applet/describe": {
            "get": {
                "tags": [
                    "workspace/MAIN/Applet/describe"
                ],
                "operationId": "workspace/MAIN/Applet/describe",
                "parameters": [
                    {
                        "name": "openapiversion",
                        "in": "query",
                        "schema": {
                            "type": "string",
                            "default": "3.0"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful Operation",
                        "content": {}
                    },
                    "204": {
                        "description": "No Resource Found",
                        "content": {}
                    },
                    "401": {
                        "description": "Unauthorized",
                        "content": {}
                    },
                    "404": {
                        "description": "There is no data for the requested resource",
                        "content": {}
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "content": {}
                    }
                },
                "security": [
                    {
                        "basicAuth": [],
                        "oAuth2.0": []
                    }
                ]
            }
        }
    "components": {
        "securitySchemes": {
            "basicAuth": {
                "type": "http",
                "scheme": "basic"
            },
            "oAuth2.0": {
                "type": "oauth2",
                "flows": {
                    "implicit": {
                        "authorizationUrl": "http://openAPI.io/",
                        "scopes": {
                            "write:": "modify",
                            "read:": "read only"
                        }
                    }
                }
            }
        }
    },
    "x-original-swagger-version": "2.0"
}