REST API for Oracle Commerce Cloud December 2017

listExportOperations

get

/ccadmin/v1/exportOperations

List Export Operations. Retrieves all export operations

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listExportOperations_response

Properties

items: Type: array items

Additional Properties Allowed:

List of all export operation objects.

Nested Schema : items

Type: array

List of all export operation objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

formatNames: Type: array formatNames

Additional Properties Allowed:

Export data format names
formats: Type: array formats

Additional Properties Allowed:

Export data formats
id: Type: string

Export operation id
typeId: Type: string

Export data type
typeName: Type: string

Export data type name

Nested Schema : formatNames

Type: array

Export data format names

Items

Type: string

Nested Schema : formats

Type: array

Export data formats

Items

Type: string

Example application/json


{
    "items":[
        {
            "formats":[
                "json",
                "csv"
            ],
            "typeName":"Profiles",
            "formatNames":[
                "JSON Format",
                "CSV Format"
            ],
            "typeId":"Profiles",
            "id":"Profiles"
        },
        {
            "formats":[
                "json",
                "csv"
            ],
            "typeName":"Accounts",
            "formatNames":[
                "JSON Format",
                "CSV Format"
            ],
            "typeId":"Accounts",
            "id":"Accounts"
        }
    ]
}

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:

{"items": [
  {
    "formats": [
      "json",
      "csv"
    ],
    "typeName": "Profiles",
    "formatNames": [
      "JSON Format",
      "CSV Format"
    ],
    "typeId": "Profiles",
    "id": "Profiles"
  },
  {
    "formats": [
      "json",
      "csv"
    ],
    "typeName": "Accounts",
    "formatNames": [
      "JSON Format",
      "CSV Format"
    ],
    "typeId": "Accounts",
    "id": "Accounts"
  }
]}