Skip to main content

Schema & registries

Read-only endpoints exposing a datasource's schema graph and driver metadata.

GET /api/datasources/{id}/schema.json​

The datasource's mappings-and-links graph. Pass ?download=true to receive it as a file attachment.

Get the datasource schema graphGET /api/datasources/admin:northwind/schema.json
GET /api/datasources/{id}/schema.json returns the datasource’s mappings-and-links graph. Pass ?download=true to get it as a file attachment.
Response · 200
[
{
"as": "territories",
"from": [
"public+employeeterritories"
],
"to": [
"public+territories"
],
"name": "Territories",
"type": "sql",
"defn": [
{
"toField": "TerritoryID",
"operator": "=",
"toSchema": "public",
"fromField": "TerritoryID",
"toMapping": "territories",
"fromSchema": "public",
"fromMapping": "employeeterritories"
}
]
},
{
"as": "suppliers",
"from": [
"public+products"
],
"to": [
"public+suppliers"
],
"name": "Supplier",
"type": "sql",
"defn": [
{
"toField": "SupplierID",
"operator": "=",
"toSchema": "public",
"fromField": "SupplierID",
"toMapping": "suppliers",
"fromSchema": "public",
"fromMapping": "products"
}
]
},
{
"as": "shippers",
"from": [
"public+orders"
],
"to": [
"public+shippers"
],
"name": "Shipper",
"type": "sql",
"defn": [
{
"toField": "ShipperID",
"operator": "=",
"toSchema": "public",
"fromField": "ShipVia",
"toMapping": "shippers",
"fromSchema": "public",
"fromMapping": "orders"
}
]
},
"… 9 more items (12 total) — omitted from docs"
]
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/autohint​

Suggest likely links between mappings by matching field names and types — the basis for auto-detected relationships.

Get link auto-hintsGET /api/datasources/admin:northwind/autohint
GET /api/datasources/{id}/autohint suggests likely links between mappings by matching field names/types — the basis for auto-detected relationships.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasources/admin%3Anorthwind/autohint"
}
},
"mappings": {
"usstates": {
"fields": [
{
"id": "StateID",
"name": "State"
},
{
"id": "StateName",
"name": "State Name"
},
{
"id": "StateAbbr",
"name": "State Abbr"
},
"… 1 more items (4 total) — omitted from docs"
],
"name": "Usstates"
},
"territories": {
"fields": [
{
"id": "TerritoryID",
"name": "Territory"
},
{
"id": "TerritoryDescription",
"name": "Territory Description"
},
{
"id": "RegionID",
"name": "Region"
}
],
"name": "Territories"
},
"suppliers": {
"fields": [
{
"id": "Fax",
"name": "Fax"
},
{
"id": "HomePage",
"name": "Home Page"
},
{
"id": "SupplierID",
"name": "Supplier"
},
"… 9 more items (12 total) — omitted from docs"
],
"name": "Suppliers"
},
"shippers_tmp": {
"fields": [
{
"id": "ShipperID",
"name": "Shipper"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "Phone",
"name": "Phone"
}
],
"name": "Shippers Tmp"
},
"shippers": {
"fields": [
{
"id": "ShipperID",
"name": "Shipper"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "Phone",
"name": "Phone"
}
],
"name": "Shippers"
},
"region": {
"fields": [
{
"id": "RegionID",
"name": "Region"
},
{
"id": "RegionDescription",
"name": "Region Description"
}
],
"name": "Region"
},
"products": {
"fields": [
{
"id": "ProductID",
"name": "Product"
},
{
"id": "ProductName",
"name": "Product Name"
},
{
"id": "SupplierID",
"name": "Supplier"
},
"… 7 more items (10 total) — omitted from docs"
],
"name": "Products"
},
"orders_1998": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "EmployeeID",
"name": "Employee"
},
"… 12 more items (15 total) — omitted from docs"
],
"name": "Orders 1998"
},
"orders_1997": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "EmployeeID",
"name": "Employee"
},
"… 12 more items (15 total) — omitted from docs"
],
"name": "Orders 1997"
},
"orders_1996": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "EmployeeID",
"name": "Employee"
},
"… 12 more items (15 total) — omitted from docs"
],
"name": "Orders 1996"
},
"orders": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "EmployeeID",
"name": "Employee"
},
"… 11 more items (14 total) — omitted from docs"
],
"name": "Orders"
},
"order_details_1998": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "ProductID",
"name": "Product"
},
{
"id": "UnitPrice",
"name": "Unit Price"
},
"… 3 more items (6 total) — omitted from docs"
],
"name": "Order Details 1998"
},
"order_details_1997": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "ProductID",
"name": "Product"
},
{
"id": "UnitPrice",
"name": "Unit Price"
},
"… 3 more items (6 total) — omitted from docs"
],
"name": "Order Details 1997"
},
"order_details_1996": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "ProductID",
"name": "Product"
},
{
"id": "UnitPrice",
"name": "Unit Price"
},
"… 3 more items (6 total) — omitted from docs"
],
"name": "Order Details 1996"
},
"order_details": {
"fields": [
{
"id": "OrderID",
"name": "Order"
},
{
"id": "ProductID",
"name": "Product"
},
{
"id": "UnitPrice",
"name": "Unit Price"
},
"… 2 more items (5 total) — omitted from docs"
],
"name": "Order Details"
},
"employeeterritories": {
"fields": [
{
"id": "EmployeeID",
"name": "Employee"
},
{
"id": "TerritoryID",
"name": "Territory"
}
],
"name": "Employeeterritories"
},
"employees": {
"fields": [
{
"id": "EmployeeID",
"name": "Employee"
},
{
"id": "LastName",
"name": "Last Name"
},
{
"id": "FirstName",
"name": "First Name"
},
"… 15 more items (18 total) — omitted from docs"
],
"name": "Employees"
},
"customers_1998": {
"fields": [
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "ContactName",
"name": "Contact Name"
},
"… 9 more items (12 total) — omitted from docs"
],
"name": "Customers 1998"
},
"customers_1997": {
"fields": [
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "ContactName",
"name": "Contact Name"
},
"… 9 more items (12 total) — omitted from docs"
],
"name": "Customers 1997"
},
"customers_1996": {
"fields": [
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "ContactName",
"name": "Contact Name"
},
"… 9 more items (12 total) — omitted from docs"
],
"name": "Customers 1996"
},
"customers": {
"fields": [
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "CompanyName",
"name": "Company Name"
},
{
"id": "ContactName",
"name": "Contact Name"
},
"… 8 more items (11 total) — omitted from docs"
],
"name": "Customers"
},
"customerdemographics": {
"fields": [
{
"id": "CustomerTypeID",
"name": "Customer Type"
},
{
"id": "CustomerDesc",
"name": "Customer Desc"
}
],
"name": "Customerdemographics"
},
"customercustomerdemo": {
"fields": [
{
"id": "CustomerID",
"name": "Customer"
},
{
"id": "CustomerTypeID",
"name": "Customer Type"
}
],
"name": "Customercustomerdemo"
},
"categories": {
"fields": [
{
"id": "CategoryID",
"name": "Category"
},
{
"id": "CategoryName",
"name": "Category Name"
},
{
"id": "Description",
"name": "Description"
},
"… 1 more items (4 total) — omitted from docs"
],
"name": "Categories"
}
}
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/column-types​

