Jump to

• Request
• Response
• Examples

Get the status of last asynchronous request

get

/rest/{version}/admin/asyncstatus

Returns the status of the most recently-issued request that required asynchronous processing - regardless of whether the same REST client issued the original asynchronous request, or even if the request was issued by a non-REST user. It is not possible for a REST client to get the status of any request except the most recently issued.

Request

Path Parameters

• version:
  REST API version string.
  Available values: v1.2

Header Parameters

• Authorization:
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

Back to Top

Response

200 Response

The system successfully returns the status of the last asynchronous request. The response body indicates the asynchronous operation being reported and the status of that operation. Any asynchronous request-specific additional information that may be useful to the client is supplied within the <additionalInfo> tag. The contents of <additionalInfo> are defined as part of the documentation of the asynchronous request itself.

In the case of an asynchronous request that failed, an error message containing information about the failure is present within the <data> section.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

403 Response

This request requires the client credentials to have administrator privileges.

404 Response

Unsupported versionId in URI.

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get the status of last asynchronous request by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/admin/asyncstatus"

Example of Accessing the API with Python

The following example shows how to get the status of last asynchronous request by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/admin/asyncstatus"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 11:08:53 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <operationState>
      <operation>activate</operation>
      <status>success</status>
    </operationState>
  </data>
  <messages/>
  <links/>
</response>

Back to Top