Jump to

• Request
• Response

getEndpointAPI

get

/ccagent/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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getEndpointAPI_response

Type: object

Show Source

• Endpoint Name(optional): object Endpoint Name
  Response object.

{
    "properties":{
        "Endpoint Name":{
            "description":"Response object.",
            "type":"object",
            "properties":{
                "request":{
                    "description":"Request parameters to trigger the endpoint.",
                    "type":"object"
                },
                "pathParams":{
                    "description":"Path parameters of the sample request.",
                    "type":"object"
                },
                "response":{
                    "description":"Response parameters to trigger the endpoints.",
                    "type":"object"
                },
                "description":{
                    "description":"Description about the endpoint.",
                    "type":"string"
                },
                "sampleResponse":{
                    "description":"Sample resonse object after triggering the endpoint.",
                    "type":"object"
                },
                "sampleRequest":{
                    "description":"Sample request object to trigger the endpoint.",
                    "type":"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.

{
    "description":"Response object.",
    "type":"object",
    "properties":{
        "request":{
            "description":"Request parameters to trigger the endpoint.",
            "type":"object"
        },
        "pathParams":{
            "description":"Path parameters of the sample request.",
            "type":"object"
        },
        "response":{
            "description":"Response parameters to trigger the endpoints.",
            "type":"object"
        },
        "description":{
            "description":"Description about the endpoint.",
            "type":"string"
        },
        "sampleResponse":{
            "description":"Sample resonse object after triggering the endpoint.",
            "type":"object"
        },
        "sampleRequest":{
            "description":"Sample request object to trigger the endpoint.",
            "type":"object"
        }
    }
}

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 /ccagent/v1/asset/export?type=Product&timeZoneOffset=-420"
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top