Upload File

This endpoint is used for uploading a file.

Create a New File:
If-None-Match: Setting this header to “*” will create a new file only if one doe not already exist with the same name.

Update Existing:
If-Match: The API will check the version specified in this header against version of the latest file. If the version specified matches the latest version, then a new verion of the file will be created.

Dangerous Upsert:
If “If-Match” and “If-None-Match” both are not provided on a request, the API will create a new version of a file.

URL

https://{{HOST}}/files/upload/{filename}

Method

Required IMS Scopes

• apollo_read
• apollo_write

URL Path Parameters

Request Header Parameters

Example

Request

curl -X PUT 
  'https://{{HOST}}/apollo/files/upload/example_image.png' 
  -H 'Content-Type: multipart/related; boundary=example_boundary' 
  -H 'If-None-Match: *' 
  -H 'X-Metadata-Only: false' 
  -H 'ercollectionid: {ercollectionid}' 
  -d '--example_boundary
Content-Type: application/json; charset=UTF-8;

{
                "file_name": "example_image.png",
                "file_description": "Example image file",
                "file_size": 2179072,
                "file_type": "image/png",
                "file_rating": "5",
                "max-age": 3600
}
--example_boundary
Content-Type: image/png

{base64 encoded file}

--example_boundary--'

Response

{
    "status": {
        "message": "OK",
        "code": "200"
    },
    "data": {
        "message": "New Entity Created with Media and Metadata",
        "entityId": "9e0efa0e-c6d7-4958-bf62-b05d9aee4c14",
        "version": "1",
        "fileName": "example_image.png",
        "fileSize": 2179072,
        "fileType": "image/png"
    }
}  

Errors

Response Body Parameters