Jump to

• Request
• Response

downloadSelectedAssets

post

/ccadmin/v1/clientApplications/{application}/assets

Download Selected Assets of application as zip

Request

Supported Media Types

• application/json

Path Parameters

• application(required): string
  The OSF application being queried.

Query Parameters

• live: boolean
  Set to true to view published/live assets, set to false to view unpublished/preview assets

Body ()

Root Schema : download_selected_assets_request

Type: object

Show Source

• components: object components
  The directory based asset type named components containing directory name and array of files names inside the component directory to be downloaded
• containers: array containers
  The file based asset type named containers containing array of container file names to be downloaded
• pages: array pages
  The file based asset type named containers containing array of page file names to be downloaded
• slots: object slots
  The directory based asset type named slots containing directory name and array of files names inside the slot directory to be downloaded
• styles: array styles
  The file based asset type named containers containing array of styles to be downloaded

{
    "properties":{
        "slots":{
            "description":"The directory based asset type named slots containing directory name and array of files names inside the slot directory to be downloaded",
            "type":"object",
            "items":{
                "type":"object"
            }
        },
        "components":{
            "description":"The directory based asset type named components containing directory name and array of files names inside the component directory to be downloaded",
            "type":"object"
        },
        "pages":{
            "description":"The file based asset type named containers containing array of page file names to be downloaded",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "containers":{
            "description":"The file based asset type named containers containing array of container file names to be downloaded",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "styles":{
            "description":"The file based asset type named containers containing array of styles to be downloaded",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "example":{
        "slots":{
            "header-with-notification-device-slot":[
            ],
            "dynamic-product-listing-for-search-device-slot":[
                "structure.json"
            ],
            "checkout-header-with-notification-device-slot":[
                "config.json"
            ]
        },
        "components":{
            "account-type-selector":[
            ],
            "account-type-selector-responsive":[
                "layout.json"
            ],
            "checkout-back-to-previous-button":[
                "index.json"
            ],
            "add-items-to-cart":[
                "resources.json"
            ],
            "back-button":[
                "config.json"
            ],
            "country-store-language-currency-desktop":[
            ]
        },
        "pages":[
            "checkout-login.json",
            "429.json",
            "checkout-order-confirmation.json",
            "checkout-shipping.json",
            "update-expired-password.json"
        ],
        "containers":[
            "cart-container.json",
            "dynamic-product-listing-desktop.json",
            "profile-update-password-container.json"
        ],
        "styles":[
            "customStylingRed.css",
            "customStylingBrown.css",
            "customStylingBlack.css"
        ]
    }
}

Example:

{
    "slots":{
        "header-with-notification-device-slot":[
        ],
        "dynamic-product-listing-for-search-device-slot":[
            "structure.json"
        ],
        "checkout-header-with-notification-device-slot":[
            "config.json"
        ]
    },
    "components":{
        "account-type-selector":[
        ],
        "account-type-selector-responsive":[
            "layout.json"
        ],
        "checkout-back-to-previous-button":[
            "index.json"
        ],
        "add-items-to-cart":[
            "resources.json"
        ],
        "back-button":[
            "config.json"
        ],
        "country-store-language-currency-desktop":[
        ]
    },
    "pages":[
        "checkout-login.json",
        "429.json",
        "checkout-order-confirmation.json",
        "checkout-shipping.json",
        "update-expired-password.json"
    ],
    "containers":[
        "cart-container.json",
        "dynamic-product-listing-desktop.json",
        "profile-update-password-container.json"
    ],
    "styles":[
        "customStylingRed.css",
        "customStylingBrown.css",
        "customStylingBlack.css"
    ]
}

Nested Schema : components

Type: object

The directory based asset type named components containing directory name and array of files names inside the component directory to be downloaded

Nested Schema : containers

Type: array

The file based asset type named containers containing array of container file names to be downloaded

Show Source

• Array of: object items

{
    "description":"The file based asset type named containers containing array of container file names to be downloaded",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : pages

Type: array

The file based asset type named containers containing array of page file names to be downloaded

Show Source

• Array of: object items

{
    "description":"The file based asset type named containers containing array of page file names to be downloaded",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : slots

Type: object

The directory based asset type named slots containing directory name and array of files names inside the slot directory to be downloaded

Show Source

• Array of: object items

{
    "description":"The directory based asset type named slots containing directory name and array of files names inside the slot directory to be downloaded",
    "type":"object",
    "items":{
        "type":"object"
    }
}

Nested Schema : styles

Type: array

The file based asset type named containers containing array of styles to be downloaded

Show Source

• Array of: object items

{
    "description":"The file based asset type named containers containing array of styles to be downloaded",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Back to Top

Response

Supported Media Types

• application/x-zip-compressed

200 Response

a zip file containing all the requested assets of the application gets downloaded

400 Response

Following model is returned when operation fails. See individual error codes for details; 212001 - JSON Object Passed is an empty or null

Body ()

Root Schema : downloadSelectedAssets_badRequest

Type: object

Show Source

• errorCode: string
  Default Value: 212001/212002/212003/212004/212005/212006/212007

  The numerical code identifying the error.
• message: string
  Default Value: 212001 - empty or null json passed/ 212002 - Invalid assetType found in JSON payload/ 212003 - The asset value passed for asset type is invalid/ 212004 - Invalid directory name, it is not String/ 212005 - Invalid Asset Type found for Directory based asset/ 212006 - Invalid File Name Exits for Directory/ 212007 - File name Null or empty provided for File Based Asset Type

  The localized message describing the error
• status: string
  Default Value: 400

  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "default":"212001/212002/212003/212004/212005/212006/212007",
            "description":"The numerical code identifying the error.",
            "type":"string"
        },
        "message":{
            "default":"212001 - empty or null json passed/ 212002 - Invalid assetType found in JSON payload/ 212003 - The asset value passed for asset type is invalid/ 212004 - Invalid directory name, it is not String/ 212005 - Invalid Asset Type found for Directory based asset/ 212006 - Invalid File Name Exits for Directory/ 212007 - File name Null or empty provided for File Based Asset Type",
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "default":400,
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

404 Response

Following model is returned when operation fails. See individual error codes for details; 212001 - empty or null json passed. 212002 - Invalid assetType {assetType} found in JSON payload.Please input at least one of the valid asset types: {validAssetTypesList}. 212003 - The asset value passed for asset type {nameOfAssetType} is invalid. For file-based assets like {fileBasedAssetsList}, please pass a JSON array. For directory-based assets like {directoryBasedAssetsList}, please pass a JSON object. 212004 - Invalid directory name {directoryName} is not String. Please provide directory as String. 212005 - Invalid Asset Type found for Directory based asset {assetName}. 212006 - Invalid File Name {fileName} Exits for Directory {directoryName}. Please provide valid Files names from {validFileNames}. 212007 - File name Null or empty provided for File Based Asset Type {assetName}.

Body ()

Root Schema : getClientApplication_failureResponse

Type: object

Show Source

• errorCode: string
  The error code

  Example: 00000000
• message: string
  The HTTP error message

  Example: Application {application} not found
• status: string
  The HTTP status code

  Example: 404

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string",
            "example":"00000000"
        },
        "message":{
            "description":"The HTTP error message",
            "type":"string",
            "example":"Application {application} not found"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string",
            "example":"404"
        }
    }
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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