# Jobs

# List Jobs from a Recipe

Returns aggregated job information as well as detailed job information for a specified recipe in Workato.

GET /api/recipes/:recipe_id/jobs

Run-time data not available

Run-time data is the data that flows through the recipe at the time of job execution. This includes the input and output data from individual steps.

This data is available through the Workato platform on the job details page.

# URL Parameters

Name Type Description
recipe_id integer
required
Recipe id.

# Query Parameters

Name Type Description
offset_job_id string
optional
Offset job ID. Jobs that were done after the this job ID will be returned.
prev boolean
optional
Previous jobs if true, next otherwise.
status string
optional
Filter by status - succeeded, failed or pending.
rerun_only boolean
optional
If true, returns jobs that were rerun only.
offset_run_id integer
(deprecated)
Offset run id. This parameter has been deprecated.
failed boolean
(deprecated)
If true, returns failed jobs only. This parameter has been deprecated.

# Sample request

curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# Response

{
  "job_succeeded_count": 1,
  "job_failed_count": 1,
  "job_count": 1,
  "items": [
    {
      "id": "j-KGAKfhsz-GYoLe",
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
        "is_poll_error": false,
        "error": null,
        "is_error": false
    },
    {
      "id": "j-AD9bJn99-hsCXcs",
      "flow_run_id": 1005,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "is_poll_error": false,
      "error": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "error_parts": {
        "adapter": "marketo",
        "error_type": "Missing required field",
        "message": "'Filter values' must be present",
        "error_id": "603260f5-a309-45b3-a20e-111d90a28917",
        "error_at": "2020-01-22T01:17:18.021-08:00",
        "input": "<redacted>",
        "inner_message": null
      },
      "is_error": true
    },
  ]
}

# List job ID mappings from a recipe

Returns all job ID mapping for a specific recipe.

GET /api/recipes/:recipe_id/jobs/id_mappings

Support for job ID mapping API

Workato commits to supporting this API endpoint for the next six (6) months, or up to February 01, 2023.

# URL Parameters

Name Type Description
recipe_id integer
required
Recipe id.

# Query Parameters

Name Type Description
limit integer
optional
The number of job ID mappings to retrieve. Defaults to 10,000.
offset_job_id string
optional
Offset job ID. Jobs that were done after this job ID will be returned. Both numeric and string job IDs are accepted.

# Sample request

curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs/id_mappings' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# Response

14004191049,j-ADt1PHzN-At0MtR
14004195305,j-ADt1PbMP-T30bPH
14004151595,j-ADt1TYh8-nD0XfC
14004161099,j-ADt1W63w-MW0cnw
14004176766,j-ADt1WtXW-w80PH9
14004184037,j-ADt1XLHn-cR4AWF
14004117662,j-ADt1YoeC-Hz0pBe
14004143161,j-ADt1bFTt-Aw0YLh
14004155023,j-ADt1bz6m-Fp0EJM
14004161914,j-ADt1cKML-kx0wka