REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

The ID of the endpoint.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getEndpointAPI_response

Properties

Endpoint Name: Type: object Endpoint Name

Additional Properties Allowed:

Response object.

Nested Schema : Endpoint Name

Type: object

Response object.

Properties

description: Type: string

Description about the endpoint.
pathParams: Type: object pathParams

Additional Properties Allowed:

Path parameters of the sample request.
request: Type: object request

Additional Properties Allowed:

Request parameters to trigger the endpoint.
response: Type: object response

Additional Properties Allowed:

Response parameters to trigger the endpoints.
sampleRequest: Type: object sampleRequest

Additional Properties Allowed:

Sample request object to trigger the endpoint.
sampleResponse: Type: object sampleResponse

Additional Properties Allowed:

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 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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"
}