getEndpointAPI
get
/ccadmin/v1/api/{id}
Get Endpoint API. Get detailed API doc info for an endpoint by ID. Deprecated
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the endpoint.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getEndpointAPI_response
Type:
Show Source
object
-
Endpoint Name(optional):
object Endpoint Name
Response object.
Nested Schema : Endpoint Name
Type:
object
Response object.
Show Source
-
description(optional):
string
Description about the endpoint.
-
pathParams(optional):
object pathParams
Path parameters of the sample request.
-
request(optional):
object request
Request parameters to trigger the endpoint.
-
response(optional):
object response
Response parameters to trigger the endpoints.
-
sampleRequest(optional):
object sampleRequest
Sample request object to trigger the endpoint.
-
sampleResponse(optional):
object sampleResponse
Sample resonse object after triggering the endpoint.
Nested Schema : pathParams
Type:
object
Path parameters of the sample request.
Nested Schema : request
Type:
object
Request parameters to trigger the endpoint.
Nested Schema : response
Type:
object
Response parameters to trigger the endpoints.
Nested Schema : sampleRequest
Type:
object
Sample request object to trigger the endpoint.
Nested Schema : sampleResponse
Type:
object
Sample resonse object after triggering the endpoint.
Example Response (application/json)
{
"pathParams":{
"timeZoneOffset":[
"string",
true,
"offset in minutes between the client time zone and UTC time"
],
"type":[
"string",
true,
"one of Product, Collection or Variant, indicating the type of asset that should be exported"
]
},
"description":"export catalog assets as an xls file. There is no json response for this request. The browser will download the xls file directly from the server.",
"sampleRequest":"GET /ccadmin/v1/asset/export?type=Product&timeZoneOffset=-420"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
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(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code