Status of Operation

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Properties

The following properties are available:

Property Type Default Read-Only Description
ok boolean No Indicates whether the operation succeeded or not

Methods

The following methods are available:

Queries for Status of Operation

Queries for instances of type Status of Operation
POST /status/query

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_status"
      }
    }
  }
}

Read Status of Operation

Reads an instance of a Status of Operation
GET /status/{statusIdOrKey}

Parameters

Name Required Type Description
statusIdOrKey true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  },
  "id": "status"
}