Create Documents
post
Create Documents
Allow the creation of a Document metadata.
Approach is to create a Library using Create Library API and retrieve the libraryUuid, prior to creating a Document metadata. Once the Document metadata has been created, proceed to upload the document asset using Upload Media Files API.
To create successfully, the following input parameters are mandatory: name, category, subCategory, tags, libraryUuid and mediaType.
Approach is to create a Library using Create Library API and retrieve the libraryUuid, prior to creating a Document metadata. Once the Document metadata has been created, proceed to upload the document asset using Upload Media Files API.
To create successfully, the following input parameters are mandatory: name, category, subCategory, tags, libraryUuid and mediaType.
Resource URL
https://api.stb.gov.sg/media-management /documents/v2
Header Parameters
| Name | Values | Description |
|---|---|---|
|
Content-Type
(required) |
Format of the request body sent. Accepts only application/json. |
Body Parameters
Example
JSON which holds all the properties of the Document to be created
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...