GET /api/job_invocations
List job invocations

Examples

GET /api/job_invocations
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 74,
      "description": null,
      "job_category": "Job name 73",
      "targeting_id": 78,
      "status": 0,
      "start_at": null,
      "status_label": "succeeded",
      "ssh_user": null,
      "time_to_pickup": null,
      "concurrency_level": null,
      "execution_timeout_interval": null,
      "dynflow_task": {
        "id": "460b9625-8db0-4188-b1dc-adedac5f924b",
        "state": "stopped"
      },
      "template_id": 1007981834,
      "template_name": "Job template 74",
      "effective_user": "root",
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    },
    {
      "id": 73,
      "description": null,
      "job_category": "Job name 75",
      "targeting_id": 80,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "time_to_pickup": null,
      "concurrency_level": null,
      "execution_timeout_interval": null,
      "dynflow_task": null,
      "template_id": null,
      "template_name": null,
      "effective_user": null,
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    },
    {
      "id": 72,
      "description": null,
      "job_category": "Job name 74",
      "targeting_id": 79,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "time_to_pickup": null,
      "concurrency_level": null,
      "execution_timeout_interval": null,
      "dynflow_task": null,
      "template_id": null,
      "template_name": null,
      "effective_user": null,
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.