POST Original File
Overview
The table below provides details on the POST
method used to manage access control for an original file.
POST Original File | |
---|---|
Method | POST |
URL or Endpoint | /api/v1/projectId /audios/audioId /oiginal-files |
Headers | Authorization |
Parameters | audioId, projectId |
Request Body | accessControl |
The description of the URL parameter is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | Unique Id of the project. |
audioId | Yes | string | Unique id of the audio. |
Request Body
{
"accessControl": 1
}
Information about the fields that appear on the request body are displayed in the table below.
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
accessControl | Yes | iteger($int32) | Access control level |
{
"success": true,
"errors": [],
"messages": [],
"result": {
"accessControl": 1
},
"resultInfo": "string",
"statusCode": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false |
errors | array[string] | Indicates if there was an error |
messages | array[string] | Returns the response message from back-end |
result | array[Object] | Returns the response object |
accessControl | integer($int32) | Access control level |
resultInfo | string | Returns extra information about the result |
statusCode | integer($int32) | Returns the HTTP Status Code |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed