Skip to main content

Actions

Manage job actions (workflow steps) and run conditions.

GET /api/jobs/{id}/actions​

List all actions for a job.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/jobs/{id}/actions" }
  },
  "_embedded": {
    "inf:job-action": [
      {
        "id": "action-abc-123",
        "jobId": "550e8400-e29b-41d4-a716-446655440000",
        "type": "email",
        "name": "Send Summary Email",
        "order": 0,
        "data": {
          "to": ["manager@example.com"],
          "subject": "Daily Sales Summary",
          "body": "See attached report"
        }
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

POST /api/jobs/{id}/actions​

Create a new action for a job.

Authentication: Required

Permissions: Requires job:edit permission

Request Body:

FieldTypeRequiredDescription
typestringYesAction driver type
namestringYesAction name
dataobjectNoAction-specific configuration

Response:

201 Created with action details

GET /api/jobs/{id}/actions/{jobActionId}​

Get a specific action.

Authentication: Required

Response:

{
  "id": "action-abc-123",
  "type": "email",
  "name": "Send Summary Email",
  "data": { "to": ["manager@example.com"] }
}

PUT /api/jobs/{id}/actions/{jobActionId}​

Update an action.

Authentication: Required

Permissions: Requires job:edit permission

Request Body:

{
  "name": "Updated Action Name",
  "data": { "to": ["new-email@example.com"] }
}

Response:

200 OK with updated action

DELETE /api/jobs/{id}/actions/{jobActionId}​

Delete an action.

Authentication: Required

Permissions: Requires job:edit permission

Response:

204 No Content

POST /api/jobs/{id}/_job-action-order​

Reorder actions for a job.

Authentication: Required

Permissions: Requires job:edit permission

Request Body:

{
  "actions": ["action-abc-123", "action-xyz-789"]
}

Response:

200 OK

POST /api/jobs/{id}/actions/{jobActionId}/_preview​

Preview action execution without actually running it.

Authentication: Required

Response:

{
  "preview": {
    "emailSubject": "Daily Sales Summary",
    "emailBody": "...",
    "recipients": ["manager@example.com"]
  }
}

GET /api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions​

List run conditions for an action.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions" }
  },
  "_embedded": {
    "inf:job-action-run-condition": [
      {
        "id": "condition-abc-123",
        "jobActionId": "action-abc-123",
        "type": "success",
        "data": {}
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

POST /api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions​

Create a run condition for an action.

Authentication: Required

Permissions: Requires job:edit permission

Request Body:

{
  "type": "success",
  "data": {}
}

Response:

201 Created

GET /api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions/{jobActionRunConditionId}​

Get a specific run condition.

Authentication: Required

Response:

{
  "id": "condition-abc-123",
  "type": "success",
  "data": {}
}

PUT /api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions/{jobActionRunConditionId}​

Update a run condition.

Authentication: Required

Permissions: Requires job:edit permission

Response:

200 OK

DELETE /api/jobs/{id}/actions/{jobActionId}/job-action-run-conditions/{jobActionRunConditionId}​

Delete a run condition.

Authentication: Required

Permissions: Requires job:edit permission

Response:

204 No Content

GET /api/jobs/{id}/actions/{jobActionId}/action-file-contents​

Get uploaded file contents for an action.

Authentication: Required

Response:

Binary stream with file contents

PUT /api/jobs/{id}/actions/{jobActionId}/action-file-contents​

Upload a file for an action.

Authentication: Required

Permissions: Requires job:edit permission

Response:

200 OK