List in-progress

Description

Retrieve a list of in progress jobs from the Tines tenant. This endpoint is relevant for dedicated tenants only.

Request

HTTP Method: GET

Query Parameter Description
page Optional Retrieve page number from the paginated list. Defaults to 1.
per_page Optional Set the number of results returned per page. Defaults to 20. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/admin/in_progress_jobs \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON Array describing in progress jobs in the Tines tenant.

Field description

Parameter Description
id Job ID.
type Job type.
agent (Hash) Contains action description (AgentReceiveJob type entries only).
events Event ID.
started_at Job starting time.

Sample response

{
  "admin/in_progress_jobs": [
    {
      "id": 1234,
      "type": "AgentReceiveJob",
      "agent": {
        "id": 1,
        "name": "Action 01"
      },
      "events": 1,
      "started_at": 1567399360.056226
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/admin/in_progress_jobs?page=1&per_page=20",
    "previous_page": null,
    "next_page": "https://<<META.tenant.domain>>/api/v1/admin/in_progress_jobs?page=2&per_page=20",
    "next_page_number": 2,
    "per_page": 20,
    "pages": 0,
    "count": 0
  }
}
Was this helpful?