Using the Describe Parameter to Return Methods of a Business Service

You can use the OpenAPI describe parameter to access catalog of available methods of a Business Service by appending it to a HTTP GET request to the resource's URI.

The following request uses the describe parameter to return methods of Siebel Account Business Service URI in OpenAPI 2.0 format:

URI: http://ServerName:port/siebel/v1.0/service/Siebel Account/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": [],
    "securityDefinitions": {},
    "externalDocs": {},
    "host": "host:port number",
    "basePath": "/siebel/v1.0",

    "definitions": {},

    "tags": [],

    "paths": {

        "/service/Siebel Account/Delete/describe": {

            "get": {

                "tags": [

                    "service/Siebel Account/Delete/describe"

                ],

                "summary": "",

                "description": "",

                "operationId": "service/Siebel Account/Delete/describe",

                "produces": [                   

                ],

                "responses": {                

                },

                "parameters": [],                    

                "security": [                

                ]

            }

        },

        "/service/Siebel Account/Insert/describe": {

        },

        "/service/Siebel Account/InsertOrUpdate/describe": {

        },

        "/service/Siebel Account/QueryByExample/describe": {

        },  

        "/service/Siebel Account/QueryById/describe": {

        }, 

        "/service/Siebel Account/Synchronize/describe": {

        }, 

        "/service/Siebel Account/Update/describe": {

        }

    }

}

The following request uses the describe parameter to return methods of Siebel Account Business Service URI in OpenAPI 3.0 format:

URI: http://ServerName:port/siebel/v1.0/service/Siebel Account/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": [],
    "tags": [
    ],
    "paths": {
        "/service/Siebel Account/Delete/describe": {
            "get": {
                "tags": [
                    "service/Siebel Account/Delete/describe"
                ],
                "operationId": "service/Siebel_Account/Delete/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": {}
                    },
                    "403": {
                        "description": "Access Forbidden",
                        "content": {}
                    },
                    "404": {
                        "description": "There is no data for the requested resource",
                        "content": {}
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "content": {}
                    }
                },
                "security": [{
                    "basicAuth": [],
                    "oAuth2.0": []
                }]
            }
        }
    },
    "/service/Siebel Account/Insert/describe": {
    },
    "/service/Siebel Account/InsertOrUpdate/describe": {
    },
    "/service/Siebel Account/QueryByExample/describe": {
    },
    "/service/Siebel Account/QueryById/describe": {
    },
    "/service/Siebel Account/Synchronize/describe": {
    },
    "/service/Siebel Account/Update/describe": {
    }
}