Skip to main content

getOperationStatuses

FileOperationArrayWrapper getOperationStatuses(id)

GET /api/2.0/files/fileops

Get active file operations

Returns the background file operations of the caller that are still running or whose finished result has not been read yet, grouped by kind: duplications first, then moves and copies, deletions, downloads and mark-as-read. This is the polling target for every operation in this section — an operation appears here as soon as it is queued and carries progress from 0 to 100, finished, the error of a failed item and, for a download, the address of the archive in url. A record is dropped once its finished state has been handed out, so a completed operation is reported once and an empty array means there is nothing left to report rather than that the work failed. Pass id to follow a single operation; an id that is not among the caller's operations gives an empty array. Operations are private to the account that started them, an anonymous caller being scoped to the session of the external link. The call changes nothing. To follow one kind only use GET api/2.0/files/fileops/{operationType}.

Parameters​

NameInTypeDescriptionNotes
idqueryStringThe operation to report on, as returned in id when it was started; without it every operation of the caller is reported. An id that is not among the caller's operations gives an empty answer rather than an error.[optional] [example: b2f3e9a4-7c15-4d8e-9f60-3a1c5e7d0b42]

Responses​

Status codeDescriptionTypeResponse headers
200The file operations of the caller that are still running or not yet readFileOperationArrayWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
400Bad Request.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

FileOperationArrayWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json