REST API for Oracle Commerce Cloud December 2017

executeExport

post

/ccadmin/v1/exportProcess

Execute Export. Initiate export execution

Request

Supported Media Types

application/json

Body Parameter

Root Schema : executeExport_request

Example


{
    "fileName":"exportProfilesAndOrders.zip",
    "items":[
        {
            "format":"xml",
            "id":"profile001"
        },
        {
            "format":"json",
            "id":"order001"
        }
    ]
}

Properties

fileName: Type: string

The file name to export into.
format: Type: string

Export format. Should be configured only for standalone mode.
id: Type: string

Export operation id. Should be configured only for standalone mode.
items: Type: array items

Additional Properties Allowed:

List of export operation objects.
mode: Type: string

Export execution mode. Valid values are standalone and bundle.

Nested Schema : items

Type: array

List of export operation objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

format: Type: string

Export format
id: Type: string

Export operation id

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : executeExport_response

Properties

processId: Type: string

Token corresponding to the export process.
status: Type: string

Status flag indicating whether export process was initiated.

Example application/json


{
    "processId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000",
    "status":"submitted"
}

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

{
  "fileName": "exportProfilesAndOrders.zip",
  "items": [
    {
      "format": "xml",
      "id": "profile001"
    },
    {
      "format": "json",
      "id": "order001"
    }
  ]
}

Sample Response Payload returned by endpoint:

{
  "processId": "N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000",
  "status": "submitted"
}