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-03-07 17:41:22 +01:00
"url" : "https://budibase.app/api/public/v1" ,
"description" : "Budibase Cloud API"
2022-02-17 13:40:08 +01:00
} ,
{
2022-03-07 14:21:30 +01:00
"url" : "{protocol}://{hostname}/api/public/v1" ,
"description" : "Budibase self hosted API" ,
"variables" : {
"protocol" : {
"default" : "http" ,
"description" : "Whether HTTP or HTTPS should be used to communicate with your Budibase instance."
} ,
"hostname" : {
"default" : "localhost:10000" ,
"description" : "The URL of your Budibase instance."
}
}
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-03-01 15:37:35 +01:00
"data" : {
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" ,
2022-03-01 15:37:35 +01:00
"status" : "development"
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-03-01 15:37:35 +01:00
"data" : [
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" ,
2022-03-01 15:37:35 +01:00
"status" : "development"
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-03-01 15:37:35 +01:00
"data" : {
2022-02-22 15:10:01 +01:00
"_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-28 13:54:32 +01:00
"enrichedRow" : {
"value" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-02-28 13:54:32 +01:00
"_id" : "ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4" ,
"name" : "eg" ,
"tableId" : "ta_5b1649e42a5b41dea4ef7742a36a7a70" ,
"type" : "row" ,
"relationship" : [
{
"_id" : "ro_ta_users_us_8f3d717147d74d759d8cef5b6712062f" ,
"name" : "Joe" ,
"tableId" : "ta_users" ,
"internal" : [
{
"_id" : "ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4" ,
"primaryDisplay" : "eg"
}
]
}
]
}
}
} ,
2022-02-22 15:10:01 +01:00
"rows" : {
2022-02-18 16:47:15 +01:00
"value" : {
2022-03-01 15:37:35 +01:00
"data" : [
2022-02-18 16:47:15 +01:00
{
"_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-03-01 15:37:35 +01:00
"data" : {
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
}
}
}
} ,
2022-02-22 16:06:08 +01:00
"tables" : {
2022-02-22 15:10:01 +01:00
"value" : {
2022-03-01 15:37:35 +01:00
"data" : [
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" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-02-22 15:10:01 +01:00
"_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" : {
2022-03-01 15:37:35 +01:00
"data" : [
2022-02-22 15:10:01 +01:00
{
"_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-03-01 15:37:35 +01:00
"data" : {
2022-02-22 16:06:08 +01:00
"_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" : {
2022-03-01 15:37:35 +01:00
"data" : [
2022-02-22 16:06:08 +01:00
{
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" : {
2022-02-28 12:29:48 +01:00
"description" : "The name of the app." ,
2022-02-24 19:15:13 +01:00
"type" : "string"
2022-02-24 16:42:59 +01:00
} ,
"url" : {
2022-02-28 12:29:48 +01:00
"description" : "The URL by which the app is accessed, this must be URL encoded." ,
2022-02-24 16:42:59 +01:00
"type" : "string"
}
2022-02-24 19:15:13 +01:00
} ,
"required" : [
"name" ,
"url"
]
2022-02-22 16:06:08 +01:00
} ,
"applicationOutput" : {
"type" : "object" ,
"properties" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-02-22 16:06:08 +01:00
"type" : "object" ,
2022-02-24 16:42:59 +01:00
"properties" : {
"name" : {
2022-02-28 12:29:48 +01:00
"description" : "The name of the app." ,
2022-02-24 19:15:13 +01:00
"type" : "string"
2022-02-24 16:42:59 +01:00
} ,
"url" : {
2022-02-28 12:29:48 +01:00
"description" : "The URL by which the app is accessed, this must be URL encoded." ,
"type" : "string"
} ,
2022-03-01 19:35:08 +01:00
"_id" : {
"description" : "The ID of the app." ,
"type" : "string"
} ,
2022-02-28 12:29:48 +01:00
"status" : {
"description" : "The status of the app, stating it if is the development or published version." ,
"type" : "string" ,
"enum" : [
"development" ,
"published"
]
} ,
"createdAt" : {
"description" : "States when the app was created, will be constant. Stored in ISO format." ,
"type" : "string"
} ,
"updatedAt" : {
"description" : "States the last time the app was updated - stored in ISO format." ,
"type" : "string"
} ,
"version" : {
"description" : "States the version of the Budibase client this app is currently based on." ,
"type" : "string"
} ,
"tenantId" : {
"description" : "In a multi-tenant environment this will state the tenant this app is within." ,
"type" : "string"
} ,
"lockedBy" : {
"description" : "The user this app is currently being built by." ,
"type" : "object"
2022-02-24 16:42:59 +01:00
}
2022-02-24 19:15:13 +01:00
} ,
"required" : [
2022-03-01 19:35:08 +01:00
"_id" ,
2022-02-24 19:15:13 +01:00
"name" ,
2022-02-28 12:29:48 +01:00
"url" ,
"status" ,
"createdAt" ,
"updatedAt" ,
2022-03-01 19:35:08 +01:00
"version"
2022-02-24 19:15:13 +01:00
]
2022-02-22 16:06:08 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"required" : [
2022-03-01 15:37:35 +01:00
"data"
2022-02-25 00:21:10 +01:00
]
2022-02-22 16:06:08 +01:00
} ,
2022-03-08 18:42:26 +01:00
"applicationSearch" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"name" : {
"description" : "The name of the app." ,
"type" : "string"
} ,
"url" : {
"description" : "The URL by which the app is accessed, this must be URL encoded." ,
"type" : "string"
} ,
"_id" : {
"description" : "The ID of the app." ,
"type" : "string"
} ,
"status" : {
"description" : "The status of the app, stating it if is the development or published version." ,
"type" : "string" ,
"enum" : [
"development" ,
"published"
]
} ,
"createdAt" : {
"description" : "States when the app was created, will be constant. Stored in ISO format." ,
"type" : "string"
} ,
"updatedAt" : {
"description" : "States the last time the app was updated - stored in ISO format." ,
"type" : "string"
} ,
"version" : {
"description" : "States the version of the Budibase client this app is currently based on." ,
"type" : "string"
} ,
"tenantId" : {
"description" : "In a multi-tenant environment this will state the tenant this app is within." ,
"type" : "string"
} ,
"lockedBy" : {
"description" : "The user this app is currently being built by." ,
"type" : "object"
}
} ,
"required" : [
"_id" ,
"name" ,
"url" ,
"status" ,
"createdAt" ,
"updatedAt" ,
"version"
]
}
}
} ,
"required" : [
"data"
]
} ,
2022-02-18 18:44:08 +01:00
"row" : {
"description" : "The row to be created/updated, based on the table schema." ,
"type" : "object" ,
"additionalProperties" : {
2022-03-01 23:37:42 +01:00
"description" : "Key value properties of any type, depending on the table schema."
2022-02-18 18:44:08 +01:00
}
2022-02-18 19:06:58 +01:00
} ,
2022-03-01 19:35:08 +01:00
"searchOutput" : {
2022-02-22 16:06:08 +01:00
"type" : "object" ,
2022-03-01 19:35:08 +01:00
"required" : [
"data"
] ,
2022-02-22 16:06:08 +01:00
"properties" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-03-01 19:35:08 +01:00
"description" : "An array of rows, these will each contain an _id field which can be used to update or delete them." ,
"type" : "array" ,
"items" : {
"type" : "object"
}
} ,
"bookmark" : {
"description" : "If pagination in use, this should be provided." ,
"oneOf" : [
{
2022-02-28 13:54:32 +01:00
"type" : "string"
} ,
2022-03-01 19:35:08 +01:00
{
"type" : "integer"
2022-02-28 13:54:32 +01:00
}
2022-03-01 19:35:08 +01:00
]
} ,
"hasNextPage" : {
"description" : "If pagination in use, this will determine if there is another page to fetch." ,
"type" : "boolean"
}
}
} ,
"rowOutput" : {
"type" : "object" ,
"properties" : {
"data" : {
"description" : "The row to be created/updated, based on the table schema." ,
"type" : "object" ,
2022-02-22 16:06:08 +01:00
"additionalProperties" : {
2022-03-01 23:37:42 +01:00
"description" : "Key value properties of any type, depending on the table schema."
2022-03-01 19:35:08 +01:00
} ,
"properties" : {
"_id" : {
"description" : "The ID of the row." ,
"type" : "string"
} ,
"tableId" : {
"description" : "The ID of the table this row comes from." ,
"type" : "string"
}
} ,
"required" : [
"tableId" ,
"_id"
]
2022-02-22 16:06:08 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"required" : [
2022-03-01 15:37:35 +01:00
"data"
2022-02-25 00:21:10 +01:00
]
2022-02-22 16:06:08 +01:00
} ,
2022-02-18 19:06:58 +01:00
"table" : {
"description" : "The table to be created/updated." ,
"type" : "object" ,
2022-02-25 00:21:10 +01:00
"required" : [
"name" ,
"schema"
] ,
2022-02-18 19:06:58 +01:00
"properties" : {
"name" : {
2022-03-01 19:35:08 +01:00
"description" : "The name of the table." ,
2022-02-18 19:06:58 +01:00
"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-25 00:21:10 +01:00
"type" : "object" ,
"additionalProperties" : {
"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."
}
2022-02-21 17:37:02 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"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."
2022-02-21 17:37:02 +01:00
}
}
2022-02-25 00:21:10 +01:00
} ,
{
"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."
}
2022-02-21 17:37:02 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"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."
2022-02-21 17:37:02 +01:00
}
}
2022-02-25 00:21:10 +01:00
} ,
{
"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."
}
2022-02-21 17:37:02 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"name" : {
"type" : "string" ,
"description" : "The name of the column."
} ,
"autocolumn" : {
"type" : "boolean" ,
"description" : "Defines whether the column is automatically generated."
2022-02-21 17:37:02 +01:00
}
}
2022-02-18 19:06:58 +01:00
}
2022-02-25 00:21:10 +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" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-02-22 15:10:01 +01:00
"description" : "The table to be created/updated." ,
"type" : "object" ,
2022-02-25 00:21:10 +01:00
"required" : [
"name" ,
2022-03-01 19:35:08 +01:00
"schema" ,
"_id"
2022-02-25 00:21:10 +01:00
] ,
2022-02-22 15:10:01 +01:00
"properties" : {
"name" : {
2022-03-01 19:35:08 +01:00
"description" : "The name of the table." ,
2022-02-22 15:10:01 +01:00
"type" : "string"
} ,
"primaryDisplay" : {
"type" : "string" ,
"description" : "The name of the column which should be used in relationship tags when relating to this table."
} ,
"schema" : {
2022-02-25 00:21:10 +01:00
"type" : "object" ,
"additionalProperties" : {
"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."
}
2022-02-22 15:10:01 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"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."
2022-02-22 15:10:01 +01:00
}
}
2022-02-25 00:21:10 +01:00
} ,
{
"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."
}
2022-02-22 15:10:01 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"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."
2022-02-22 15:10:01 +01:00
}
}
2022-02-25 00:21:10 +01:00
} ,
{
"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."
}
2022-02-22 15:10:01 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"name" : {
"type" : "string" ,
"description" : "The name of the column."
} ,
"autocolumn" : {
"type" : "boolean" ,
"description" : "Defines whether the column is automatically generated."
2022-02-22 15:10:01 +01:00
}
}
}
2022-02-25 00:21:10 +01:00
]
}
2022-03-01 19:35:08 +01:00
} ,
"_id" : {
"description" : "The ID of the table." ,
"type" : "string"
2022-02-22 15:10:01 +01:00
}
}
}
2022-02-25 00:21:10 +01:00
} ,
"required" : [
2022-03-01 15:37:35 +01:00
"data"
2022-02-25 00:21:10 +01:00
]
2022-02-22 15:10:01 +01:00
} ,
2022-03-08 18:42:26 +01:00
"tableSearch" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"description" : "The table to be created/updated." ,
"type" : "object" ,
"required" : [
"name" ,
"schema" ,
"_id"
] ,
"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" : {
"type" : "object" ,
"additionalProperties" : {
"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."
}
}
}
]
}
} ,
"_id" : {
"description" : "The ID of the table." ,
"type" : "string"
}
}
}
}
} ,
"required" : [
"data"
]
} ,
2022-03-01 19:35:08 +01:00
"executeQuery" : {
2022-02-25 20:26:19 +01:00
"description" : "The query body must contain the required parameters for the query, this depends on query type, setup and bindings." ,
2022-02-22 16:06:08 +01:00
"type" : "object" ,
2022-02-25 20:26:19 +01:00
"additionalProperties" : {
2022-03-01 23:37:42 +01:00
"description" : "Key value properties of any type, depending on the query output schema."
2022-02-25 20:26:19 +01:00
}
2022-02-22 16:06:08 +01:00
} ,
2022-03-01 19:35:08 +01:00
"executeQueryOutput" : {
"type" : "object" ,
"properties" : {
"data" : {
"description" : "The data response from the query." ,
"type" : "array" ,
"items" : {
"type" : "object"
}
} ,
"extra" : {
"description" : "Extra information that is not part of the main data, e.g. headers." ,
"type" : "object" ,
"properties" : {
"headers" : {
"description" : "If carrying out a REST request, this will contain the response headers." ,
"type" : "object"
} ,
"raw" : {
"description" : "The raw query response, as a string." ,
"type" : "string"
}
}
} ,
"pagination" : {
"description" : "If pagination is supported, this will contain the bookmark/anchor information for it." ,
"type" : "object"
}
} ,
"required" : [
"data"
]
} ,
"query" : {
"type" : "object" ,
"properties" : {
"_id" : {
"description" : "The ID of the query." ,
"type" : "string"
} ,
"datasourceId" : {
"description" : "The ID of the data source the query belongs to." ,
"type" : "string"
} ,
"parameters" : {
"description" : "The bindings which are required to perform this query." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"fields" : {
"description" : "The fields that are used to perform this query, e.g. the sql statement" ,
"type" : "object"
} ,
"queryVerb" : {
"description" : "The verb that describes this query." ,
"enum" : [
"create" ,
"read" ,
"update" ,
"delete"
]
} ,
"name" : {
"description" : "The name of the query." ,
"type" : "string"
} ,
"schema" : {
"description" : "The schema of the data returned when the query is executed." ,
"type" : "object"
} ,
"transformer" : {
"description" : "The JavaScript transformer function, applied after the query responds with data." ,
"type" : "string"
} ,
"readable" : {
"description" : "Whether the query has readable data." ,
"type" : "boolean"
}
} ,
"required" : [
"name" ,
"schema" ,
"_id"
]
} ,
2022-03-08 18:42:26 +01:00
"querySearch" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"_id" : {
"description" : "The ID of the query." ,
"type" : "string"
} ,
"datasourceId" : {
"description" : "The ID of the data source the query belongs to." ,
"type" : "string"
} ,
"parameters" : {
"description" : "The bindings which are required to perform this query." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"fields" : {
"description" : "The fields that are used to perform this query, e.g. the sql statement" ,
"type" : "object"
} ,
"queryVerb" : {
"description" : "The verb that describes this query." ,
"enum" : [
"create" ,
"read" ,
"update" ,
"delete"
]
} ,
"name" : {
"description" : "The name of the query." ,
"type" : "string"
} ,
"schema" : {
"description" : "The schema of the data returned when the query is executed." ,
"type" : "object"
} ,
"transformer" : {
"description" : "The JavaScript transformer function, applied after the query responds with data." ,
"type" : "string"
} ,
"readable" : {
"description" : "Whether the query has readable data." ,
"type" : "boolean"
}
} ,
"required" : [
"name" ,
"schema" ,
"_id"
]
}
}
} ,
"required" : [
"data"
]
} ,
2022-02-22 16:06:08 +01:00
"user" : {
"type" : "object" ,
2022-02-25 20:26:19 +01:00
"properties" : {
"email" : {
"description" : "The email address of the user, this must be unique." ,
"type" : "string"
} ,
"password" : {
"description" : "The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure." ,
"type" : "string"
} ,
"status" : {
"description" : "The status of the user, if they are active." ,
"type" : "string" ,
"enum" : [
"active"
]
} ,
"firstName" : {
"description" : "The first name of the user" ,
"type" : "string"
} ,
"lastName" : {
"description" : "The last name of the user" ,
"type" : "string"
} ,
"forceResetPassword" : {
"description" : "If set to true forces the user to reset their password on first login." ,
"type" : "boolean"
} ,
"builder" : {
"description" : "Describes if the user is a builder user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to build any app in the system." ,
"type" : "boolean"
}
}
} ,
"admin" : {
"description" : "Describes if the user is an admin user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to administrate the system." ,
"type" : "boolean"
}
}
} ,
"roles" : {
"description" : "Contains the roles of the user per app (assuming they are not a builder user)." ,
"type" : "object" ,
"additionalProperties" : {
"type" : "string" ,
"description" : "A map of app ID (production app ID, minus the _dev component) to a role ID, e.g. ADMIN."
}
}
} ,
"required" : [
"email" ,
"roles"
]
2022-02-22 16:06:08 +01:00
} ,
2022-02-22 15:10:01 +01:00
"userOutput" : {
"type" : "object" ,
"properties" : {
2022-03-01 15:37:35 +01:00
"data" : {
2022-02-22 15:10:01 +01:00
"type" : "object" ,
2022-02-25 20:26:19 +01:00
"properties" : {
"email" : {
"description" : "The email address of the user, this must be unique." ,
"type" : "string"
} ,
"password" : {
"description" : "The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure." ,
"type" : "string"
} ,
"status" : {
"description" : "The status of the user, if they are active." ,
"type" : "string" ,
"enum" : [
"active"
]
} ,
"firstName" : {
"description" : "The first name of the user" ,
"type" : "string"
} ,
"lastName" : {
"description" : "The last name of the user" ,
"type" : "string"
} ,
"forceResetPassword" : {
"description" : "If set to true forces the user to reset their password on first login." ,
"type" : "boolean"
} ,
"builder" : {
"description" : "Describes if the user is a builder user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to build any app in the system." ,
"type" : "boolean"
}
}
} ,
"admin" : {
"description" : "Describes if the user is an admin user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to administrate the system." ,
"type" : "boolean"
}
}
} ,
"roles" : {
"description" : "Contains the roles of the user per app (assuming they are not a builder user)." ,
"type" : "object" ,
"additionalProperties" : {
"type" : "string" ,
"description" : "A map of app ID (production app ID, minus the _dev component) to a role ID, e.g. ADMIN."
}
2022-03-01 19:35:08 +01:00
} ,
"_id" : {
"description" : "The ID of the user." ,
"type" : "string"
2022-02-25 20:26:19 +01:00
}
} ,
"required" : [
"email" ,
2022-03-01 19:35:08 +01:00
"roles" ,
"_id"
2022-02-25 20:26:19 +01:00
]
2022-02-22 15:10:01 +01:00
}
2022-02-25 00:21:10 +01:00
} ,
"required" : [
2022-03-01 15:37:35 +01:00
"data"
2022-02-25 00:21:10 +01:00
]
2022-02-22 15:10:01 +01:00
} ,
2022-03-08 18:42:26 +01:00
"userSearch" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"email" : {
"description" : "The email address of the user, this must be unique." ,
"type" : "string"
} ,
"password" : {
"description" : "The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure." ,
"type" : "string"
} ,
"status" : {
"description" : "The status of the user, if they are active." ,
"type" : "string" ,
"enum" : [
"active"
]
} ,
"firstName" : {
"description" : "The first name of the user" ,
"type" : "string"
} ,
"lastName" : {
"description" : "The last name of the user" ,
"type" : "string"
} ,
"forceResetPassword" : {
"description" : "If set to true forces the user to reset their password on first login." ,
"type" : "boolean"
} ,
"builder" : {
"description" : "Describes if the user is a builder user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to build any app in the system." ,
"type" : "boolean"
}
}
} ,
"admin" : {
"description" : "Describes if the user is an admin user or not." ,
"type" : "object" ,
"properties" : {
"global" : {
"description" : "If set to true the user will be able to administrate the system." ,
"type" : "boolean"
}
}
} ,
"roles" : {
"description" : "Contains the roles of the user per app (assuming they are not a builder user)." ,
"type" : "object" ,
"additionalProperties" : {
"type" : "string" ,
"description" : "A map of app ID (production app ID, minus the _dev component) to a role ID, e.g. ADMIN."
}
} ,
"_id" : {
"description" : "The ID of the user." ,
"type" : "string"
}
} ,
"required" : [
"email" ,
"roles" ,
"_id"
]
}
}
} ,
"required" : [
"data"
]
} ,
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-25 00:21:10 +01:00
} ,
"required" : [
"name"
]
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 19:15:13 +01:00
"paths" : {
"/applications" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Create an application" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"applications"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/application"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the created application." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/applicationOutput"
} ,
"examples" : {
"application" : {
"$ref" : "#/components/examples/application"
}
}
}
}
}
}
}
} ,
"/applications/{appId}" : {
"put" : {
2022-03-01 15:37:35 +01:00
"summary" : "Update an application" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"applications"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appIdUrl"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/application"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the updated application." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/applicationOutput"
} ,
"examples" : {
"application" : {
"$ref" : "#/components/examples/application"
}
}
}
}
}
}
} ,
"delete" : {
2022-03-01 15:37:35 +01:00
"summary" : "Delete an application" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"applications"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appIdUrl"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the deleted application." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/applicationOutput"
} ,
"examples" : {
"application" : {
"$ref" : "#/components/examples/application"
}
}
}
}
}
}
} ,
"get" : {
2022-03-01 15:37:35 +01:00
"summary" : "Retrieve an application" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"applications"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appIdUrl"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the retrieved application." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/applicationOutput"
} ,
"examples" : {
"application" : {
"$ref" : "#/components/examples/application"
}
}
}
}
}
}
}
} ,
2022-02-25 00:21:10 +01:00
"/applications/search" : {
2022-02-24 19:15:13 +01:00
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Search for applications" ,
"description" : "Based on application properties (currently only name) search for applications." ,
2022-02-24 19:15:13 +01:00
"tags" : [
2022-02-25 00:21:10 +01:00
"applications"
2022-02-24 19:15:13 +01:00
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/nameSearch"
}
}
}
} ,
"responses" : {
"200" : {
2022-02-25 00:21:10 +01:00
"description" : "Returns the applications that were found based on the search parameters." ,
2022-02-24 19:15:13 +01:00
"content" : {
"application/json" : {
"schema" : {
2022-03-08 18:42:26 +01:00
"$ref" : "#/components/schemas/applicationSearch"
2022-02-24 19:15:13 +01:00
} ,
"examples" : {
2022-02-25 00:21:10 +01:00
"applications" : {
"$ref" : "#/components/examples/applications"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
}
}
} ,
"/queries/{queryId}" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Execute a query" ,
2022-03-01 19:35:08 +01:00
"description" : "Queries which have been created within a Budibase app can be executed using this," ,
"tags" : [
"queries"
] ,
2022-02-24 19:15:13 +01:00
"parameters" : [
{
"$ref" : "#/components/parameters/queryId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
2022-03-01 19:35:08 +01:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/executeQuery"
}
}
}
} ,
2022-02-24 19:15:13 +01:00
"responses" : {
"200" : {
"description" : "Returns the result of the query execution." ,
"content" : {
"application/json" : {
"schema" : {
2022-03-01 19:35:08 +01:00
"$ref" : "#/components/schemas/executeQueryOutput"
2022-02-24 19:15:13 +01:00
} ,
"examples" : {
"REST" : {
2022-02-25 00:21:10 +01:00
"$ref" : "#/components/examples/restResponse"
} ,
"SQL" : {
"$ref" : "#/components/examples/sqlResponse"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
2022-02-25 00:21:10 +01:00
}
}
} ,
"/queries/search" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Search for queries" ,
"description" : "Based on query properties (currently only name) search for queries." ,
2022-02-25 00:21:10 +01:00
"tags" : [
"queries"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/nameSearch"
}
}
}
2022-02-24 19:15:13 +01:00
} ,
"responses" : {
"200" : {
2022-02-25 00:21:10 +01:00
"description" : "Returns the queries found based on the search parameters." ,
2022-02-24 19:15:13 +01:00
"content" : {
"application/json" : {
"schema" : {
2022-03-08 18:42:26 +01:00
"$ref" : "#/components/schemas/querySearch"
2022-02-24 19:15:13 +01:00
} ,
"examples" : {
2022-02-25 00:21:10 +01:00
"queries" : {
"$ref" : "#/components/examples/queries"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
}
}
} ,
"/tables/{tableId}/rows" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Create a row" ,
"description" : "Creates a row within the specified table." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"rows"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/row"
} ,
"examples" : {
"row" : {
"$ref" : "#/components/examples/inputRow"
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the created row, including the ID which has been generated for it. This can be found in the Budibase portal, viewed under the developer information." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/rowOutput"
} ,
"examples" : {
"row" : {
"$ref" : "#/components/examples/row"
}
}
}
}
}
}
}
} ,
"/tables/{tableId}/rows/{rowId}" : {
"put" : {
2022-03-01 15:37:35 +01:00
"summary" : "Update a row" ,
"description" : "Updates a row within the specified table." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"rows"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/rowId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/row"
} ,
"examples" : {
"row" : {
"$ref" : "#/components/examples/inputRow"
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the created row, including the ID which has been generated for it." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/rowOutput"
} ,
"examples" : {
"row" : {
"$ref" : "#/components/examples/row"
}
}
}
}
}
}
} ,
"delete" : {
2022-03-01 15:37:35 +01:00
"summary" : "Delete a row" ,
"description" : "Deletes a row within the specified table." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"rows"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/rowId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the deleted row, including the ID which has been generated for it." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/rowOutput"
} ,
"examples" : {
"row" : {
"$ref" : "#/components/examples/row"
}
}
}
}
}
}
} ,
"get" : {
2022-03-01 15:37:35 +01:00
"summary" : "Retrieve a row" ,
2022-02-28 13:54:32 +01:00
"description" : "This gets a single row, it will be enriched with the full related rows, rather than the squashed \"primaryDisplay\" format returned by the search endpoint." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"rows"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/rowId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the retrieved row." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/rowOutput"
} ,
"examples" : {
2022-02-28 13:54:32 +01:00
"enrichedRow" : {
"$ref" : "#/components/examples/enrichedRow"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
}
}
} ,
2022-02-25 00:21:10 +01:00
"/tables/{tableId}/rows/search" : {
2022-02-24 19:15:13 +01:00
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Search for rows" ,
2022-02-24 19:15:13 +01:00
"tags" : [
2022-02-25 00:21:10 +01:00
"rows"
2022-02-24 19:15:13 +01:00
] ,
"parameters" : [
2022-02-25 00:21:10 +01:00
{
"$ref" : "#/components/parameters/tableId"
} ,
2022-02-24 19:15:13 +01:00
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
2022-02-25 00:21:10 +01:00
"type" : "object" ,
"required" : [
"query"
] ,
"properties" : {
"query" : {
"type" : "object" ,
"properties" : {
"string" : {
"type" : "object" ,
"example" : {
"columnName1" : "value" ,
"columnName2" : "value"
} ,
"description" : "A map of field name to the string to search for, this will look for rows that have a value starting with the string value." ,
"additionalProperties" : {
"type" : "string" ,
"description" : "The value to search for in the column."
}
} ,
"fuzzy" : {
"type" : "object" ,
"description" : "A fuzzy search, only supported by internal tables."
} ,
"range" : {
"type" : "object" ,
"description" : "Searches within a range, the format of this must be columnName -> [low, high]." ,
"example" : {
"columnName1" : [
10 ,
20
]
}
} ,
"equal" : {
"type" : "object" ,
"description" : "Searches for rows that have a column value that is exactly the value set."
} ,
"notEqual" : {
"type" : "object" ,
"description" : "Searches for any row which does not contain the specified column value."
} ,
"empty" : {
"type" : "object" ,
"description" : "Searches for rows which do not contain the specified column. The object should simply contain keys of the column names, these can map to any value." ,
"example" : {
"columnName1" : ""
}
} ,
"notEmpty" : {
"type" : "object" ,
"description" : "Searches for rows which have the specified column."
} ,
"oneOf" : {
"type" : "object" ,
"description" : "Searches for rows which have a column value that is any of the specified values. The format of this must be columnName -> [value1, value2]."
}
}
} ,
"paginate" : {
"type" : "boolean" ,
"description" : "Enables pagination, by default this is disabled."
} ,
"bookmark" : {
"oneOf" : [
{
"type" : "string"
} ,
{
"type" : "integer"
}
] ,
"description" : "If retrieving another page, the bookmark from the previous request must be supplied."
} ,
"limit" : {
"type" : "integer" ,
"description" : "The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000."
} ,
"sort" : {
"type" : "object" ,
"description" : "A set of parameters describing the sort behaviour of the search." ,
"properties" : {
"order" : {
"type" : "string" ,
"enum" : [
"ascending" ,
"descending"
] ,
"description" : "The order of the sort, by default this is ascending."
} ,
"column" : {
"type" : "string" ,
"description" : "The name of the column by which the rows will be sorted."
} ,
"type" : {
"type" : "string" ,
"enum" : [
"string" ,
"number"
] ,
"description" : "Defines whether the column should be treated as a string or as numbers when sorting."
}
}
}
}
2022-02-24 19:15:13 +01:00
}
}
}
} ,
"responses" : {
"200" : {
2022-02-25 00:21:10 +01:00
"description" : "The response will contain an array of rows that match the search parameters." ,
2022-02-24 19:15:13 +01:00
"content" : {
"application/json" : {
"schema" : {
2022-03-01 19:35:08 +01:00
"$ref" : "#/components/schemas/searchOutput"
2022-02-24 19:15:13 +01:00
} ,
"examples" : {
2022-02-25 00:21:10 +01:00
"search" : {
"$ref" : "#/components/examples/rows"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
}
}
} ,
"/tables" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Create a table" ,
"description" : "Create a table, this could be internal or external." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"tables"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/table"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the created table, including the ID which has been generated for it. This can be internal or external data sources." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/tableOutput"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
}
}
}
} ,
"/tables/{tableId}" : {
"put" : {
2022-03-01 15:37:35 +01:00
"summary" : "Update a table" ,
"description" : "Update a table, this could be internal or external." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"tables"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/table"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the updated table." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/tableOutput"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
}
}
} ,
"delete" : {
2022-03-01 15:37:35 +01:00
"summary" : "Delete a table" ,
"description" : "Delete a table, this could be internal or external." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"tables"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the deleted table." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/tableOutput"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
}
}
} ,
"get" : {
2022-03-01 15:37:35 +01:00
"summary" : "Retrieve a table" ,
"description" : "Lookup a table, this could be internal or external." ,
2022-02-24 19:15:13 +01:00
"tags" : [
"tables"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/tableId"
} ,
{
"$ref" : "#/components/parameters/appId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the retrieved table." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/tableOutput"
} ,
"examples" : {
"table" : {
"$ref" : "#/components/examples/table"
}
}
}
}
}
}
}
} ,
2022-02-25 00:21:10 +01:00
"/tables/search" : {
2022-02-24 19:15:13 +01:00
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Search for tables" ,
"description" : "Based on table properties (currently only name) search for tables. This could be an internal or an external table." ,
2022-02-24 19:15:13 +01:00
"tags" : [
2022-02-25 00:21:10 +01:00
"tables"
2022-02-24 19:15:13 +01:00
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/appId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/nameSearch"
}
}
}
} ,
"responses" : {
"200" : {
2022-02-25 00:21:10 +01:00
"description" : "Returns the found tables, based on the search parameters." ,
2022-02-24 19:15:13 +01:00
"content" : {
"application/json" : {
"schema" : {
2022-03-08 18:42:26 +01:00
"$ref" : "#/components/schemas/tableSearch"
2022-02-24 19:15:13 +01:00
} ,
"examples" : {
2022-02-25 00:21:10 +01:00
"tables" : {
"$ref" : "#/components/examples/tables"
2022-02-24 19:15:13 +01:00
}
}
}
}
}
}
}
} ,
"/users" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Create a user" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"users"
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/user"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the created user." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/userOutput"
} ,
"examples" : {
"user" : {
"$ref" : "#/components/examples/user"
}
}
}
}
}
}
}
} ,
"/users/{userId}" : {
"put" : {
2022-03-01 15:37:35 +01:00
"summary" : "Update a user" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"users"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/userId"
}
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/user"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the updated user." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/userOutput"
} ,
"examples" : {
"user" : {
"$ref" : "#/components/examples/user"
}
}
}
}
}
}
} ,
"delete" : {
2022-03-01 15:37:35 +01:00
"summary" : "Delete a user" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"users"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/userId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the deleted user." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/userOutput"
} ,
"examples" : {
"user" : {
"$ref" : "#/components/examples/user"
}
}
}
}
}
}
} ,
"get" : {
2022-03-01 15:37:35 +01:00
"summary" : "Retrieve a user" ,
2022-02-24 19:15:13 +01:00
"tags" : [
"users"
] ,
"parameters" : [
{
"$ref" : "#/components/parameters/userId"
}
] ,
"responses" : {
"200" : {
"description" : "Returns the retrieved user." ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/userOutput"
} ,
"examples" : {
"user" : {
"$ref" : "#/components/examples/user"
}
}
}
}
}
}
}
2022-02-25 00:21:10 +01:00
} ,
"/users/search" : {
"post" : {
2022-03-01 15:37:35 +01:00
"summary" : "Search for users" ,
"description" : "Based on user properties (currently only name) search for users." ,
2022-02-25 00:21:10 +01:00
"tags" : [
"users"
] ,
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/nameSearch"
}
}
}
} ,
"responses" : {
"200" : {
"description" : "Returns the found users based on search parameters." ,
"content" : {
"application/json" : {
"schema" : {
2022-03-08 18:42:26 +01:00
"$ref" : "#/components/schemas/userSearch"
2022-02-25 00:21:10 +01:00
} ,
"examples" : {
"users" : {
"$ref" : "#/components/examples/users"
}
}
}
}
}
}
}
2022-02-24 19:15:13 +01:00
}
} ,
2022-02-16 17:42:50 +01:00
"tags" : [ ]
}
