REST API for Oracle Commerce Cloud December 2017

abortExportProcess

post

/ccadmin/v1/exportProcess/{token}/abort

Abort Export Process. Abort an export process.

Supported Media Types

Path Parameters

token: Type: string

Required: true

Token corresponding to the export process.

Body Parameter

Root Schema : abortExportProcess_request

POST /ccadmin/v1/exportProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/abort

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : abortExportProcess_response

success: Type: boolean

Returns true if we pass abort command to export process.


{
    "success":true
}

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:

POST /ccadmin/v1/exportProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/abort

Sample Response Payload returned by endpoint:

{"success": true}