Run History

Track job execution logs, success/failure status, duration, and progress details.

GET /api/jobs/{id}/history

List execution history for a job.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Job ID or natural ID

Query Parameters:

Parameter	Type	Default	Description
sort	string	-createdAt	Sort field
limit	integer	30	Results per page
start	integer	0	Pagination offset

Response:

{
  "_links": {
    "self": { "href": "/api/jobs/{id}/history" }
  },
  "_embedded": {
    "inf:job-history": [
      {
        "id": "history-abc-123",
        "jobId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerId": "team:analytics",
        "success": true,
        "warnings": false,
        "duration": [
          "2024-02-09T08:00:00Z",
          "2024-02-09T08:00:15Z"
        ],
        "data": {},
        "progress": [
          {
            "task": { "key": "job:progress.invoking_job" },
            "result": { "key": "job:status.success", "success": true }
          }
        ],
        "createdAt": "2024-02-09T08:00:00Z"
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 150
}

---

GET /api/jobs/{id}/history/{historyId}

Get details for a specific job execution.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Job ID or natural ID
historyId	string (UUID)	History record ID

Response:

{
  "id": "history-abc-123",
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerId": "team:analytics",
  "success": true,
  "warnings": false,
  "duration": [
    "2024-02-09T08:00:00Z",
    "2024-02-09T08:00:15Z"
  ],
  "data": {},
  "progress": [
    {
      "task": {
        "key": "job:progress.invoking_job"
      },
      "result": {
        "key": "job:status.success",
        "success": true,
        "status": "success"
      }
    },
    {
      "task": {
        "key": "job:actions.send_email",
        "opts": { "name": "Send Summary Email" }
      },
      "result": {
        "message": "Email sent to 3 recipients",
        "success": true,
        "status": "success"
      }
    }
  ],
  "createdAt": "2024-02-09T08:00:00Z"
}

Progress Structure

The progress array contains a step-by-step log of the job execution. Each entry has a task (what was attempted) and a result (outcome with status: success, error, or warning).

---

DELETE /api/jobs/{id}/history/{historyId}

Delete a specific history record.

Authentication: Required

Permissions: Requires job:edit permission

Path Parameters:

Parameter	Type	Description
id	string	Job ID or natural ID
historyId	string (UUID)	History record ID

Response:

204 No Content