Page Comparison

Excerpt
Update a media file to the dialogportal™ Media Archive.

Media A 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.

archive can be searched and updated based on fileName and folderPath fields.

Fields - content, contentType and description are optional fields that can be updated. If a field is omitted, then this field is not updated. If all three fields (content, contentType and description) are omitted, then nothings get updated.

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

Endpoint ID:

9101

Method:

Status

colour	Green
title	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.
	folderPath	A 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 updatable 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".

Code Block

title	Example: Create Update a single pixel image

 {
   "content": "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
   "description" : "This is a media description.", 
   "contentType": "image/gif",
   "fileName": "clear 1x1.gif",
   "folderPath": "Assets/Generic Images/Small"   
}

Response body:

A JSON object containing the url to of the updated content.

Code Block

title	Example

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

The URL format is:

Base URL	`https://media.dialogportal.com/`
Customer name	customer_name/
Folder path	assets/generic_images/small/
File name	`clear_1x1.gif`

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

Status codes:

201200

Media created updated successfully.

303 404 Media to be updated not found.

400.1 Content type not recognized

400.2 Media files may not be larger than 2MB

Versions Compared

Old Version 4

New Version 5

Key