file_progress

Check file progress by sign request UUID with long-polling (similar to Talk)

Changed on

Waits up to 30 seconds for status change using cache for efficiency. Returns progress for the specific sign request, not the global file status.

get/ocs/v2.php/apps/libresign/api/{apiVersion}/file/progress/{uuid}

Request

  • The document declares no server URL.
  • Auth
    • none
    • or HTTP bearer
    • or HTTP basic

Path parameters

apiVersion'v1' required
uuidstring required

Sign request UUID

Query parameters

timeoutinteger

Maximum seconds to wait (default 30)

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Response

Status and progress returned

Changes

    • info

      added the optional property /// to the response with the status

    • warning

      removed the optional property /// from the response with the status