Examples

GET /api/job_invocations
200
{
  "total": 9,
  "subtotal": 9,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 9,
      "description": null,
      "job_category": "Job name 7",
      "targeting_id": 7,
      "status": 0,
      "start_at": null,
      "status_label": "succeeded",
      "ssh_user": null,
      "dynflow_task": {
        "id": "541fee74-f6c7-4171-987c-667594310163",
        "state": "stopped"
      },
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 8,
      "description": null,
      "job_category": "Job name 9",
      "targeting_id": 9,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 7,
      "description": null,
      "job_category": "Job name 8",
      "targeting_id": 8,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 6,
      "description": null,
      "job_category": "Job name 4",
      "targeting_id": 4,
      "status": 0,
      "start_at": null,
      "status_label": "succeeded",
      "ssh_user": null,
      "dynflow_task": {
        "id": "4297fb42-ac4c-430f-82c2-9aa05a4c4d3c",
        "state": "stopped"
      },
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 5,
      "description": null,
      "job_category": "Job name 6",
      "targeting_id": 6,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 4,
      "description": null,
      "job_category": "Job name 5",
      "targeting_id": 5,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 3,
      "description": null,
      "job_category": "Job name 1",
      "targeting_id": 1,
      "status": 0,
      "start_at": null,
      "status_label": "succeeded",
      "ssh_user": null,
      "dynflow_task": {
        "id": "77bf9c98-0172-467c-8c87-fcbe9faf4c6d",
        "state": "stopped"
      },
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 2,
      "description": null,
      "job_category": "Job name 3",
      "targeting_id": 3,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    },
    {
      "id": 1,
      "description": null,
      "job_category": "Job name 2",
      "targeting_id": 2,
      "status": 2,
      "start_at": null,
      "status_label": "queued",
      "ssh_user": null,
      "dynflow_task": null,
      "succeeded": "N/A",
      "failed": "N/A",
      "pending": "N/A",
      "total": "N/A",
      "missing": 0
    }
  ]
}

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$/.