The column types the datasource's driver supports (used when adding or altering fields). Requires datasource:ping.

List supported column typesGET /api/datasources/admin:northwind/column-types
GET /api/datasources/{id}/column-types returns the column types the datasource’s driver supports (used when adding/altering fields). Requires datasource:ping.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasources/admin%3Anorthwind/column-types"
}
},
"items": [
"bigint",
"bigserial",
"bit",
"… 55 more items (58 total) — omitted from docs"
],
"start": 0,
"count": 58,
"total": 58
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/restricted-fields​

The fields restricted by field-level security across the datasource's shares.

List restricted fieldsGET /api/datasources/admin:northwind/restricted-fields
GET /api/datasources/{id}/restricted-fields lists the fields restricted by field-level security across the datasource’s shares.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasources/admin%3Anorthwind/restricted-fields"
}
},
"start": 0,
"count": 0,
"total": 0,
"_embedded": {
"inf:field": []
}
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/mapping-select-list​

The datasource's mappings the caller can use in the ?context= usage context (query, the default, or dataset), as full mapping rows including driver data. ?view=picker returns only the identity and visibility fields (id, restId, name, mappingId, schemaId, hidden), which keeps the list small on large schemas.

Get the mapping select listGET /api/datasources/admin:northwind/mapping-select-list?view=picker
GET /api/datasources/{id}/mapping-select-list lists the mappings the caller can use in the given ?context= (query or dataset). ?view=picker returns only identity and visibility fields for pickers; the default view returns full mapping rows, including driver data.
Response · 200
[
{
"id": "00000000-0000-4000-8000-000000000001:public+categories",
"restId": "public+categories",
"name": "Categories",
"mappingId": "categories",
"schemaId": "public",
"hidden": false
},
{
"id": "00000000-0000-4000-8000-000000000001:public+customercustomerdemo",
"restId": "public+customercustomerdemo",
"name": "Customercustomerdemo",
"mappingId": "customercustomerdemo",
"schemaId": "public",
"hidden": false
},
{
"id": "00000000-0000-4000-8000-000000000001:public+customerdemographics",
"restId": "public+customerdemographics",
"name": "Customerdemographics",
"mappingId": "customerdemographics",
"schemaId": "public",
"hidden": false
},
"… 21 more items (24 total) — omitted from docs"
]
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/settings-components​

