getEndpointAPI

get

/ccstore/v1/api/{id}

Get Endpoint API. Get detailed API doc info for an endpoint by ID.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getEndpointAPI_response
Type: object
Show Source
Nested Schema : Endpoint Name
Type: object
Response object.
Show Source
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
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