Jump to

• Request
• Response

exportAssets

get

/ccadmin/v1/asset/export

Export Assets. Export catalog items as a csv file. There is no json response for this request. The browser will download the csv file directly from the server.

Request

Supported Media Types

• application/json

Query Parameters

• catalogIds(optional): string
  Comma-separated list of catalog IDs to which the assets are associated to. Blank value indicates assets from all catalogs. This parameter is ignored when either the type=catalog or ids parameter is not null. It can only reference legacy catalogs (version 1) and independent catalogs (version 2).
• combineWithSCIM(optional): boolean
  Boolean value indicating whether to combine the q parameter (SCIM query) with other parameters to further narrow down the results returned. Default value is false.
• filteredViewCatalogId(optional): string
  Filtered view (version 3) catalog ID. It allows to further narrow down the assets that are returned to those that are associated to the specified filtered view catalog. It can be used only when type is either Product or Variant and catalogIds parameter points to a single valid independent(version 2) catalog. Default value is blank.
• ids(optional): string
  Comma-separated list of asset IDs to export. Duplicates and non-matching IDs are ignored.
• includeUnassignedCategoriesSubtree(optional): boolean
  Boolean value indicating whether to include all items (of matching type) that are descendants of Unassigned Collections. Generally, such items are not associated with any catalog but it is not always true. This parameter is ignored when ids parameter is not null. Default value is true.
• locale: string
  Site supported language (locale code) in which the items should be exported.
• q(optional): boolean
  SCIM query. If SCIM query is provided then other query parameters, such as ids, catalogIds, includeUnassignedCategoriesSubtree are ignored unless combineWithSCIM=true
• timeZoneOffset: string
  Offset in minutes between the client time zone and UTC time.
• type: string
  Case-sensitive. One of "catalog", "Product", "Collection", or "Variant", indicating the type of asset that should be exported.

Back to Top

Response

Supported Media Types

• */*

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : exportAssets_response

Show Source

{
    "properties":{
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |36010|Invalid value [ collections ] for parameter: type.| |13036|The language does not match any supported language for the site. Please select another language and try again.| |200105|Catalog NonExistingCatalogId not found in the repository| |200104|Blank catalog id passed|

Body ()

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"
        }
    }
}

Back to Top