Channel metadata values
Get all metadata values of a channel
Get all metadata values set for a selected channel.
GET https://api.video.ibm.com/channels/{channel_id}/custom-metadata.json
Parameters
This request has no parameters.
Success response
Upon success a response with HTTP status “200 OK” is returned with the following key-value pair.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
metadata | array | Array of data for fields containing field_id and value |
Example of a success response:
{"metadata": [{"field_id": "7865","value": "some text"},{"field_id": "7866","value": "false"
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
| 404 Not Found | not_found | Channel not found |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Set channel metadata value
Set value of a custom field on a selected channel.
PUT https://api.video.ibm.com/channels/{channel_id}/custom-metadata/{field_id}.json
Parameters
The parameters for the PUT request:
| PARAMETER | TYPE | IMPORTANCE | DESCRIPTION |
|---|---|---|---|
value | (mixed)* | REQUIRED | The metadata field value |
* Data type may vary based on selected field.
Example requests for different data types:
| TYPE | DESCRIPTION | EXAMPLE RAW REQUEST BODY |
|---|---|---|
| string | a string value | value=test+value |
| float | a numeric value | value=3.1415926536 |
| tag_list | tags separated by commas | value=tag1,tag2,tag3 |
| bool | true or false | value=true |
| enum | array of enum item ids returned by the /custom-metadata-fields/{field_id}.json endpoint | value[]=123&value[]=124 |
| datetime | ISO8601 format | value=2023-02-27T16:30:10%2B0100 |
| link | link url and text | value[url]=https%3A%2F%2Fibm.com&value[text]=IBM |
Success response
Upon success, a response with HTTP status “204 No Content” is returned.
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel |
| 404 Not Found | not_found | Channel not found |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Remove channel metadata value
Remove value of a custom field on a selected channel.
DELETE https://api.video.ibm.com/channels/{channel_id}/custom-metadata/{field_id}.json
Parameters
This request has no parameters.
Success response
Upon success a response with HTTP status “200 OK” is returned.
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel |
| 404 Not Found | not_found | Channel not found |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |