Update Documents

put

Update Documents

Allow an existing Document to be updated through the use of a unique identifier. The acronym for unique identifier is uuid. This uuid is created when you submit a media content. This can be found in API JSON response. If you have not documented the uuid, you can fetch it by using Search Media By Keyword or UUIDs API.

Resource URL

https://api.stb.gov.sg/media-management /documents/v2/{uuid}

Header Parameters

Name Values Description
Content-Type

Format of the request body sent. Accepts only application/json.

Body Parameters

Name Values Description
document
(required)

Example

JSON which holds all the properties of the Document to be updated

uuid UUID of the existing Document. null true

Request Attributes

Parameter Name Type Max Length Description Example

Response Error Details

HTTP Code Description
400 Bad Request — Request was not accepted and could be due to malformed parameter (e.g. spelling error) or missing a required parameter.
401 Unauthorised — API key is invalid or was not provided.
403 Forbidden — API key does not have the permission to perform the request.
404 Resource Not Found — Requested resource (i.e. the resource URL) does not exist.
405 Method Not Allowed — The HTTP request method is not supported by the resource.
406 Not Acceptable — Requester's acceptable content type for the response does not match the content type returned by the resource.
414 Request URL Too Long — Request URL exceeded the maximum acceptable URL length.
415 Unsupported Media Type — Request's format is not supported by the resource.
422 Unprocessable Entity — Request was not accepted, often due to semantic errors, such as data format.
500 Server Errors — Something is not working on TIH's end, happened very rarely.

Resource Summary

Security Content Type Category

application/json

Documents

Working...