REST API for Oracle Commerce Cloud 22A

executeExport

post

/ccadmin/v1/exportProcess

Execute Export. Initiate export execution

Request

Supported Media Types

application/json

Root Schema : executeExport_request

Type: object

Show Source

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.

{
    "properties":{
        "mode":{
            "description":"Export execution mode. Valid values are standalone and bundle.",
            "type":"string"
        },
        "fileName":{
            "description":"The file name to export into.",
            "type":"string"
        },
        "format":{
            "description":"Export format. Should be configured only for standalone mode.",
            "type":"string"
        },
        "id":{
            "description":"Export operation id. Should be configured only for standalone mode.",
            "type":"string"
        },
        "items":{
            "description":"List of export operation objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "format":{
                        "description":"Export format",
                        "type":"string"
                    },
                    "id":{
                        "description":"Export operation id",
                        "type":"string"
                    },
                    "params":{
                        "description":"Export parameters.",
                        "type":"object",
                        "properties":{
                            "q":{
                                "description":"Query string that filters the access rights to be returned from this request using SCIM filtering syntax.",
                                "type":"string"
                            },
                            "prettyPrintJSON":{
                                "description":"Controls pretty printing of data exported in json format. Formatting is disabled by default.",
                                "type":"boolean"
                            },
                            "headersList":{
                                "description":"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",
                                "type":"string"
                            },
                            "exportFromRepository":{
                                "description":"Controls export of non-published data. Only published data is exported by default.",
                                "type":"string",
                                "enum":[
                                    "publishing"
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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: array

List of export operation objects.

Show Source

Array of: object items

{
    "description":"List of export operation objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "format":{
                "description":"Export format",
                "type":"string"
            },
            "id":{
                "description":"Export operation id",
                "type":"string"
            },
            "params":{
                "description":"Export parameters.",
                "type":"object",
                "properties":{
                    "q":{
                        "description":"Query string that filters the access rights to be returned from this request using SCIM filtering syntax.",
                        "type":"string"
                    },
                    "prettyPrintJSON":{
                        "description":"Controls pretty printing of data exported in json format. Formatting is disabled by default.",
                        "type":"boolean"
                    },
                    "headersList":{
                        "description":"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",
                        "type":"string"
                    },
                    "exportFromRepository":{
                        "description":"Controls export of non-published data. Only published data is exported by default.",
                        "type":"string",
                        "enum":[
                            "publishing"
                        ]
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

format(optional): string

Export format
id(optional): string

Export operation id
params(optional): object params

Export parameters.

{
    "type":"object",
    "properties":{
        "format":{
            "description":"Export format",
            "type":"string"
        },
        "id":{
            "description":"Export operation id",
            "type":"string"
        },
        "params":{
            "description":"Export parameters.",
            "type":"object",
            "properties":{
                "q":{
                    "description":"Query string that filters the access rights to be returned from this request using SCIM filtering syntax.",
                    "type":"string"
                },
                "prettyPrintJSON":{
                    "description":"Controls pretty printing of data exported in json format. Formatting is disabled by default.",
                    "type":"boolean"
                },
                "headersList":{
                    "description":"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",
                    "type":"string"
                },
                "exportFromRepository":{
                    "description":"Controls export of non-published data. Only published data is exported by default.",
                    "type":"string",
                    "enum":[
                        "publishing"
                    ]
                }
            }
        }
    }
}

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.

{
    "description":"Export parameters.",
    "type":"object",
    "properties":{
        "q":{
            "description":"Query string that filters the access rights to be returned from this request using SCIM filtering syntax.",
            "type":"string"
        },
        "prettyPrintJSON":{
            "description":"Controls pretty printing of data exported in json format. Formatting is disabled by default.",
            "type":"boolean"
        },
        "headersList":{
            "description":"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",
            "type":"string"
        },
        "exportFromRepository":{
            "description":"Controls export of non-published data. Only published data is exported by default.",
            "type":"string",
            "enum":[
                "publishing"
            ]
        }
    }
}

Response

Supported Media Types

application/json

202 Response

Following model is returned when operation succeeds.

Root Schema : executeExport_response

Type: object

Show Source

processId(optional): string

Token corresponding to the export process.
status(optional): string

Status flag indicating whether export process was initiated.

{
    "properties":{
        "processId":{
            "description":"Token corresponding to the export process.",
            "type":"string"
        },
        "status":{
            "description":"Status flag indicating whether export process was initiated.",
            "type":"string"
        }
    }
}

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: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}