Drivers & Templates

Job driver discovery and configuration templates.

GET /api/job-drivers

List available job drivers.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/job-drivers" }
  },
  "_embedded": {
    "inf:job-driver": [
      {
        "id": "email",
        "name": "Email",
        "description": "Send scheduled emails"
      },
      {
        "id": "dataset-refresh",
        "name": "Dataset Refresh",
        "description": "Refresh dataset from datasource"
      },
      {
        "id": "library-sync",
        "name": "Library Sync",
        "description": "Sync library files from cloud"
      }
    ]
  },
  "start": 0,
  "count": 3,
  "total": 3
}

---

GET /api/job-drivers/{id}

Get details for a specific job driver.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Driver ID

Response:

{
  "id": "email",
  "name": "Email",
  "description": "Send scheduled emails"
}

---

GET /api/job-templates

List job templates for common configurations.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/job-templates" }
  },
  "_embedded": {
    "inf:job-template": [
      {
        "id": "daily-email-report",
        "name": "Daily Email Report",
        "type": "email",
        "interval": "0 8 * * *",
        "timezone": "America/New_York"
      },
      {
        "id": "hourly-dataset-refresh",
        "name": "Hourly Dataset Refresh",
        "type": "dataset-refresh",
        "interval": "1 hour"
      }
    ]
  },
  "start": 0,
  "count": 2,
  "total": 2
}

---

GET /api/job-action-drivers

List available action drivers.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/job-action-drivers" }
  },
  "_embedded": {
    "inf:job-action-driver": [
      {
        "id": "email",
        "name": "Email",
        "description": "Send email notification"
      },
      {
        "id": "webhook",
        "name": "Webhook",
        "description": "HTTP POST to external URL"
      },
      {
        "id": "dataset",
        "name": "Dataset",
        "description": "Perform dataset operations"
      }
    ]
  },
  "start": 0,
  "count": 3,
  "total": 3
}

---

GET /api/jobs/{id}/action-templates

List action templates for a specific job.

Authentication: Required

Path Parameters:

Parameter	Type	Description
id	string	Job ID or natural ID

Response:

{
  "_links": {
    "self": { "href": "/api/jobs/{id}/action-templates" }
  },
  "_embedded": {
    "inf:job-action-template": [
      {
        "id": "send-summary-email",
        "name": "Send Summary Email",
        "type": "email",
        "data": {
          "to": [],
          "subject": "Job Summary"
        }
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

---

GET /api/jobs/{id}/comments

List comments on a job.

Authentication: Required

Response:

{
  "_links": {
    "self": { "href": "/api/jobs/{id}/comments" }
  },
  "_embedded": {
    "inf:comment": [
      {
        "id": "comment-abc-123",
        "text": "Updated schedule to run daily",
        "username": "alice",
        "createdAt": "2024-02-09T10:00:00Z"
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

---

POST /api/jobs/{id}/comments

Add a comment to a job.

Authentication: Required

Request Body:

{
  "text": "Updated schedule to run daily"
}

Response:

201 Created