lists_operation

APIs.ioEngineeringPlatform

Properties

Name Type Description
completed string The RFC 3339 timestamp of when the operation was completed.
error string A message describing the error when the status is `failed`.
id object
status string The current status of the asynchronous operation.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-lists-operation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/lists_operation",
  "title": "lists_operation",
  "properties": {
    "completed": {
      "description": "The RFC 3339 timestamp of when the operation was completed.",
      "example": "2020-01-01T08:00:00Z",
      "readOnly": true,
      "type": "string"
    },
    "error": {
      "description": "A message describing the error when the status is `failed`.",
      "example": "This list is at the maximum number of items",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/lists_operation_id"
    },
    "status": {
      "description": "The current status of the asynchronous operation.",
      "enum": [
        "pending",
        "running",
        "completed",
        "failed"
      ],
      "example": "failed",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object"
}