APIs for working with jobs

Supported Formats

json

GET /api/recipes/:recipe_id/jobs
List jobs belonging to recipe

Supported Formats

json

Errors

Code Description
401 Unauthorized
404 Not found
500 Server error

Examples

GET /api/recipes/137/jobs?offset_run_id=1&offset_job_id=2&prev=true
200
{
  "job_succeeded_count": 5,
  "job_failed_count": 3,
  "job_count": 8,
  "items": [
    {
      "id": 1004,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Bad request: Custom field SICCode__c is not present",
      "lines": [],
      "is_poll_error": true,
      "error": "{\"error_type\":\"Bad request\",\"message\":\"Custom field SICCode__c is not present\",\"error_id\":\"6b75ec2c-79df-4c09-b7b6-0137def14378\",\"input\":\"{\\\"LastName\\\"=\\u003e\\\"LLLLL\\\", \\\"Company\\\"=\\u003e\\\"CCCCC\\\", \\\"Status\\\"=\\u003e\\\"Open - Not Contacted\\\", \\\"SICCode__c\\\"=\\u003e\\\"CODE2\\\"}\"}",
      "error_parts": {
        "error_type": "Bad request",
        "message": "Custom field SICCode__c is not present",
        "error_id": "6b75ec2c-79df-4c09-b7b6-0137def14378",
        "input": "{\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE2\"}"
      },
      "is_error": true
    },
    {
      "id": 1003,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Bad request: Custom field 'SICCode__c' is not present",
      "lines": [],
      "is_poll_error": true,
      "error": "Bad request: Custom field 'SICCode__c' is not present; Error ID 058ea58e-fcd5-4206-b93f-c1dcfbf95a32; input: {\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE1\"}",
      "error_parts": {
        "error_type": "Bad request",
        "message": "Custom field 'SICCode__c' is not present",
        "error_id": "058ea58e-fcd5-4206-b93f-c1dcfbf95a32",
        "input": "{\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE1\"}"
      },
      "is_error": true
    },
    {
      "id": 1002,
      "flow_run_id": 1002,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Processed event",
      "lines": [],
      "is_poll_error": false,
      "error": null,
      "is_error": false
    },
    {
      "id": 1001,
      "flow_run_id": 1002,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Error",
      "lines": [],
      "is_poll_error": false,
      "error": "Error",
      "error_parts": {},
      "is_error": true
    }
  ]
}
GET /api/recipes/138/jobs?offset_run_id=1&offset_job_id=2&failed=true
200
{
  "job_succeeded_count": 5,
  "job_failed_count": 3,
  "job_count": 8,
  "items": [
    {
      "id": 1004,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Bad request: Custom field SICCode__c is not present",
      "lines": [],
      "is_poll_error": true,
      "error": "{\"error_type\":\"Bad request\",\"message\":\"Custom field SICCode__c is not present\",\"error_id\":\"6b75ec2c-79df-4c09-b7b6-0137def14378\",\"input\":\"{\\\"LastName\\\"=\\u003e\\\"LLLLL\\\", \\\"Company\\\"=\\u003e\\\"CCCCC\\\", \\\"Status\\\"=\\u003e\\\"Open - Not Contacted\\\", \\\"SICCode__c\\\"=\\u003e\\\"CODE2\\\"}\"}",
      "error_parts": {
        "error_type": "Bad request",
        "message": "Custom field SICCode__c is not present",
        "error_id": "6b75ec2c-79df-4c09-b7b6-0137def14378",
        "input": "{\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE2\"}"
      },
      "is_error": true
    },
    {
      "id": 1003,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Bad request: Custom field 'SICCode__c' is not present",
      "lines": [],
      "is_poll_error": true,
      "error": "Bad request: Custom field 'SICCode__c' is not present; Error ID 058ea58e-fcd5-4206-b93f-c1dcfbf95a32; input: {\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE1\"}",
      "error_parts": {
        "error_type": "Bad request",
        "message": "Custom field 'SICCode__c' is not present",
        "error_id": "058ea58e-fcd5-4206-b93f-c1dcfbf95a32",
        "input": "{\"LastName\"=>\"LLLLL\", \"Company\"=>\"CCCCC\", \"Status\"=>\"Open - Not Contacted\", \"SICCode__c\"=>\"CODE1\"}"
      },
      "is_error": true
    },
    {
      "id": 1001,
      "flow_run_id": 1002,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Error",
      "lines": [],
      "is_poll_error": false,
      "error": "Error",
      "error_parts": {},
      "is_error": true
    }
  ]
}
GET /api/recipes/140/jobs
404
{
  "message": "Not found"
}

Params

Param name Description
recipe_id
required

Recipe ID

Validations:

  • Must be a number.

offset_run_id
optional

offset_run_id (deprecated)

Validations:

  • Must be a number.

offset_job_id
optional

offset_job_id

Validations:

  • Must be a number.

prev
optional

Previous jobs if 'true', next otherwise

Validations:

  • Must be String

failed
optional

Return failed jobs only if 'true' (deprecated)

Validations:

  • Must be String

status
optional

Filter by status - succeeded, failed, pending

Validations:

  • Must be String

rerun_only
optional

Return rerun jobs only if 'true'

Validations:

  • Must be String