executeImport
post
/ccadmin/v1/importProcess
Execute Import. Initiate import execution
Request
Supported Media Types
- application/json
Root Schema : executeImport_request
Type:
Show Source
object
-
fileName:
string
The file name to import.
-
format(optional):
string
Import format. Should be configured only for standalone mode.
-
id(optional):
string
Import operation id. Should be configured only for standalone mode.
-
mode(optional):
string
Import execution mode. Valid values are standalone and bundle.
-
params(optional):
object params
Import parameters. Should be configured only for standalone mode.
Example:
{
"fileName":"exportProfilesAndOrders.zip"
}
Nested Schema : params
Type:
object
Import parameters. Should be configured only for standalone mode.
Show Source
-
update(optional):
boolean
Existing records are updated by default. Passing false for the flag forces creation of new records. An error will be thrown if the record to be imported already exists in the repository.
Response
Supported Media Types
- application/json
202 Response
Following model is returned when operation succeeds.
Root Schema : executeImport_response
Type:
Show Source
object
-
processId(optional):
string
Token corresponding to the import process.
-
status(optional):
string
Status flag indicating whether import process was initiated.
Example Response (application/json)
{
"processId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000",
"links":[
{
"rel":"self",
"href":"http://example.com:9080/ccadminui/v1/importProcess"
}
],
"status":"submitted"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code