REST API for Session Border Controller Release 8.2

Get 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: string

For this release, the value is "v1.0".

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 /auth/token request.

There's no request body for this operation.

Response

Supported Media Types

application/xml

200 Response

The system successfully returns the status of the last asynchronous request. The response body indicates the operation and its status. The <additionalInfo> tag supplies additional information for the client.

If the asynchronous request failed, the <data> tag contains an error message.

Root Schema : response

Type: object

Show Source

data: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "operationState":{
                    "required":[
                        "operation",
                        "status"
                    ],
                    "type":"object",
                    "properties":{
                        "status":{
                            "enum":[
                                "fail",
                                "success",
                                "inProgress"
                            ],
                            "type":"string"
                        },
                        "operation":{
                            "enum":[
                                "activate",
                                "save",
                                "verify",
                                "restore"
                            ],
                            "type":"string"
                        },
                        "errorMessage":{
                            "type":"string"
                        }
                    }
                },
                "additionalInfo":{
                    "type":"object",
                    "description":"A request-specific structure that contains response information related to the original asynchronous request.",
                    "properties":{
                        "verifySummary":{
                            "type":"object",
                            "description":"Response information for a verify configuration operation",
                            "properties":{
                                "verify":{
                                    "type":"object",
                                    "properties":{
                                        "field":{
                                            "type":"object",
                                            "properties":{
                                                "value":{
                                                    "type":"string"
                                                }
                                            }
                                        },
                                        "object":{
                                            "type":"object"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

additionalInfo(optional): object additionalInfo

A request-specific structure that contains response information related to the original asynchronous request.
operationState(optional): object operationState

{
    "type":"object",
    "properties":{
        "operationState":{
            "required":[
                "operation",
                "status"
            ],
            "type":"object",
            "properties":{
                "status":{
                    "enum":[
                        "fail",
                        "success",
                        "inProgress"
                    ],
                    "type":"string"
                },
                "operation":{
                    "enum":[
                        "activate",
                        "save",
                        "verify",
                        "restore"
                    ],
                    "type":"string"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "additionalInfo":{
            "type":"object",
            "description":"A request-specific structure that contains response information related to the original asynchronous request.",
            "properties":{
                "verifySummary":{
                    "type":"object",
                    "description":"Response information for a verify configuration operation",
                    "properties":{
                        "verify":{
                            "type":"object",
                            "properties":{
                                "field":{
                                    "type":"object",
                                    "properties":{
                                        "value":{
                                            "type":"string"
                                        }
                                    }
                                },
                                "object":{
                                    "type":"object"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : additionalInfo

Type: object

A request-specific structure that contains response information related to the original asynchronous request.

Show Source

verifySummary(optional): object verifySummary

Response information for a verify configuration operation

{
    "type":"object",
    "description":"A request-specific structure that contains response information related to the original asynchronous request.",
    "properties":{
        "verifySummary":{
            "type":"object",
            "description":"Response information for a verify configuration operation",
            "properties":{
                "verify":{
                    "type":"object",
                    "properties":{
                        "field":{
                            "type":"object",
                            "properties":{
                                "value":{
                                    "type":"string"
                                }
                            }
                        },
                        "object":{
                            "type":"object"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : operationState

Type: object

Show Source

errorMessage(optional): string
operation: string

Allowed Values: [ "activate", "save", "verify", "restore" ]
status: string

Allowed Values: [ "fail", "success", "inProgress" ]

{
    "required":[
        "operation",
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "enum":[
                "fail",
                "success",
                "inProgress"
            ],
            "type":"string"
        },
        "operation":{
            "enum":[
                "activate",
                "save",
                "verify",
                "restore"
            ],
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : verifySummary

Type: object

Response information for a verify configuration operation

Show Source

verify(optional): object verify

{
    "type":"object",
    "description":"Response information for a verify configuration operation",
    "properties":{
        "verify":{
            "type":"object",
            "properties":{
                "field":{
                    "type":"object",
                    "properties":{
                        "value":{
                            "type":"string"
                        }
                    }
                },
                "object":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : verify

Type: object

Show Source

field(optional): object field
object(optional): object object

{
    "type":"object",
    "properties":{
        "field":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string"
                }
            }
        },
        "object":{
            "type":"object"
        }
    }
}

Nested Schema : field

Type: object

Show Source

value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : object

Type: object

400 Response

The request is malformed or missing required information.

Root Schema : response

Type: object

Show Source

data: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

401 Response

The client is not authorized.

Root Schema : response

Type: object

Show Source

data: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

403 Response

This request requires the client to have administrator privileges.

Root Schema : response

Type: object

Show Source

data: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

404 Response

Unsupported versionId in URI

Root Schema : response

Type: object

Show Source

data: object data
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to get the status of the 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://10.0.0.2/rest/v1.0/admin/asyncstatus'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 07 Aug 2018 12:12:03 GMT
Cache-Control: no-cache
Content-Length: 221
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Tue, 07 Aug 2018 12:12:03 GMT
X-Appweb-Seq: 4

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>