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 TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getEndpointAPIs_response
Type:
Show Source
object
-
Endpoint Service:
object Endpoint Service
Object of endpoint service.
Nested Schema : Endpoint Service
Type:
object
Object of endpoint service.
Show Source
-
description:
string
Description of service.
-
endpoints:
object endpoints
Object of Oauth Agent endpoint.
Nested Schema : endpoints
Type:
object
Object of Oauth Agent endpoint.
Show Source
-
authRequired:
boolean
Whether authentication is required or not.
-
hasDoc:
boolean
Whether endpoint has the doc or not. Deprecated
-
httpsRequired:
boolean
Whether https is required or not.
-
id:
string
ID of endpoint.
-
method:
string
Method of the service.
-
requestType:
string
Tyep of request, for e.g. application/json.
-
responseType:
string
Type of response, for e.g. application/json.
-
url:
string
url to trigger the endpoint.
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
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code