abortImportProcess
post
/ccadmin/v1/importProcess/{token}/abort
Abort Import Process. Abort an import process.
Request
Supported Media Types
- application/json
Path Parameters
- token
-
Type:
string
Required:true
Token corresponding to the import process.
Body Parameter
Root Schema : abortImportProcess_request
POST /ccadmin/v1/importProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/abort
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : abortImportProcess_response
- success
-
Type:
boolean
Returns true if we pass abort command to import process.
Example application/json
{
"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
errorsAdditional 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
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
Examples
Sample Request:
POST /ccadmin/v1/importProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/abort
Sample Response Payload returned by endpoint:
{"success": true}