The driver-specific settings UI components for the datasource.

List settings componentsGET /api/datasources/admin:northwind/settings-components
GET /api/datasources/{id}/settings-components returns the driver-specific settings UI components for the datasource.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasources/admin%3Anorthwind/settings-components"
}
},
"items": [],
"start": 0,
"count": 0,
"total": 0
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/datasources/{id}/web-response-parser-templates​

The response-parser templates available for a web datasource.

List web response parser templatesGET /api/datasources/admin:northwind/web-response-parser-templates
GET /api/datasources/{id}/web-response-parser-templates returns the response-parser templates available for a web datasource.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasources/admin%3Anorthwind/web-response-parser-templates"
}
},
"items": [
{
"detective": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001:0",
"value": {
"responseParserType": "default"
}
},
{
"detective": "custom-script-detective",
"id": "custom-script-detective:0",
"value": {
"responseParserType": "custom-script"
}
}
],
"start": 0,
"count": 2,
"total": 2
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/schema​

Links across the tenant, filtered by ?type= (a link type, repeatable; default all). Renders the cross-datasource schema graph.

List schema links by typeGET /api/schema
GET /api/schema returns links across the tenant filtered by ?type= (a link type, repeatable; default all). Used to render the cross-datasource schema graph.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/schema?type=all"
}
},
"00000000-0000-4000-8000-000000000001:public+products": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+products:categories",
"name": "Category",
"linkId": "categories",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+categories",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "categories",
"fromId": "00000000-0000-4000-8000-000000000001:public+products",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "products",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+products",
"00000000-0000-4000-8000-000000000001:public+categories"
]
},
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+products:suppliers",
"name": "Supplier",
"linkId": "suppliers",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+suppliers",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "suppliers",
"fromId": "00000000-0000-4000-8000-000000000001:public+products",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "products",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+products",
"00000000-0000-4000-8000-000000000001:public+suppliers"
]
}
],
"00000000-0000-4000-8000-000000000001:public+orders": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+orders:customers",
"name": "Customer",
"linkId": "customers",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+customers",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "customers",
"fromId": "00000000-0000-4000-8000-000000000001:public+orders",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "orders",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+orders",
"00000000-0000-4000-8000-000000000001:public+customers"
]
},
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+orders:employees",
"name": "Employee",
"linkId": "employees",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+employees",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "employees",
"fromId": "00000000-0000-4000-8000-000000000001:public+orders",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "orders",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+orders",
"00000000-0000-4000-8000-000000000001:public+employees"
]
},
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+orders:order-details",
"name": "Order Detail",
"linkId": "order-details",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+order_details",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "order_details",
"fromId": "00000000-0000-4000-8000-000000000001:public+orders",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "orders",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+orders",
"00000000-0000-4000-8000-000000000001:public+order_details"
]
},
"… 1 more items (4 total) — omitted from docs"
],
"00000000-0000-4000-8000-000000000001:public+customers": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+customers:customercustomerdemo",
"name": "Customercustomerdemo",
"linkId": "customercustomerdemo",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+customercustomerdemo",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "customercustomerdemo",
"fromId": "00000000-0000-4000-8000-000000000001:public+customers",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "customers",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+customers",
"00000000-0000-4000-8000-000000000001:public+customercustomerdemo"
]
}
],
"00000000-0000-4000-8000-000000000001:public+customercustomerdemo": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+customercustomerdemo:customerdemographics",
"name": "Customerdemographics",
"linkId": "customerdemographics",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+customerdemographics",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "customerdemographics",
"fromId": "00000000-0000-4000-8000-000000000001:public+customercustomerdemo",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "customercustomerdemo",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+customercustomerdemo",
"00000000-0000-4000-8000-000000000001:public+customerdemographics"
]
}
],
"00000000-0000-4000-8000-000000000001:public+employees": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+employees:employeeterritories",
"name": "Employeeterritories",
"linkId": "employeeterritories",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+employeeterritories",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "employeeterritories",
"fromId": "00000000-0000-4000-8000-000000000001:public+employees",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "employees",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+employees",
"00000000-0000-4000-8000-000000000001:public+employeeterritories"
]
}
],
"00000000-0000-4000-8000-000000000001:public+order_details": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+order_details:products",
"name": "Product",
"linkId": "products",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+products",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "products",
"fromId": "00000000-0000-4000-8000-000000000001:public+order_details",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "order_details",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+order_details",
"00000000-0000-4000-8000-000000000001:public+products"
]
}
],
"00000000-0000-4000-8000-000000000001:public+territories": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+territories:region",
"name": "Region",
"linkId": "region",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+region",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "region",
"fromId": "00000000-0000-4000-8000-000000000001:public+territories",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "territories",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+territories",
"00000000-0000-4000-8000-000000000001:public+region"
]
}
],
"00000000-0000-4000-8000-000000000001:public+employeeterritories": [
{
"type": "sql",
"id": "00000000-0000-4000-8000-000000000001:public+employeeterritories:territories",
"name": "Territories",
"linkId": "territories",
"embedded": false,
"embeddedPrefix": null,
"toId": "00000000-0000-4000-8000-000000000001:public+territories",
"toDatasourceId": "00000000-0000-4000-8000-000000000001",
"toSchemaId": "public",
"toMappingId": "territories",
"fromId": "00000000-0000-4000-8000-000000000001:public+employeeterritories",
"fromDatasourceId": "00000000-0000-4000-8000-000000000001",
"fromMappingId": "employeeterritories",
"fromSchemaId": "public",
"allMappings": [
"00000000-0000-4000-8000-000000000001:public+employeeterritories",
"00000000-0000-4000-8000-000000000001:public+territories"
]
}
]
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/web-datasource-auth-drivers​

