getEndpointAPIs

get

/ccagent/v1/api

Get Endpoint APIs. Get the endpoint API doc info. Deprecated

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getEndpointAPIs_response
Type: object
Show Source
Nested Schema : Endpoint Service
Type: object
Object of endpoint service.
Show Source
Nested Schema : endpoints
Type: object
Object of Oauth Agent endpoint.
Show Source
Example Response (application/json)
{
    "Orders":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getOrder",
                "url":"/ccagent/v1/orders/{id}",
                "httpsRequired":false
            }
        ],
        "description":"Order endpoints"
    },
    "Profiles":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":false,
                "id":"getProfile",
                "url":"/ccagent/v1/profiles/{id}",
                "httpsRequired":false
            }
        ],
        "description":"Profile endpoints"
    }
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top