Datasets
Associate datasets with a job. Each association has an alias the job's actions reference, and optional snapshot settings.
GET /api/jobs/{id}/datasets
List a job's dataset associations.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Job id or natural id |
Response:
A HAL collection under _embedded["inf:job-dataset"]. Each association embeds its dataset (and, for query-backed datasets, the query).
List a job’s datasetsGET /api/jobs/00000000-0000-4000-8000-000000000001/datasets
A HAL collection. Each association embeds its dataset (and, for query-backed datasets, the query). The dataset field list is omitted here for brevity.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets"
}
},
"start": 0,
"count": 1,
"total": 1,
"_embedded": {
"inf:job-dataset": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders"
}
},
"id": "00000000-0000-4000-8000-000000000002",
"index": 0,
"parallel": false,
"refresh": false,
"takeSnapshot": false,
"filter": {},
"alias": "northwindOrders",
"settings": {},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"jobId": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000003",
"reportDatasetId": null,
"reportId": null,
"report": null,
"snapshots": null,
"_embedded": {
"inf:dataset": {
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000003/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000003/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Anorthwind-orders/_edit"
}
},
"naturalId": "admin:northwind-orders",
"permissions": {
"edit": true,
"share": true,
"delete": true,
"write": true,
"addVisual": true,
"deleteVisual": true,
"changeOwner": true,
"copy": true,
"rename": true,
"refresh": true,
"modifyFlows": true,
"replaceFile": true,
"modifySettings": true,
"createDataView": true,
"assignTags": true,
"createFilter": true,
"scriptFields": true,
"setIndex": false
},
"id": "00000000-0000-4000-8000-000000000003",
"tenant": "acme",
"ownerId": "admin",
"slug": "northwind-orders",
"name": "Northwind Orders",
"description": "A dataset consisting of all orders in the northwind system (public schema)",
"embedded": false,
"esIndex": null,
"esIndexName": "northwind-orders",
"esType": "data",
"records": 2155,
"size": "524288",
"source": "northwind-datasets",
"sourceId": null,
"params": {},
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"dataExpiresAt": null,
"ttl": null,
"append": false,
"shared": false,
"timestampField": null,
"lastDurationMillis": "1500",
"windowSize": 500,
"settings": {},
"flow": [],
"esId": null,
"lastQueriedAt": "2026-01-15T16:20:00.000Z",
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": null,
"templateProcessorId": null,
"deleteDate": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": null,
"reportId": null,
"queryId": "00000000-0000-4000-8000-000000000004",
"editingId": null,
"folderId": null,
"_embedded": {
"inf:field": "(omitted)",
"inf:query": {
"_links": {
"self": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004"
},
"edit": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/_edit"
},
"inf:owner": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/owner"
},
"inf:user-settings": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/settings"
},
"inf:input-templates": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/input-templates{?dataType,wildcard}",
"templated": true
}
},
"naturalId": "00000000-0000-4000-8000-000000000004",
"fields": "(omitted)",
"permissions": {
"assignTags": true,
"changeOwner": true,
"copy": true,
"delete": true,
"edit": true,
"rename": true,
"run": true,
"share": true,
"write": true
},
"id": "00000000-0000-4000-8000-000000000004",
"tenant": "acme",
"ownerId": "admin",
"slug": null,
"name": null,
"description": null,
"shared": false,
"embedded": true,
"source": null,
"sourceId": null,
"settings": {},
"inputs": null,
"language": "informer",
"flow": [
{
"calculatedField": {
"alias": "salesperson",
"label": "Salesperson",
"script": "FirstName + ' ' + LastName"
}
},
{
"calculatedField": {
"alias": "orderAmount",
"label": "Order Amount",
"script": "UnitPrice * Quantity"
}
},
{
"calculatedField": {
"alias": "shipState",
"label": "Ship State",
"script": "ShipCountry === \"USA\" ? ShipRegion : null"
}
}
],
"payload": {
"fields": "(omitted)",
"source": {
"id": "00000000-0000-4000-8000-000000000021:public+orders",
"schemaId": "public",
"mappingId": "orders"
},
"groupBy": [],
"linkRefs": [
{
"id": "employees",
"linkId": "00000000-0000-4000-8000-000000000021:public+orders:employees",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+orders:employees",
"defn": [
{
"toField": "EmployeeID",
"operator": "=",
"toSchema": "public",
"fromField": "EmployeeID",
"toMapping": "employees",
"fromSchema": "public",
"fromMapping": "orders"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+employees",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+orders",
"linkId": "employees"
}
},
{
"id": "order-details",
"linkId": "00000000-0000-4000-8000-000000000021:public+orders:order-details",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+orders:order-details",
"defn": [
{
"toField": "OrderID",
"operator": "=",
"toSchema": "public",
"fromField": "OrderID",
"toMapping": "order_details",
"fromSchema": "public",
"fromMapping": "orders"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+order_details",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+orders",
"linkId": "order-details"
}
},
{
"id": "order-details/products",
"linkId": "00000000-0000-4000-8000-000000000021:public+order_details:products",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+order_details:products",
"defn": [
{
"toField": "ProductID",
"operator": "=",
"toSchema": "public",
"fromField": "ProductID",
"toMapping": "products",
"fromSchema": "public",
"fromMapping": "order_details"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+products",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+order_details",
"linkId": "products"
}
}
]
},
"defnUpdatedAt": null,
"limit": -1,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": "00000000-0000-4000-8000-000000000021",
"editingId": null,
"folderId": null,
"datasource": {
"defaultLinkType": "sql",
"aiSystemMessage": "This is a PostgresSQL database. Identifiers are case-sensitive by default. \n Always surround all column names, table names, and schema names in double-quotes (\"). \n For example:\n SELECT \"OrderID\", \"ShipCountry\" FROM \"public\".\"orders\" WHERE \"ShipCity\" = 'Raleigh';\n ---",
"family": "sql",
"languages": [
"informer",
"sql",
"distinctValue",
"… 2 more items (5 total) — omitted from docs"
],
"naturalId": "admin:northwind",
"image": "/opt/informer/packages/informer-server/modules/sql/images/postgres.svg",
"compatibility": [],
"permissions": {
"assignTags": true,
"edit": true,
"delete": true,
"share": true,
"write": true,
"changeOwner": true,
"ping": true,
"scan": true,
"downloadSchema": true,
"importData": true,
"importSchema": true,
"rename": true,
"editConnection": true,
"createLink": true,
"setWrite": true,
"createSuite": true,
"createFieldExpression": true,
"createMapping": false,
"bundle": true,
"query": true
},
"id": "00000000-0000-4000-8000-000000000021",
"tenant": "acme",
"ownerId": "admin",
"slug": "northwind",
"name": "Northwind",
"description": null,
"embedded": false,
"type": "postgres",
"connection": {
"host": "localhost",
"pool": {
"max": 5,
"min": 0,
"idle": 10000,
"acquire": 10000
},
"port": 5432,
"user": "northwinduser",
"database": "northwind",
"password": "encrypted:iv:0000000000000000",
"idleTimeoutMillis": 7
},
"scannedAt": "2026-01-15T16:20:00.000Z",
"schemaUpdatedAt": "2026-01-15T16:20:00.000Z",
"rescanRequired": false,
"shared": false,
"schemas": [
"public"
],
"source": null,
"sourceId": null,
"settings": {
"multiSchema": false,
"useFakeData": false,
"remoteQueryBatchSize": {
"multiKey": 500,
"singleKey": 500
},
"usePreparedStatements": false
},
"data": null,
"appId": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"folderId": null,
"fileId": null,
"shares": []
},
"_embedded": {
"inf:query-language": {
"_links": {
"self": {
"href": "https://informer.example.com/api/query-languages/informer"
}
},
"id": "informer",
"name": "common:ad_hoc_query",
"description": "query-languages:ad_hoc.description",
"image": "/assets/query-languages/images/query-designer.svg",
"color": "blue",
"preProcessors": [
"iqlTclPredicateValidationProcessor",
"resolveLinkRefProcessor",
"iqlPayloadFieldPermissionEvaluator",
"… 8 more items (11 total) — omitted from docs"
]
}
}
},
"inf:filter": "(omitted)"
}
}
}
}
]
}
}
POST /api/jobs/{id}/datasets
Associate a dataset with a job.
Authentication: Required
Permissions: Requires job:edit
Request Body:
Provide exactly one source (datasetId, queryId, or reportDatasetId).
| Field | Type | Required | Description |
|---|---|---|---|
datasetId | string | one of | Dataset id or natural id |
queryId | string | one of | Query id (creates an embedded dataset from the query) |
reportDatasetId | string | one of | Report-dataset id |
alias | string | No | Reference name (auto-generated from the source name if omitted) |
index | integer | No | Position among the job's datasets |
refresh | boolean | No | Refresh the dataset when the job runs |
parallel | boolean | No | Allow parallel refresh |
filter | object | No | Saved filter to apply |
Example:
{ "datasetId": "admin:northwind-orders" }
Response:
Responds 201 Created with the association and a Location header.
Associate a dataset with a jobPOST /api/jobs/00000000-0000-4000-8000-000000000001/datasets
Provide exactly one of datasetId, queryId, or reportDatasetId (a query creates an embedded dataset). alias is optional and auto-generated from the source name. Responds 201 with a Location header.
Request body
{
"datasetId": "admin:northwind-orders"
}
Response · 201
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders"
}
},
"id": "00000000-0000-4000-8000-000000000002",
"parallel": false,
"takeSnapshot": false,
"filter": {},
"settings": {},
"tenant": "acme",
"alias": "northwindOrders",
"index": 0,
"refresh": false,
"datasetId": "00000000-0000-4000-8000-000000000003",
"jobId": "00000000-0000-4000-8000-000000000001",
"updatedAt": "2026-01-15T16:20:00.000Z",
"createdAt": "2026-01-15T16:20:00.000Z",
"_altid": null,
"reportDatasetId": null,
"reportId": null
}
GET /api/jobs/{id}/datasets/{alias}
Get a specific dataset association.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Job id or natural id |
alias | string | Dataset alias |
Response:
Get a job datasetGET /api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders"
}
},
"id": "00000000-0000-4000-8000-000000000002",
"index": 0,
"parallel": false,
"refresh": false,
"takeSnapshot": false,
"filter": {},
"alias": "northwindOrders",
"settings": {},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"jobId": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000003",
"reportDatasetId": null,
"reportId": null,
"snapshots": null,
"_embedded": {
"inf:dataset": {
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000003/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000003/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Anorthwind-orders/_edit"
}
},
"naturalId": "admin:northwind-orders",
"permissions": {
"edit": true,
"share": true,
"delete": true,
"write": true,
"addVisual": true,
"deleteVisual": true,
"changeOwner": true,
"copy": true,
"rename": true,
"refresh": true,
"modifyFlows": true,
"replaceFile": true,
"modifySettings": true,
"createDataView": true,
"assignTags": true,
"createFilter": true,
"scriptFields": true,
"setIndex": false
},
"id": "00000000-0000-4000-8000-000000000003",
"tenant": "acme",
"ownerId": "admin",
"slug": "northwind-orders",
"name": "Northwind Orders",
"description": "A dataset consisting of all orders in the northwind system (public schema)",
"embedded": false,
"esIndex": null,
"esIndexName": "northwind-orders",
"esType": "data",
"records": 2155,
"size": "524288",
"source": "northwind-datasets",
"sourceId": null,
"params": {},
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"dataExpiresAt": null,
"ttl": null,
"append": false,
"shared": false,
"timestampField": null,
"lastDurationMillis": "1500",
"windowSize": 500,
"settings": {},
"flow": [],
"esId": null,
"lastQueriedAt": "2026-01-15T16:20:00.000Z",
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": null,
"templateProcessorId": null,
"deleteDate": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": null,
"reportId": null,
"queryId": "00000000-0000-4000-8000-000000000004",
"editingId": null,
"folderId": null,
"_embedded": {
"inf:field": "(omitted)",
"inf:query": {
"_links": {
"self": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004"
},
"edit": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/_edit"
},
"inf:owner": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/owner"
},
"inf:user-settings": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/settings"
},
"inf:input-templates": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000004/input-templates{?dataType,wildcard}",
"templated": true
}
},
"naturalId": "00000000-0000-4000-8000-000000000004",
"fields": "(omitted)",
"permissions": {
"assignTags": true,
"changeOwner": true,
"copy": true,
"delete": true,
"edit": true,
"rename": true,
"run": true,
"share": true,
"write": true
},
"id": "00000000-0000-4000-8000-000000000004",
"tenant": "acme",
"ownerId": "admin",
"slug": null,
"name": null,
"description": null,
"shared": false,
"embedded": true,
"source": null,
"sourceId": null,
"settings": {},
"inputs": null,
"language": "informer",
"flow": [
{
"calculatedField": {
"alias": "salesperson",
"label": "Salesperson",
"script": "FirstName + ' ' + LastName"
}
},
{
"calculatedField": {
"alias": "orderAmount",
"label": "Order Amount",
"script": "UnitPrice * Quantity"
}
},
{
"calculatedField": {
"alias": "shipState",
"label": "Ship State",
"script": "ShipCountry === \"USA\" ? ShipRegion : null"
}
}
],
"payload": {
"fields": "(omitted)",
"source": {
"id": "00000000-0000-4000-8000-000000000021:public+orders",
"schemaId": "public",
"mappingId": "orders"
},
"groupBy": [],
"linkRefs": [
{
"id": "employees",
"linkId": "00000000-0000-4000-8000-000000000021:public+orders:employees",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+orders:employees",
"defn": [
{
"toField": "EmployeeID",
"operator": "=",
"toSchema": "public",
"fromField": "EmployeeID",
"toMapping": "employees",
"fromSchema": "public",
"fromMapping": "orders"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+employees",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+orders",
"linkId": "employees"
}
},
{
"id": "order-details",
"linkId": "00000000-0000-4000-8000-000000000021:public+orders:order-details",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+orders:order-details",
"defn": [
{
"toField": "OrderID",
"operator": "=",
"toSchema": "public",
"fromField": "OrderID",
"toMapping": "order_details",
"fromSchema": "public",
"fromMapping": "orders"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+order_details",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+orders",
"linkId": "order-details"
}
},
{
"id": "order-details/products",
"linkId": "00000000-0000-4000-8000-000000000021:public+order_details:products",
"details": {
"id": "00000000-0000-4000-8000-000000000021:public+order_details:products",
"defn": [
{
"toField": "ProductID",
"operator": "=",
"toSchema": "public",
"fromField": "ProductID",
"toMapping": "products",
"fromSchema": "public",
"fromMapping": "order_details"
}
],
"toId": "00000000-0000-4000-8000-000000000021:public+products",
"type": "sql",
"fromId": "00000000-0000-4000-8000-000000000021:public+order_details",
"linkId": "products"
}
}
]
},
"defnUpdatedAt": null,
"limit": -1,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": "00000000-0000-4000-8000-000000000021",
"editingId": null,
"folderId": null,
"datasource": {
"defaultLinkType": "sql",
"aiSystemMessage": "This is a PostgresSQL database. Identifiers are case-sensitive by default. \n Always surround all column names, table names, and schema names in double-quotes (\"). \n For example:\n SELECT \"OrderID\", \"ShipCountry\" FROM \"public\".\"orders\" WHERE \"ShipCity\" = 'Raleigh';\n ---",
"family": "sql",
"languages": [
"informer",
"sql",
"distinctValue",
"… 2 more items (5 total) — omitted from docs"
],
"naturalId": "admin:northwind",
"image": "/opt/informer/packages/informer-server/modules/sql/images/postgres.svg",
"compatibility": [],
"permissions": {
"assignTags": true,
"edit": true,
"delete": true,
"share": true,
"write": true,
"changeOwner": true,
"ping": true,
"scan": true,
"downloadSchema": true,
"importData": true,
"importSchema": true,
"rename": true,
"editConnection": true,
"createLink": true,
"setWrite": true,
"createSuite": true,
"createFieldExpression": true,
"createMapping": false,
"bundle": true,
"query": true
},
"id": "00000000-0000-4000-8000-000000000021",
"tenant": "acme",
"ownerId": "admin",
"slug": "northwind",
"name": "Northwind",
"description": null,
"embedded": false,
"type": "postgres",
"connection": {
"host": "localhost",
"pool": {
"max": 5,
"min": 0,
"idle": 10000,
"acquire": 10000
},
"port": 5432,
"user": "northwinduser",
"database": "northwind",
"password": "encrypted:iv:0000000000000000",
"idleTimeoutMillis": 7
},
"scannedAt": "2026-01-15T16:20:00.000Z",
"schemaUpdatedAt": "2026-01-15T16:20:00.000Z",
"rescanRequired": false,
"shared": false,
"schemas": [
"public"
],
"source": null,
"sourceId": null,
"settings": {
"multiSchema": false,
"useFakeData": false,
"remoteQueryBatchSize": {
"multiKey": 500,
"singleKey": 500
},
"usePreparedStatements": false
},
"data": null,
"appId": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"folderId": null,
"fileId": null,
"shares": []
},
"_embedded": {
"inf:query-language": {
"_links": {
"self": {
"href": "https://informer.example.com/api/query-languages/informer"
}
},
"id": "informer",
"name": "common:ad_hoc_query",
"description": "query-languages:ad_hoc.description",
"image": "/assets/query-languages/images/query-designer.svg",
"color": "blue",
"preProcessors": [
"iqlTclPredicateValidationProcessor",
"resolveLinkRefProcessor",
"iqlPayloadFieldPermissionEvaluator",
"… 8 more items (11 total) — omitted from docs"
]
}
}
},
"inf:filter": "(omitted)"
}
}
}
}
PUT /api/jobs/{id}/datasets/{alias}
Update a dataset association (upsert).
Authentication: Required
Permissions: Requires job:edit
Request Body:
| Field | Type | Description |
|---|---|---|
alias | string | Rename the alias |
refresh / parallel | boolean | Refresh behavior |
takeSnapshot | boolean | Snapshot on this run |
filter | object | Saved filter |
index | number | Position |
snapshots | object | Snapshot settings: { includeLatest, type, n, snapshotDatasets } |
Example:
{ "refresh": true }
Response:
Responds 200 with the updated association.
Update a job datasetPUT /api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders
Rename the alias, toggle refresh/parallel, set a filter, or configure snapshots.
Request body
{
"refresh": true
}
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders"
}
},
"id": "00000000-0000-4000-8000-000000000002",
"index": 0,
"parallel": false,
"refresh": true,
"takeSnapshot": false,
"filter": {},
"alias": "northwindOrders",
"settings": {},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"jobId": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000003",
"reportDatasetId": null,
"reportId": null,
"snapshots": null
}
DELETE /api/jobs/{id}/datasets/{alias}
Remove a dataset association from a job.
Authentication: Required
Permissions: Requires job:edit
Response:
Responds 200 with an empty body.
Remove a dataset from a jobDELETE /api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders
Responds 200 with an empty body.
Response · 200 · no body
PUT /api/jobs/{id}/datasets/{alias}/change-ownership
Reassign the association's underlying dataset to a new owner (and clear the association's settings/filter).
Authentication: Required
Permissions: Requires job:changeOwner
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | New owner (a username or team id) |
{ "owner": "annie.larson" }
Response:
Responds 200 with the updated association.
Reassign a job dataset’s ownerPUT /api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders/change-ownership
Body is { owner } (a username or team id). Reassigns the underlying dataset and clears the association’s settings/filter.
Request body
{
"owner": "admin"
}
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders/change-ownership"
}
},
"id": "00000000-0000-4000-8000-000000000002",
"index": 0,
"parallel": false,
"refresh": true,
"takeSnapshot": false,
"filter": {
"chips": []
},
"alias": "northwindOrders",
"settings": {},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"jobId": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000003",
"reportDatasetId": null,
"reportId": null,
"snapshots": null
}
GET /api/jobs/{id}/datasets/{alias}/permissions
Get the effective dataset permissions of the job owner and the dataset owner. These decide whether the job may refresh the dataset on the owner's behalf.
Authentication: Required
Response:
Get effective permissionsGET /api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders/permissions
The dataset permissions of the job owner and the dataset owner, used to decide whether the job can refresh the dataset on its behalf.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/jobs/00000000-0000-4000-8000-000000000001/datasets/northwindOrders/permissions"
}
},
"jobOwnerPermissions": {},
"datasetOwnerPermissions": {
"edit": true,
"share": true,
"delete": true,
"write": true,
"addVisual": true,
"deleteVisual": true,
"changeOwner": true,
"copy": true,
"rename": true,
"refresh": true,
"modifyFlows": true,
"replaceFile": true,
"modifySettings": true,
"createDataView": true,
"assignTags": true,
"createFilter": true,
"scriptFields": true,
"setIndex": false
}
}