{
  "openapi": "3.0.1",
  "info": {
    "title": "Active Jobs",
    "description": "Provide access to active scheduled jobs.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Active Jobs",
      "description": "Provide RESTful services to retrieve active scheduled jobs."
    }
  ],
  "paths": {
    "/active-jobs": {
      "get": {
        "tags": [
          "Active Jobs"
        ],
        "description": "Get a collection of active scheduled jobs.",
        "operationId": "getActiveJobs",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the job instance.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "actualEndDateTime",
            "in": "query",
            "description": "The date and time for when the job is completed.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "actualStartDateTime",
            "in": "query",
            "description": "The date and time for when the job actaully started to run.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "attemptsLeft",
            "in": "query",
            "description": "The number of attempts left for retrying the job.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "preferredStartDateTime",
            "in": "query",
            "description": "The preferred date and time for when the job should start. The date and time must be entered as a timestamp in the ISO 8601 format \"YYYY-MM-DDThh:mm:ssZ\".",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "priority",
            "in": "query",
            "description": "The priority for the job when multiple jobs are scheduled to run.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "queue",
            "in": "query",
            "description": "The placement of the job within the job queue.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "recoveryInstance",
            "in": "query",
            "description": "If the job is a reattempt of a failed job, the value indentifies the instance of the failed job.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "result",
            "in": "query",
            "description": "The status of the broadcast job. Available values:\\n  S - Successful.\\n  F - Failed.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jobId",
            "in": "query",
            "description": "The unique numeric ID for identifying the job.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "sequence",
            "in": "query",
            "description": "Scheduling policy for the job.\\n  0 - Skip missed repeating job instances.\\n  1 - Run all missed repeating job instances.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "state",
            "in": "query",
            "description": "The state of the job. Available values:\\n  I - The job is idle and is waiting to start at the preferred start time.\\n  IF - The job is idle and is being rescheduled because the previous attempt to run the job failed.\\n  R - The job is currently running.\\n  RF - The job is running after the previous attempt to run the job failed.\\n  C - The job completed successfully.\\n  CF - The job completed, but an exception occurred.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of active scheduled jobs.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActiveJobCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/active-jobs/{id}": {
      "get": {
        "tags": [
          "Active Jobs"
        ],
        "description": "Get an active scheduled job by ID.",
        "operationId": "getActiveJobById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the job instance.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An active scheduled job.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActiveJob"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "ActiveJob": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the job instance.",
            "format": "int64"
          },
          "actualEndDateTime": {
            "type": "string",
            "description": "The date and time for when the job is completed.",
            "format": "date-time"
          },
          "actualStartDateTime": {
            "type": "string",
            "description": "The date and time for when the job actaully started to run.",
            "format": "date-time"
          },
          "attemptsLeft": {
            "type": "integer",
            "description": "The number of attempts left for retrying the job.",
            "format": "int32"
          },
          "preferredStartDateTime": {
            "type": "string",
            "description": "The preferred date and time for when the job should start. The date and time must be entered as a timestamp in the ISO 8601 format \"YYYY-MM-DDThh:mm:ssZ\".",
            "format": "date-time"
          },
          "priority": {
            "type": "integer",
            "description": "The priority for the job when multiple jobs are scheduled to run.",
            "format": "int32"
          },
          "queue": {
            "type": "string",
            "description": "The placement of the job within the job queue."
          },
          "recoveryInstance": {
            "type": "integer",
            "description": "If the job is a reattempt of a failed job, the value indentifies the instance of the failed job.",
            "format": "int64"
          },
          "result": {
            "type": "string",
            "description": "The status of the broadcast job. Available values:\\n  S - Successful.\\n  F - Failed."
          },
          "jobId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the job.",
            "format": "int64"
          },
          "sequence": {
            "type": "integer",
            "description": "Scheduling policy for the job.\\n  0 - Skip missed repeating job instances.\\n  1 - Run all missed repeating job instances.",
            "format": "int32"
          },
          "state": {
            "type": "string",
            "description": "The state of the job. Available values:\\n  I - The job is idle and is waiting to start at the preferred start time.\\n  IF - The job is idle and is being rescheduled because the previous attempt to run the job failed.\\n  R - The job is currently running.\\n  RF - The job is running after the previous attempt to run the job failed.\\n  C - The job completed successfully.\\n  CF - The job completed, but an exception occurred."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "An active scheduled job."
      },
      "ActiveJobCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/ActiveJob"
            }
          }
        },
        "description": "A collection of active scheduled jobs."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}