Virtual Events CSV Export
Initialize an export
POST /channels/{channelId}/virtual-event/{eventId}/exports.json
Parameters
This request doesn’t require request body parameters.
The Content-Type of the request should be application/x-www-form-urlencoded.
Success response
Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the export root object.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
id | number | Export ID |
status | string | One of PROCESSING, PROCESSED |
requested_at | timestamp | Time of the request. Unix timestamp in seconds |
expires_at | timestamp | Expiration time. Unix timestamp in seconds |
is_expired | boolean | Indicates whether the export request is expired |
download_url | string | If the export is not expired and the status is PROCESSED, it contains the url of the export file. Otherwise null |
Example of a success response:
{"export": {"id": 123,"status": "PROCESSED","requested_at": 1622111094,"expires_at": 1622111097,"is_expired": false,"download_url": "https://video.ibm.com/file.csv"}
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 402 Payment Required | invalid_request | The feature is not enabled for the user |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel or event |
| 404 Not Found | not_found | Channel or event not found |
| 500 Server Error | server_error | An error occurred |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
List export requests for an event
GET /channels/{channelId}/virtual-event/{eventId}/exports.json
Success response
Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the exports root array.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
id | number | Export ID |
status | string | One of PROCESSING, PROCESSED |
requested_at | timestamp | Time of the request. Unix timestamp in seconds |
expires_at | timestamp | Expiration time. Unix timestamp in seconds |
is_expired | boolean | Indicates whether the export request is expired |
download_url | string | If the export is not expired and the status is PROCESSED, it contains the url of the export file. Otherwise null |
Example of a success response:
{"exports": [{"id": 123,"status": "PROCESSED","requested_at": 1622111094,"expires_at": 1622111097,"is_expired": false,"download_url": "https://video.ibm.com/file.csv"
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 402 Payment Required | invalid_request | The feature is not enabled for the user |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel or event |
| 404 Not Found | not_found | Channel or event not found |
| 500 Server Error | server_error | An error occurred |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Get an export item
GET /channels/{channelId}/virtual-events/{eventId}/exports/{exportId}.json
Success response
Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the export root object.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
id | number | Export ID |
status | string | One of PROCESSING, PROCESSED |
requested_at | timestamp | Time of the request. Unix timestamp in seconds |
expires_at | timestamp | Expiration time. Unix timestamp in seconds |
is_expired | boolean | Indicates whether the export request is expired |
download_url | string | If the export is not expired and the status is PROCESSED, it contains the url of the export file. Otherwise null |
Example of a success response:
{"export": {"id": 123,"status": "PROCESSED","requested_at": 1622111094,"expires_at": 1622111097,"is_expired": false,"download_url": "https://video.ibm.com/file.csv"}
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 402 Payment Required | invalid_request | The feature is not enabled for the user |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel or event |
| 404 Not Found | not_found | Channel, event or export not found |
| 500 Server Error | server_error | An error occurred |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Delete an export item
DELETE /channels/{channelId}/virtual-events/{eventId}/exports/{exportId}.json
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 | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 402 Payment Required | invalid_request | The feature is not enabled for the user |
| 403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel or event |
| 404 Not Found | not_found | Channel, event or export not found |
| 500 Server Error | server_error | An error occurred |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |