executeExport
post
/ccadmin/v1/exportProcess
Execute Export. Initiate export execution
Request
Supported Media Types
- application/json
Root Schema : executeExport_request
Type:
Show Source
object
-
fileName(optional):
string
The file name to export into.
-
format(optional):
string
Export format. Should be configured only for standalone mode.
-
id(optional):
string
Export operation id. Should be configured only for standalone mode.
-
items(optional):
array items
List of export operation objects.
-
mode(optional):
string
Export execution mode. Valid values are standalone and bundle.
Example:
{
"mode":"bundle",
"fileName":"exportProfilesAndOrders.zip",
"items":[
{
"format":"csv",
"headersList":"shippingAddress.firstName,shippingAddress.lastName",
"id":"Profiles"
},
{
"q":"id co \"o7613307\"",
"prettyPrintJSON":true,
"format":"json",
"id":"Orders"
}
]
}
Nested Schema : items
Type:
Show Source
object
-
format(optional):
string
Export format
-
id(optional):
string
Export operation id
-
params(optional):
object params
Export parameters.
Nested Schema : params
Type:
object
Export parameters.
Show Source
-
exportFromRepository(optional):
string
Allowed Values:
[ "publishing" ]
Controls export of non-published data. Only published data is exported by default. -
headersList(optional):
string
A comma delimited list of export data attributes to be included in export csv file. If the value is the word "ALL", all attributes will be included. If the list starts with the plus sign, default attributes along with the given attributes will be included
-
prettyPrintJSON(optional):
boolean
Controls pretty printing of data exported in json format. Formatting is disabled by default.
-
q(optional):
string
Query string that filters the access rights to be returned from this request using SCIM filtering syntax.
Response
Supported Media Types
- application/json
202 Response
Following model is returned when operation succeeds.
Root Schema : executeExport_response
Type:
Show Source
object
-
processId(optional):
string
Token corresponding to the export process.
-
status(optional):
string
Status flag indicating whether export process was initiated.
Example Response (application/json)
{
"processId":"N2ECA3RrG1jLYZjN4Q6XTNrkjc_10000",
"links":[
{
"rel":"self",
"href":"http://example.com:9080/ccadminui/v1/exportProcess"
}
],
"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