REST API for Oracle Commerce Cloud December 2017

executeImport

post

/ccadmin/v1/importProcess

Execute Import. Initiate import execution

Supported Media Types

Body Parameter

Root Schema : executeImport_request


{
    "fileName":"exportProfilesAndOrders.zip"
}

fileName: Type: string

Required: true

The file name to import.
format: Type: string

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

Import operation id. Should be configured only for standalone mode.
mode: Type: string

Import execution mode. Valid values are standalone and bundle.

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : executeImport_response

processId: Type: string

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

Status flag indicating whether import process was initiated.


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

Default Response

The error response

Body

Root Schema : errorModel

Type: object

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

Nested Schema : items

Type: object

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

Sample Request:

{"fileName": "exportProfilesAndOrders.zip"}

Sample Response Payload returned by endpoint:

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