Examples

GET /api/job_invocations
200
{
  "total": 9,
  "subtotal": 9,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 149,
      "description": null,
      "job_category": "Job name 131",
      "targeting_id": 152,
      "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": "b6f33b97-3cd7-4f88-afe2-d1e7edd268a1",
        "state": "stopped"
      },
      "template_id": 1007981928,
      "template_name": "Job template 131",
      "effective_user": "root",
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    },
    {
      "id": 148,
      "description": null,
      "job_category": "Job name 133",
      "targeting_id": 154,
      "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": 147,
      "description": null,
      "job_category": "Job name 132",
      "targeting_id": 153,
      "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": 146,
      "description": null,
      "job_category": "Job name 128",
      "targeting_id": 149,
      "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": "ad344a31-ff03-4a49-b0ce-bddf005382b5",
        "state": "stopped"
      },
      "template_id": 1007981926,
      "template_name": "Job template 129",
      "effective_user": "root",
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    },
    {
      "id": 145,
      "description": null,
      "job_category": "Job name 130",
      "targeting_id": 151,
      "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": 144,
      "description": null,
      "job_category": "Job name 129",
      "targeting_id": 150,
      "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": 143,
      "description": null,
      "job_category": "Job name 121",
      "targeting_id": 146,
      "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": "94769594-122a-43f0-9fa0-c5a2a3a643e6",
        "state": "stopped"
      },
      "template_id": 1007981923,
      "template_name": "Job template 126",
      "effective_user": "root",
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    },
    {
      "id": 142,
      "description": null,
      "job_category": "Job name 127",
      "targeting_id": 148,
      "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": 141,
      "description": null,
      "job_category": "Job name 126",
      "targeting_id": 147,
      "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$/.