REST API for Oracle Commerce Cloud December 2017

getExportProcess

get

/ccadmin/v1/exportProcess/{token}

Get Export Process. Get the status resource of an export process.

Request

Supported Media Types

application/json

Path Parameters

token: Type: string

Required: true

Token corresponding to the export process.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getExportProcess_response

Properties

completed: Type: boolean

Flag indicating whether process is completed or not.
endTime: Type: string

Time when the process finished.
error: Type: object error

Additional Properties Allowed:

Error detail of the original request.
progress: Type: string

Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

The current progress of the process.
requestStatus: Type: integer

HTTP status code of the original request.
startTime: Type: string

Time when the process started.

Nested Schema : error

Type: object

Error detail of the original request.

Properties

detail: Type: string

Description of the problem.
title: Type: string

Short summary of the problem.
type: Type: string

Absolute URI that identifies the problem type.

Example application/json


{
    "progress":"succeeded",
    "startTime":"2016-04-04T20:25:01.982Z",
    "links":[
        {
            "rel":"meta",
            "href":"http://BUSGTEST:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportStatus.zip"
        },
        {
            "rel":"file",
            "href":"http://BUSGTEST:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportProfilesAndOrders.zip"
        },
        {
            "rel":"self",
            "href":"http://BUSGTEST:9080/ccadminui/v1/exportProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000"
        }
    ],
    "endTime":"2016-04-04T20:25:02.190Z",
    "completed":true,
    "requestStatus":200
}

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:

{
  "progress": "succeeded",
  "startTime": "2016-04-04T20:25:01.982Z",
  "links": [
    {
      "rel": "meta",
      "href": "http://BUSGTEST:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportStatus.zip"
    },
    {
      "rel": "file",
      "href": "http://BUSGTEST:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportProfilesAndOrders.zip"
    },
    {
      "rel": "self",
      "href": "http://BUSGTEST:9080/ccadminui/v1/exportProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000"
    }
  ],
  "endTime": "2016-04-04T20:25:02.190Z",
  "completed": true,
  "requestStatus": 200
}