REST Auth API: AsyncTasks

AsyncTasks resources represent requests of asyncTask queries and asyncTask cancelations.

AsyncTasks instance resource

Resource URI

/api/2012-02-01/auth/resources/asynctasks/{AsyncTaskID}

General structure

            <AsyncTaskRequest>
            <AsyncTaskID>e33d0de1-9181-4a27-9a4a-adf7292d6eaa</AsyncTaskID>
            <CreatedDateTime>2018-05-29T11:03:04.6017804+12:00</CreatedDateTime>
            <Status>Completed</Status>
            <Type>RegistrationCertificateGenerationAsyncTask</Type>
            <TaskData>
            <CertificateDownloadUrl>https://demo.arlo.co/api/2012-02-01/auth/resources/documents/110/content</CertificateDownloadUrl>
            </TaskData>
            </AsyncTaskRequest>
        

Resource properties

Property	Description
AsyncTaskID	A GUID value that uniquely identifies this resource across any platform.
CreatedDateTime	A UTC DateTime value indicating when this resource was created.
Status	An AsyncTaskStatus value representing the current state of this async task, such as waiting running, suspended, completed, cancelled or faulted.
Type	A string representing this task type.
TaskData	This data is only presented when the task is completed. The data is a key-value list returned by the type that implements the task.

HTTP GET

Returns the AsyncTask details, including the properties above.

Example

GET /api/2012-02-01/auth/resources/asynctasks/e33d0de1-9181-4a27-9a4a-adf7292d6eaa/

            <AsyncTaskRequest>
            <AsyncTaskID>e33d0de1-9181-4a27-9a4a-adf7292d6eaa</AsyncTaskID>
            <CreatedDateTime>2018-05-29T11:03:04.6017804+12:00</CreatedDateTime>
            <Status>Completed</Status>
            <Type>RegistrationCertificateGenerationAsyncTask</Type>
            <TaskData>
            <CertificateDownloadUrl>https://demo.arlo.co/api/2012-02-01/auth/resources/documents/110/content</CertificateDownloadUrl>
            </TaskData>
            </AsyncTaskRequest>
        

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Task cancellation

Task cancellation requests are used to cancel a valid task. When executed successfully a HTTP status code 202 will be returned.

Resource URI

/api/2012-02-01/auth/resources/asynctasks/{AsyncTaskID}/cancelrequests

HTTP POST

Cancel an AsyncTask. If the request is accepted, HTTP status code 202 will be responded.

Example

POST /api/2012-02-01/auth/resources/asynctasks/e33d0de1-9181-4a27-9a4a-adf7292d6eaa/cancelrequest

Result: an empty content with HTTP status code 202.

HTTP GET

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Task types

Task data is only presented when a task is completed. Different task types may have different key-value lists. Find all task types below.

RegistrationCertificateGenerationAsyncTask

Key	Description
CertificateDownloadUrl	An Url format string value represents a download URL of registration certificates.