The authentication drivers available for web datasources.

List web datasource auth driversGET /api/web-datasource-auth-drivers
GET /api/web-datasource-auth-drivers lists the authentication drivers available for web datasources.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-datasource-auth-drivers"
}
},
"start": 0,
"count": 5,
"total": 5,
"_embedded": {
"inf:driver": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-datasource-auth-drivers/basicUserCredentialAuth"
}
},
"id": "basicUserCredentialAuth",
"name": "Basic Auth",
"editComponent": "basicUserCredentialAuthEditor"
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-datasource-auth-drivers/bearerTokenAuth"
}
},
"id": "bearerTokenAuth",
"name": "Bearer Token",
"editComponent": "bearerTokenAuthEditor"
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-datasource-auth-drivers/apiKeyAuth"
}
},
"id": "apiKeyAuth",
"name": "API Key",
"editComponent": "apiKeyAuthEditor"
},
"… 2 more items (5 total) — omitted from docs"
]
}
}
Captured from the API examples test suite; ids and timestamps are normalized.

GET /api/web-response-parser-drivers​

The response-parser drivers available for web datasources.

List web response parser driversGET /api/web-response-parser-drivers
GET /api/web-response-parser-drivers lists the response-parser drivers available for web datasources.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-response-parser-drivers"
}
},
"start": 0,
"count": 5,
"total": 5,
"_embedded": {
"inf:driver": [
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-response-parser-drivers/default"
}
},
"id": "default",
"helpComponents": {
"responseParser": "defaultResponseParserHelp"
},
"name": "JSON Object Array",
"embedded": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-response-parser-drivers/jira-cloud"
}
},
"id": "jira-cloud",
"name": "JIRA Cloud",
"embedded": false
},
{
"_links": {
"self": {
"href": "https://informer.example.com/api/web-response-parser-drivers/custom-script"
}
},
"id": "custom-script",
"helpComponents": {
"responseParser": "customScriptResponseParserHelp"
},
"editComponent": "customScriptResponseParserEditor",
"name": "Custom Script",
"embedded": false
},
"… 2 more items (5 total) — omitted from docs"
]
}
}
Captured from the API examples test suite; ids and timestamps are normalized.

Binary and live routes​

These are documented by contract (no captured example):

  • GET /api/datasources/\{id\}/image and GET /api/datasource-drivers/\{id\}/image stream image bytes (the datasource/driver icon), not JSON.
  • POST /api/datasource-drivers/\{id\}/_ping dials a connection to validate it before a datasource is saved. The payload is { id?, connection?, integrationId?, integration?, options? }: a connection is dialled as given (requires datasources:create for the driver, or datasource:write when id resolves to a datasource of the same driver type), while an id without a connection pings that datasource's stored connection (requires datasource:write). An integrationId names the Integration whose access token authenticates the dial; it must be readable by the requester and able to supply a token (404/400 otherwise), except the resolved datasource's own unchanged Integration on the two branches authorized against that datasource. An integration definition that is not saved yet cannot be dialled and is reported as an unusable connection. Always responds 200 with { "status": "online" | "error", "message": ... }; read status to determine reachability.