Starts room index export
POST /api/2.0/files/rooms/{id}/indexexport
Request
Starts room index export
Authorization
An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key
.
Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
,text/json
,text/plain
.
Path
- id
integer
int32required Room Id
Examples
POST /api/2.0/files/rooms/3180/indexexport HTTP/1.1
Accept: application/json
Host: example.com
curl --request POST \
--url https://example.com/api/2.0/files/rooms/3180/indexexport \
--header 'Accept: application/json'
Responses
200
Ok
- id
string
Id
- error
string
Error
- percentage
integer
int32 Percentage
- isCompleted
boolean
Is completed
- status
one of
- .
enum of string
[Created - Created, Running - Running, Completed - Completed, Canceled - Canceled, Failted - Failted]
Can be one of:
Created
,Running
,Completed
,Canceled
,Failted
.- .
enum of integer
[0 - Created, 1 - Running, 2 - Completed, 3 - Canceled, 4 - Failted]
Can be one of:
0
,1
,2
,3
,4
.
- resultFileId
unknown
Result file id
- resultFileName
string
Result file name
- resultFileUrl
string
Result file url
401
Unauthorized
501
Folder indexing is turned off