2022-02-16 17:42:50 +01:00
|
|
|
{
|
|
|
|
|
"openapi": "3.0.0",
|
|
|
|
|
"info": {
|
|
|
|
|
"title": "Budibase API",
|
|
|
|
|
"description": "The public API for Budibase apps and its services.",
|
|
|
|
|
"version": "1.0.0"
|
|
|
|
|
},
|
|
|
|
|
"servers": [
|
|
|
|
|
{
|
2022-02-17 19:58:09 +01:00
|
|
|
"url": "http://budibase.app/api/public/v1",
|
2022-02-16 17:42:50 +01:00
|
|
|
"description": "Budibase Cloud API"
|
2022-02-17 13:40:08 +01:00
|
|
|
},
|
|
|
|
|
{
|
2022-02-17 19:58:09 +01:00
|
|
|
"url": "{protocol}://{hostname}:10000/api/public/v1",
|
2022-02-17 13:40:08 +01:00
|
|
|
"description": "Budibase self hosted API"
|
2022-02-16 17:42:50 +01:00
|
|
|
}
|
|
|
|
|
],
|
2022-02-17 19:58:09 +01:00
|
|
|
"components": {
|
2022-02-17 20:55:37 +01:00
|
|
|
"parameters": {
|
|
|
|
|
"tableId": {
|
|
|
|
|
"in": "path",
|
|
|
|
|
"name": "tableId",
|
|
|
|
|
"required": true,
|
2022-02-18 16:47:15 +01:00
|
|
|
"description": "The ID of the table which this request is targeting.",
|
|
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"rowId": {
|
|
|
|
|
"in": "path",
|
|
|
|
|
"name": "rowId",
|
|
|
|
|
"required": true,
|
|
|
|
|
"description": "The ID of the row which this request is targeting.",
|
2022-02-17 20:55:37 +01:00
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
2022-02-18 18:44:08 +01:00
|
|
|
},
|
|
|
|
|
"appId": {
|
|
|
|
|
"in": "header",
|
2022-02-18 18:54:03 +01:00
|
|
|
"name": "x-budibase-app-id",
|
2022-02-18 18:44:08 +01:00
|
|
|
"required": true,
|
|
|
|
|
"description": "The ID of the app which this request is targeting.",
|
|
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
2022-02-21 20:04:13 +01:00
|
|
|
},
|
|
|
|
|
"appIdUrl": {
|
|
|
|
|
"in": "path",
|
|
|
|
|
"name": "appId",
|
|
|
|
|
"required": true,
|
|
|
|
|
"description": "The ID of the app which this request is targeting.",
|
|
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"queryId": {
|
|
|
|
|
"in": "path",
|
|
|
|
|
"name": "queryId",
|
|
|
|
|
"required": true,
|
|
|
|
|
"description": "The ID of the query which this request is targeting.",
|
|
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"userId": {
|
|
|
|
|
"in": "path",
|
|
|
|
|
"name": "userId",
|
|
|
|
|
"required": true,
|
|
|
|
|
"description": "The ID of the user which this request is targeting.",
|
|
|
|
|
"schema": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
2022-02-17 20:55:37 +01:00
|
|
|
}
|
|
|
|
|
},
|
2022-02-17 19:58:09 +01:00
|
|
|
"examples": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"application": {
|
2022-02-17 19:58:09 +01:00
|
|
|
"value": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"application": {
|
|
|
|
|
"_id": "app_metadata",
|
|
|
|
|
"appId": "app_dev_957b12f943d348faa61db7e18e088d0f",
|
|
|
|
|
"version": "1.0.58-alpha.0",
|
|
|
|
|
"name": "App name",
|
|
|
|
|
"url": "/app-url",
|
|
|
|
|
"tenantId": "default",
|
|
|
|
|
"updatedAt": "2022-02-22T13:00:54.035Z",
|
|
|
|
|
"createdAt": "2022-02-11T18:02:26.961Z",
|
|
|
|
|
"status": "development",
|
|
|
|
|
"lockedBy": {
|
|
|
|
|
"_id": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"email": "test@test.com",
|
|
|
|
|
"roles": {
|
|
|
|
|
"app_957b12f943d348faa61db7e18e088d0f": "BASIC"
|
2022-02-18 18:44:08 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"builder": {
|
|
|
|
|
"global": false
|
2022-02-18 18:44:08 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"admin": {
|
|
|
|
|
"global": true
|
|
|
|
|
},
|
|
|
|
|
"tenantId": "default",
|
|
|
|
|
"status": "active",
|
|
|
|
|
"budibaseAccess": true,
|
|
|
|
|
"csrfToken": "9c70291d-7137-48f9-9166-99ab5473a3d4",
|
|
|
|
|
"userId": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"roleId": "ADMIN",
|
|
|
|
|
"role": {
|
|
|
|
|
"_id": "ADMIN",
|
|
|
|
|
"name": "Admin",
|
|
|
|
|
"permissionId": "admin",
|
|
|
|
|
"inherits": "POWER"
|
2022-02-18 18:44:08 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-02-22 15:10:01 +01:00
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"applications": {
|
2022-02-22 15:10:01 +01:00
|
|
|
"value": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"applications": [
|
2022-02-22 15:10:01 +01:00
|
|
|
{
|
2022-02-22 16:06:08 +01:00
|
|
|
"_id": "app_metadata",
|
|
|
|
|
"appId": "app_dev_957b12f943d348faa61db7e18e088d0f",
|
|
|
|
|
"version": "1.0.58-alpha.0",
|
|
|
|
|
"name": "App name",
|
|
|
|
|
"url": "/app-url",
|
|
|
|
|
"tenantId": "default",
|
|
|
|
|
"updatedAt": "2022-02-22T13:00:54.035Z",
|
|
|
|
|
"createdAt": "2022-02-11T18:02:26.961Z",
|
|
|
|
|
"status": "development",
|
|
|
|
|
"lockedBy": {
|
|
|
|
|
"_id": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"email": "test@test.com",
|
|
|
|
|
"roles": {
|
|
|
|
|
"app_957b12f943d348faa61db7e18e088d0f": "BASIC"
|
2022-02-22 15:10:01 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"builder": {
|
|
|
|
|
"global": false
|
2022-02-22 15:10:01 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"admin": {
|
|
|
|
|
"global": true
|
|
|
|
|
},
|
|
|
|
|
"tenantId": "default",
|
|
|
|
|
"status": "active",
|
|
|
|
|
"budibaseAccess": true,
|
|
|
|
|
"csrfToken": "9c70291d-7137-48f9-9166-99ab5473a3d4",
|
|
|
|
|
"userId": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"roleId": "ADMIN",
|
|
|
|
|
"role": {
|
|
|
|
|
"_id": "ADMIN",
|
|
|
|
|
"name": "Admin",
|
|
|
|
|
"permissionId": "admin",
|
|
|
|
|
"inherits": "POWER"
|
2022-02-22 15:10:01 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2022-02-18 18:44:08 +01:00
|
|
|
},
|
|
|
|
|
"inputRow": {
|
|
|
|
|
"value": {
|
|
|
|
|
"_id": "ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4",
|
|
|
|
|
"type": "row",
|
|
|
|
|
"tableId": "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
|
"name": "Mike",
|
|
|
|
|
"age": 30,
|
|
|
|
|
"relationship": [
|
|
|
|
|
"ro_ta_..."
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-18 16:47:15 +01:00
|
|
|
"row": {
|
|
|
|
|
"value": {
|
2022-02-22 15:10:01 +01:00
|
|
|
"row": {
|
|
|
|
|
"_id": "ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4",
|
|
|
|
|
"type": "row",
|
|
|
|
|
"tableId": "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
|
"name": "Mike",
|
|
|
|
|
"age": 30,
|
|
|
|
|
"relationship": [
|
|
|
|
|
{
|
|
|
|
|
"primaryDisplay": "Joe",
|
|
|
|
|
"_id": "ro_ta_..."
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2022-02-18 16:47:15 +01:00
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 15:10:01 +01:00
|
|
|
"rows": {
|
2022-02-18 16:47:15 +01:00
|
|
|
"value": {
|
|
|
|
|
"rows": [
|
|
|
|
|
{
|
|
|
|
|
"_id": "ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4",
|
|
|
|
|
"type": "row",
|
|
|
|
|
"tableId": "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
|
"name": "Mike",
|
|
|
|
|
"age": 30,
|
|
|
|
|
"relationship": [
|
|
|
|
|
{
|
|
|
|
|
"primaryDisplay": "Joe",
|
|
|
|
|
"_id": "ro_ta_..."
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"hasNextPage": true,
|
|
|
|
|
"bookmark": 10
|
|
|
|
|
}
|
2022-02-22 15:10:01 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"table": {
|
2022-02-22 15:10:01 +01:00
|
|
|
"value": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"table": {
|
|
|
|
|
"_id": "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
|
"name": "People",
|
|
|
|
|
"schema": {
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"name": "name"
|
|
|
|
|
},
|
|
|
|
|
"age": {
|
|
|
|
|
"type": "number",
|
|
|
|
|
"name": "age"
|
|
|
|
|
},
|
|
|
|
|
"relationship": {
|
|
|
|
|
"type": "link",
|
|
|
|
|
"name": "relationship",
|
|
|
|
|
"tableId": "ta_...",
|
|
|
|
|
"fieldName": "relatedColumn",
|
|
|
|
|
"relationshipType": "many-to-many"
|
|
|
|
|
}
|
2022-02-22 15:10:01 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"tables": {
|
2022-02-22 15:10:01 +01:00
|
|
|
"value": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"tables": [
|
2022-02-22 15:10:01 +01:00
|
|
|
{
|
2022-02-22 16:06:08 +01:00
|
|
|
"_id": "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
|
"name": "People",
|
|
|
|
|
"schema": {
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"name": "name"
|
|
|
|
|
},
|
|
|
|
|
"age": {
|
|
|
|
|
"type": "number",
|
|
|
|
|
"name": "age"
|
|
|
|
|
},
|
|
|
|
|
"relationship": {
|
|
|
|
|
"type": "link",
|
|
|
|
|
"name": "relationship",
|
|
|
|
|
"tableId": "ta_...",
|
|
|
|
|
"fieldName": "relatedColumn",
|
|
|
|
|
"relationshipType": "many-to-many"
|
|
|
|
|
}
|
2022-02-22 15:10:01 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"query": {
|
|
|
|
|
"value": {
|
|
|
|
|
"query": {
|
|
|
|
|
"_id": "query_datasource_plus_4d8be0c506b9465daf4bf84d890fdab6_454854487c574d45bc4029b1e153219e",
|
|
|
|
|
"datasourceId": "datasource_plus_4d8be0c506b9465daf4bf84d890fdab6",
|
|
|
|
|
"parameters": [],
|
|
|
|
|
"fields": {
|
|
|
|
|
"sql": "select * from persons"
|
|
|
|
|
},
|
|
|
|
|
"queryVerb": "read",
|
|
|
|
|
"name": "Help",
|
|
|
|
|
"schema": {
|
|
|
|
|
"personid": {
|
|
|
|
|
"name": "personid",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"lastname": {
|
|
|
|
|
"name": "lastname",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"firstname": {
|
|
|
|
|
"name": "firstname",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"address": {
|
|
|
|
|
"name": "address",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"city": {
|
|
|
|
|
"name": "city",
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"transformer": "return data",
|
|
|
|
|
"readable": true
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"queries": {
|
|
|
|
|
"value": {
|
|
|
|
|
"queries": [
|
|
|
|
|
{
|
|
|
|
|
"_id": "query_datasource_plus_4d8be0c506b9465daf4bf84d890fdab6_454854487c574d45bc4029b1e153219e",
|
|
|
|
|
"datasourceId": "datasource_plus_4d8be0c506b9465daf4bf84d890fdab6",
|
|
|
|
|
"parameters": [],
|
|
|
|
|
"fields": {
|
|
|
|
|
"sql": "select * from persons"
|
|
|
|
|
},
|
|
|
|
|
"queryVerb": "read",
|
|
|
|
|
"name": "Help",
|
|
|
|
|
"schema": {
|
|
|
|
|
"personid": {
|
|
|
|
|
"name": "personid",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"lastname": {
|
|
|
|
|
"name": "lastname",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"firstname": {
|
|
|
|
|
"name": "firstname",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"address": {
|
|
|
|
|
"name": "address",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"city": {
|
|
|
|
|
"name": "city",
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"transformer": "return data",
|
|
|
|
|
"readable": true
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-23 19:31:32 +01:00
|
|
|
"restResponse": {
|
|
|
|
|
"value": {
|
|
|
|
|
"data": [
|
|
|
|
|
{
|
|
|
|
|
"value": "<html lang='en-GB'></html>"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"pagination": {
|
|
|
|
|
"cursor": "2"
|
|
|
|
|
},
|
|
|
|
|
"raw": "<html lang='en-GB'></html>",
|
|
|
|
|
"headers": {
|
|
|
|
|
"content-type": "text/html; charset=ISO-8859-1"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"sqlResponse": {
|
|
|
|
|
"value": {
|
|
|
|
|
"data": [
|
|
|
|
|
{
|
|
|
|
|
"personid": 1,
|
|
|
|
|
"lastname": "Hughes",
|
|
|
|
|
"firstname": "Mike",
|
|
|
|
|
"address": "123 Fake Street",
|
|
|
|
|
"city": "Belfast"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"personid": 2,
|
|
|
|
|
"lastname": "Smith",
|
|
|
|
|
"firstname": "John",
|
|
|
|
|
"address": "64 Updown Road",
|
|
|
|
|
"city": "Dublin"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"user": {
|
2022-02-22 15:10:01 +01:00
|
|
|
"value": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"user": {
|
|
|
|
|
"_id": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"email": "test@test.com",
|
|
|
|
|
"roles": {
|
|
|
|
|
"app_957b12f943d348faa61db7e18e088d0f": "BASIC"
|
|
|
|
|
},
|
|
|
|
|
"builder": {
|
|
|
|
|
"global": false
|
|
|
|
|
},
|
|
|
|
|
"admin": {
|
|
|
|
|
"global": true
|
|
|
|
|
},
|
2022-02-22 15:10:01 +01:00
|
|
|
"tenantId": "default",
|
2022-02-22 16:06:08 +01:00
|
|
|
"status": "active",
|
|
|
|
|
"budibaseAccess": true,
|
|
|
|
|
"csrfToken": "9c70291d-7137-48f9-9166-99ab5473a3d4",
|
|
|
|
|
"userId": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"roleId": "ADMIN",
|
|
|
|
|
"role": {
|
|
|
|
|
"_id": "ADMIN",
|
|
|
|
|
"name": "Admin",
|
|
|
|
|
"permissionId": "admin",
|
|
|
|
|
"inherits": "POWER"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"users": {
|
|
|
|
|
"value": {
|
|
|
|
|
"users": [
|
|
|
|
|
{
|
2022-02-22 15:10:01 +01:00
|
|
|
"_id": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"email": "test@test.com",
|
|
|
|
|
"roles": {
|
|
|
|
|
"app_957b12f943d348faa61db7e18e088d0f": "BASIC"
|
|
|
|
|
},
|
|
|
|
|
"builder": {
|
|
|
|
|
"global": false
|
|
|
|
|
},
|
|
|
|
|
"admin": {
|
|
|
|
|
"global": true
|
|
|
|
|
},
|
|
|
|
|
"tenantId": "default",
|
|
|
|
|
"status": "active",
|
|
|
|
|
"budibaseAccess": true,
|
|
|
|
|
"csrfToken": "9c70291d-7137-48f9-9166-99ab5473a3d4",
|
|
|
|
|
"userId": "us_693a73206518477283a8d5ae31103252",
|
|
|
|
|
"roleId": "ADMIN",
|
|
|
|
|
"role": {
|
|
|
|
|
"_id": "ADMIN",
|
|
|
|
|
"name": "Admin",
|
|
|
|
|
"permissionId": "admin",
|
|
|
|
|
"inherits": "POWER"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2022-02-18 16:47:15 +01:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"securitySchemes": {
|
|
|
|
|
"ApiKeyAuth": {
|
|
|
|
|
"type": "apiKey",
|
|
|
|
|
"in": "header",
|
|
|
|
|
"name": "x-budibase-api-key",
|
|
|
|
|
"description": "Your individual API key, this will provide access based on the configured RBAC settings of your user."
|
2022-02-17 19:58:09 +01:00
|
|
|
}
|
2022-02-18 18:44:08 +01:00
|
|
|
},
|
|
|
|
|
"schemas": {
|
2022-02-22 16:06:08 +01:00
|
|
|
"application": {
|
|
|
|
|
"type": "object",
|
2022-02-24 16:42:59 +01:00
|
|
|
"properties": {
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"required": true
|
|
|
|
|
},
|
|
|
|
|
"url": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-02-22 16:06:08 +01:00
|
|
|
},
|
|
|
|
|
"applicationOutput": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"application": {
|
|
|
|
|
"type": "object",
|
2022-02-24 16:42:59 +01:00
|
|
|
"properties": {
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"required": true
|
|
|
|
|
},
|
|
|
|
|
"url": {
|
|
|
|
|
"type": "string"
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-02-22 16:06:08 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-18 18:44:08 +01:00
|
|
|
"row": {
|
|
|
|
|
"description": "The row to be created/updated, based on the table schema.",
|
|
|
|
|
"type": "object",
|
|
|
|
|
"additionalProperties": {
|
|
|
|
|
"oneOf": [
|
|
|
|
|
{
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "integer"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "array"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "boolean"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2022-02-18 19:06:58 +01:00
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"rowOutput": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"row": {
|
|
|
|
|
"description": "The row to be created/updated, based on the table schema.",
|
|
|
|
|
"type": "object",
|
|
|
|
|
"additionalProperties": {
|
|
|
|
|
"oneOf": [
|
|
|
|
|
{
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "integer"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "array"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "boolean"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-18 19:06:58 +01:00
|
|
|
"table": {
|
|
|
|
|
"description": "The table to be created/updated.",
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"name": {
|
|
|
|
|
"description": "The name of the table",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
2022-02-21 17:37:02 +01:00
|
|
|
"primaryDisplay": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column which should be used in relationship tags when relating to this table."
|
|
|
|
|
},
|
2022-02-18 19:06:58 +01:00
|
|
|
"schema": {
|
2022-02-21 17:37:02 +01:00
|
|
|
"oneOf": [
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"link"
|
|
|
|
|
],
|
|
|
|
|
"description": "A relationship column."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
},
|
|
|
|
|
"fieldName": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column which a relationship column is related to in another table."
|
|
|
|
|
},
|
|
|
|
|
"tableId": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The ID of the table which a relationship column is related to."
|
|
|
|
|
},
|
|
|
|
|
"relationshipType": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"one-to-many",
|
|
|
|
|
"many-to-one",
|
|
|
|
|
"many-to-many"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines the type of relationship that this column will be used for."
|
|
|
|
|
},
|
|
|
|
|
"through": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that contains many to many relationships this defines the table the relationships are linked through."
|
|
|
|
|
},
|
|
|
|
|
"foreignKey": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that contains a one to many relationship this defines the foreign key."
|
|
|
|
|
},
|
|
|
|
|
"throughFrom": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for this table."
|
|
|
|
|
},
|
|
|
|
|
"throughTo": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"formula"
|
|
|
|
|
],
|
|
|
|
|
"description": "A formula column."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
},
|
|
|
|
|
"formula": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format."
|
|
|
|
|
},
|
|
|
|
|
"formulaType": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"static",
|
|
|
|
|
"dynamic"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines whether this is a static or dynamic formula."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"longform",
|
|
|
|
|
"options",
|
|
|
|
|
"number",
|
|
|
|
|
"boolean",
|
|
|
|
|
"array",
|
|
|
|
|
"datetime",
|
|
|
|
|
"attachment",
|
|
|
|
|
"link",
|
|
|
|
|
"formula",
|
|
|
|
|
"auto",
|
|
|
|
|
"json",
|
|
|
|
|
"internal"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines the type of the column, most explain themselves, a link column is a relationship."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
}
|
2022-02-18 19:06:58 +01:00
|
|
|
}
|
|
|
|
|
}
|
2022-02-21 17:37:02 +01:00
|
|
|
]
|
2022-02-18 19:06:58 +01:00
|
|
|
}
|
|
|
|
|
}
|
2022-02-21 20:04:13 +01:00
|
|
|
},
|
2022-02-22 15:10:01 +01:00
|
|
|
"tableOutput": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"table": {
|
|
|
|
|
"description": "The table to be created/updated.",
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"name": {
|
|
|
|
|
"description": "The name of the table",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
"primaryDisplay": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column which should be used in relationship tags when relating to this table."
|
|
|
|
|
},
|
|
|
|
|
"schema": {
|
|
|
|
|
"oneOf": [
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"link"
|
|
|
|
|
],
|
|
|
|
|
"description": "A relationship column."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
},
|
|
|
|
|
"fieldName": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column which a relationship column is related to in another table."
|
|
|
|
|
},
|
|
|
|
|
"tableId": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The ID of the table which a relationship column is related to."
|
|
|
|
|
},
|
|
|
|
|
"relationshipType": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"one-to-many",
|
|
|
|
|
"many-to-one",
|
|
|
|
|
"many-to-many"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines the type of relationship that this column will be used for."
|
|
|
|
|
},
|
|
|
|
|
"through": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that contains many to many relationships this defines the table the relationships are linked through."
|
|
|
|
|
},
|
|
|
|
|
"foreignKey": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that contains a one to many relationship this defines the foreign key."
|
|
|
|
|
},
|
|
|
|
|
"throughFrom": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for this table."
|
|
|
|
|
},
|
|
|
|
|
"throughTo": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"formula"
|
|
|
|
|
],
|
|
|
|
|
"description": "A formula column."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
},
|
|
|
|
|
"formula": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format."
|
|
|
|
|
},
|
|
|
|
|
"formulaType": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"static",
|
|
|
|
|
"dynamic"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines whether this is a static or dynamic formula."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"longform",
|
|
|
|
|
"options",
|
|
|
|
|
"number",
|
|
|
|
|
"boolean",
|
|
|
|
|
"array",
|
|
|
|
|
"datetime",
|
|
|
|
|
"attachment",
|
|
|
|
|
"link",
|
|
|
|
|
"formula",
|
|
|
|
|
"auto",
|
|
|
|
|
"json",
|
|
|
|
|
"internal"
|
|
|
|
|
],
|
|
|
|
|
"description": "Defines the type of the column, most explain themselves, a link column is a relationship."
|
|
|
|
|
},
|
|
|
|
|
"constraints": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"description": "A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
|
"properties": {
|
|
|
|
|
"type": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"enum": [
|
|
|
|
|
"string",
|
|
|
|
|
"number",
|
|
|
|
|
"object",
|
|
|
|
|
"boolean"
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
"presence": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is required or not."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name of the column."
|
|
|
|
|
},
|
|
|
|
|
"autocolumn": {
|
|
|
|
|
"type": "boolean",
|
|
|
|
|
"description": "Defines whether the column is automatically generated."
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 16:06:08 +01:00
|
|
|
"query": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {}
|
|
|
|
|
},
|
|
|
|
|
"user": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {}
|
|
|
|
|
},
|
2022-02-22 15:10:01 +01:00
|
|
|
"userOutput": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"user": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-02-22 15:28:57 +01:00
|
|
|
"nameSearch": {
|
|
|
|
|
"type": "object",
|
|
|
|
|
"properties": {
|
|
|
|
|
"name": {
|
|
|
|
|
"type": "string",
|
|
|
|
|
"description": "The name to be used when searching - this will be used in a case insensitive starts with match."
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-02-18 18:44:08 +01:00
|
|
|
}
|
2022-02-17 19:58:09 +01:00
|
|
|
}
|
|
|
|
|
},
|
2022-02-18 16:47:15 +01:00
|
|
|
"security": [
|
|
|
|
|
{
|
|
|
|
|
"ApiKeyAuth": []
|
|
|
|
|
}
|
|
|
|
|
],
|
2022-02-24 16:42:59 +01:00
|
|
|
"paths": {},
|
2022-02-16 17:42:50 +01:00
|
|
|
"tags": []
|
|
|
|
|
}
|
