Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Update a media file to the dialogportal™ Media Archive.


Media in the archive is contained in a folder structure, and file and folder names are unique within their respective folders.

When attempting to create a media file with a name that already exists in the folder, the autoName field is used to determine the correct action. When autoName is omitted or set to false, a 303 response will be returned including a location header containing the URL to the existing media file. When autoName is true, the file will be created with an auto-incremented "index" appended to the file name, "file_1.txt", "file_2.txt" etc.

To add new folders simply include them in your folderPath. Folders that do not already exist will be created.

Endpoint ID:

9101

Method:

PUT

URL:

/content/media

Request body:

JSON data with information about the media to be updated.

Required fields:
 

fileName

A file name or title of the media item.

 folderPathA folder path of the media file to be updated. This path is not the entire URL (which also contains the customer name, fileName etc.) but simply a "/"-delimited string of folder names.
Optional fields to be updated:
 content

The content, formatted as a base64 encoded text string.

 description

A description that will be displayed in dialogportal™

 contentType

The content mime-type, i.e. "image/gif" or "text/plain".

Example: Create a single pixel image
 {
   "content": "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
   "contentType": "image/gif",
   "fileName": "clear 1x1.gif",
   "folderPath": "Assets/Generic Images/Small",
   "autoName" : true
}

Response body:


A JSON object containing the url to the newly created content.

Example
{
  "url": "https://media.dialogportal.com/customer_name/assets/generic_images/small/clear_1x1.gif"
}

The URL format is:

Base URLhttps://media.dialogportal.com/
Customer name
customer_name/
Folder path
assets/generic_images/small/
File nameclear_1x1.gif

The fileName and folderPath have been sanitized, making them safe to use in a URL.

Status codes:

201

Media created successfully.

 303

A media file with this name already exists in the folder.

The response includes a location header containing the URL to the existing media file.

 400.1Content type not recognized
 400.2Media files may not be larger than 2MB
  • No labels