Drivers, Templates & Comments
Job driver discovery, the starter templates for creating jobs and actions, and job comments.
GET /api/job-drivers
List the registered job drivers.
Authentication: Required
Response:
Each driver carries id, name, description, an icon, and flags (isSystemJob, isManagerOnly, usesJobTimeZone). The id is the value a job's type accepts; smart-job is the general-purpose user job.
List job driversGET /api/job-drivers
The registered job types. smart-job is the general-purpose user job; the rest are mostly system jobs (isSystemJob).
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-drivers"
}
},
"start": 0,
"count": 11,
"total": 11,
"_embedded": {
"inf:job-driver": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-drivers/dataset-refresh"
}
},
"id": "dataset-refresh",
"name": "Dataset Refresh",
"description": "Refresh an existing Dataset and update the indexed data according to the indexing configuration",
"imageSvg": "/images/icons/administration.svg",
"isSystemJob": false,
"isManagerOnly": false,
"usesJobTimeZone": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-drivers/dataset-vacuum"
}
},
"id": "dataset-vacuum",
"name": "Dataset Vacuum",
"description": "Automatically delete indexed data on your assigned Search Cluster from orphaned and expired Datasets or Queries.",
"imageSvg": "/images/job/broom.svg",
"isSystemJob": true,
"isManagerOnly": false,
"usesJobTimeZone": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-drivers/dataset-snapshot-cleanup"
}
},
"id": "dataset-snapshot-cleanup",
"name": "Snapshot Cleanup",
"description": "Automatically delete Snapshots in the system that are past their expiration date and also delete their data on your assigned Search Cluster.",
"imageSvg": "/images/job/broom.svg",
"isSystemJob": true,
"isManagerOnly": false,
"usesJobTimeZone": false
},
"… 8 more items (11 total) — omitted from docs"
]
}
}
GET /api/job-drivers/{id}
Get a single job driver.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Driver id |
Response:
Get a job driverGET /api/job-drivers/dataset-refresh
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-drivers/dataset-refresh"
}
},
"id": "dataset-refresh",
"name": "Dataset Refresh",
"description": "Refresh an existing Dataset and update the indexed data according to the indexing configuration",
"imageSvg": "/images/icons/administration.svg",
"isSystemJob": false,
"isManagerOnly": false,
"usesJobTimeZone": false
}
GET /api/job-templates
List job-creation templates.
Authentication: Required
Response:
Each item's value.job is the payload skeleton to POST to /api/jobs.
List job templatesGET /api/job-templates
Starter job configs; each item’s value.job is the payload skeleton to POST to /api/jobs.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-templates"
}
},
"items": [
{
"detective": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001:0",
"value": {
"group": "__top",
"name": "New Job",
"description": "Choose Datasets and Queries to back multiple actions, such as sending an email.",
"materialIcon": "lightbulb_outline",
"job": {
"type": "smart-job",
"data": {}
}
}
}
],
"start": 0,
"count": 1,
"total": 1
}
GET /api/job-action-drivers
List the action drivers available for smart-job actions.
Authentication: Required
Response:
List action driversGET /api/job-action-drivers
The action types available for smart-job actions.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-action-drivers"
}
},
"start": 0,
"count": 8,
"total": 8,
"_embedded": {
"inf:job-action-driver": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-action-drivers/email"
}
},
"id": "email",
"name": "Send an email",
"imageSvg": "/assets/smart-job/images/email.svg",
"editorComponent": "emailActionEditor",
"supportsUserData": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-action-drivers/burst"
}
},
"id": "burst",
"name": "Send an email burst",
"imageSvg": "/assets/smart-job/images/burst.svg",
"editorComponent": "burstActionEditor",
"supportsUserData": true
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/job-action-drivers/ftp"
}
},
"id": "ftp",
"name": "Send to FTP",
"imageSvg": "/assets/smart-job/images/ftp.svg",
"editorComponent": "ftpActionEditor",
"supportsUserData": false
},
"… 5 more items (8 total) — omitted from docs"
]
}
}
GET /api/jobs/{id}/action-templates
List the action templates for a specific job.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Job id or natural id |
Response:
List action templatesGET /api/jobs/00000000-0000-4000-8000-000000000001/action-templates
The available action types for this job, each with the skeleton action payload (value.action.type) to POST.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/action-templates"
}
},
"items": [
{
"detective": "00000000-0000-4000-8000-000000000002",
"id": "00000000-0000-4000-8000-000000000002:0",
"value": {
"group": "__top",
"name": "Send an email",
"action": {
"type": "email"
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000003",
"id": "00000000-0000-4000-8000-000000000003:0",
"value": {
"group": "__top",
"name": "Send an email burst",
"action": {
"type": "burst"
}
}
},
{
"detective": "00000000-0000-4000-8000-000000000004",
"id": "00000000-0000-4000-8000-000000000004:0",
"value": {
"group": "__top",
"name": "Send to FTP",
"action": {
"type": "ftp"
}
}
},
"… 3 more items (6 total) — omitted from docs"
],
"start": 0,
"count": 6,
"total": 6
}
GET /api/jobs/{id}/comments
List top-level comments on a job, newest first.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Job id or natural id |
Response:
A HAL collection. Each comment embeds its author (inf:user) and links to its replies.
List commentsGET /api/jobs/admin:daily-sales-report/comments
A HAL collection of top-level comments (newest first), each embedding its author.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/admin%3Adaily-sales-report/comments?sort=-createdAt&limit=0"
}
},
"start": 0,
"count": 1,
"total": 1,
"_embedded": {
"inf:comment": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/comments/00000000-0000-4000-8000-000000000001"
},
"inf:comments": {
"href": "https://informer.example.com/api/comments/00000000-0000-4000-8000-000000000001/replies"
}
},
"permissions": {
"edit": true,
"delete": true
},
"id": "00000000-0000-4000-8000-000000000001",
"message": "Bumped the schedule to 8am Eastern.",
"public": false,
"userId": "admin",
"datasetId": null,
"datasourceId": null,
"reportId": null,
"queryId": null,
"teamId": null,
"jobId": "00000000-0000-4000-8000-000000000002",
"templateId": null,
"assistantId": null,
"libraryId": null,
"mentions": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"parentId": null,
"_embedded": {
"inf:user": {
"_links": {
"self": {
"href": "https://informer.example.com/api/users/admin"
},
"inf:memberships": {
"href": "https://informer.example.com/api/users/admin/memberships"
},
"inf:avatar-upload": {
"href": "https://informer.example.com/api/users/admin/_upload/{uploadId}/avatar-upload",
"templated": true
},
"inf:password": {
"href": "https://informer.example.com/api/users/admin/password"
},
"inf:feed": {
"href": "https://informer.example.com/api/users/admin/feed"
},
"inf:viewed-feed": {
"href": "https://informer.example.com/api/users/admin/_markFeedViewed"
},
"inf:superuser": {
"href": "https://informer.example.com/api/users/admin/superuser"
}
},
"permissions": {
"changeDomain": false,
"changeProfile": true,
"changePassword": true,
"delete": false,
"edit": true,
"reassign": true,
"superuser": true,
"enable": true,
"changeTheme": true,
"lock": true,
"setGlobalPermissions": true,
"manageLogin": true
},
"domain": "local",
"username": "admin",
"displayName": "acme Administrator",
"familyName": "Administrator",
"givenName": "acme",
"middleName": null,
"email": null,
"data": null,
"superuser": true,
"timezone": "America/New_York",
"settings": {
"log": {
"log": false,
"info": false,
"warn": false,
"debug": false,
"error": true,
"remote": false
}
},
"enabled": true,
"source": null,
"sourceId": null,
"lastViewedFeed": null,
"tenant": "acme",
"globalPermissions": {
"ai": false,
"jobCreation": true,
"viewAllTeams": true,
"viewAllUsers": true,
"painlessScriptCreation": true
},
"userFields": {},
"locked": false,
"lockedAt": null,
"loginAttempts": 0,
"passwordSetAt": "2026-01-15T16:20:00.000Z",
"passwordExpiresAt": "2026-01-15T16:20:00.000Z",
"forgotPasswordRequestTime": null,
"mfa": null,
"mfaConfig": {},
"aiMessage": null,
"aiConsent": false,
"hasSharedDatasources": false,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"initials": "NA",
"colorIndex": 4,
"avatarColor": {
"background": "#81C784",
"text": "#1B5E20"
},
"managesPassword": true
}
}
}
]
}
}
POST /api/jobs/{id}/comments
Add a comment to a job.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Job id or natural id |
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Comment text |
Example:
{ "message": "Bumped the schedule to 8am Eastern." }
Response:
Responds 201 Created with the comment and a Location header.
Add a commentPOST /api/jobs/admin:daily-sales-report/comments
The body field is message (not text). Responds 201 with a Location header.
Request body
{
"message": "Bumped the schedule to 8am Eastern."
}
Response · 201
{
"_links": {
"self": {
"href": "https://informer.example.com/api/comments/00000000-0000-4000-8000-000000000001"
}
},
"permissions": {
"edit": true,
"delete": true
},
"id": "00000000-0000-4000-8000-000000000001",
"public": false,
"tenant": "acme",
"message": "Bumped the schedule to 8am Eastern.",
"jobId": "00000000-0000-4000-8000-000000000002",
"userId": "admin",
"updatedAt": "2026-01-15T16:20:00.000Z",
"createdAt": "2026-01-15T16:20:00.000Z",
"mentions": null,
"teamId": null,
"_altid": null,
"datasetId": null,
"datasourceId": null,
"reportId": null,
"queryId": null,
"parentId": null,
"templateId": null,
"assistantId": null,
"libraryId": null
}