Jump to

• Request
• Response

uploadSelectedAssets

post

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

Takes an application deployment zip file as input and deploys the application and it's assets.

Request

Supported Media Types

• application/x-zip-compressed

Path Parameters

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

Query Parameters

• keepUnpublishedChanges: boolean
  Specify whether to retain any unpublished business changes.

  Default Value: false
• verbose: boolean
  Specify whether all info messages in the ValidationResult are included in the endpoint response.

Header Parameters

• Content-Type(required): string
  Specify the type of content in the request i.e. application/octet-stream.
• X-CCAsset-Language(required): string
  Specify the language of the assets in the request. For example, use 'en' for English, 'de' for German, or 'fr_CA' for Canadian French.

Body ()

Upload an application ZIP file containing all the assets.

Root Schema : schema

Type: string(binary)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : uploadSelectedAssets_response

Type: object

Show Source

• deploymentId: string
  Deployment Id for upload
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• warnings: string
  Warning messages for selected upload

{
    "type":"object",
    "properties":{
        "warnings":{
            "description":"Warning messages for selected upload",
            "type":"string"
        },
        "deploymentId":{
            "description":"Deployment Id for upload",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "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"
                    },
                    "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"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• 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"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

404 Response

Following model is returned when operation fails.

Body ()

Root Schema : uploadSelectedAssets_badRequest

Type: object

Show Source

• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• status: string
  Default Value: 404

  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"
        },
        "status":{
            "default":404,
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top