2788 lines
94 KiB
YAML
2788 lines
94 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
title: Budibase API
|
|
description: The public API for Budibase apps and its services.
|
|
version: 1.0.0
|
|
servers:
|
|
- url: https://budibase.app/api/public/v1
|
|
description: Budibase Cloud API
|
|
variables:
|
|
apiKey:
|
|
default: <user API key>
|
|
description: The API key of the user to assume for API call.
|
|
appId:
|
|
default: <App ID>
|
|
description: The ID of the app the calls will be executed within the context of,
|
|
this should start with app_ (production) or app_dev (development).
|
|
components:
|
|
parameters:
|
|
tableId:
|
|
in: path
|
|
name: tableId
|
|
required: true
|
|
description: The ID of the table which this request is targeting.
|
|
schema:
|
|
type: string
|
|
viewId:
|
|
in: path
|
|
name: viewId
|
|
required: true
|
|
description: The ID of the view 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.
|
|
schema:
|
|
type: string
|
|
appId:
|
|
in: header
|
|
name: x-budibase-app-id
|
|
required: true
|
|
description: The ID of the app which this request is targeting.
|
|
schema:
|
|
default: "{{appId}}"
|
|
type: string
|
|
appIdUrl:
|
|
in: path
|
|
name: appId
|
|
required: true
|
|
description: The ID of the app which this request is targeting.
|
|
schema:
|
|
default: "{{appId}}"
|
|
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
|
|
examples:
|
|
application:
|
|
value:
|
|
data:
|
|
_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
|
|
applications:
|
|
value:
|
|
data:
|
|
- _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
|
|
deploymentOutput:
|
|
value:
|
|
data:
|
|
_id: ef12381f934b4f129675cdbb76eff3c2
|
|
status: SUCCESS
|
|
appUrl: /app-url
|
|
inputRow:
|
|
value:
|
|
_id: ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4
|
|
type: row
|
|
tableId: ta_5b1649e42a5b41dea4ef7742a36a7a70
|
|
name: Mike
|
|
age: 30
|
|
relationship:
|
|
- ro_ta_...
|
|
row:
|
|
value:
|
|
data:
|
|
_id: ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4
|
|
type: row
|
|
tableId: ta_5b1649e42a5b41dea4ef7742a36a7a70
|
|
name: Mike
|
|
age: 30
|
|
relationship:
|
|
- primaryDisplay: Joe
|
|
_id: ro_ta_...
|
|
enrichedRow:
|
|
value:
|
|
data:
|
|
_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
|
|
rows:
|
|
value:
|
|
data:
|
|
- _id: ro_ta_5b1649e42a5b41dea4ef7742a36a7a70_e6dc7e38cf1343b2b56760265201cda4
|
|
type: row
|
|
tableId: ta_5b1649e42a5b41dea4ef7742a36a7a70
|
|
name: Mike
|
|
age: 30
|
|
relationship:
|
|
- primaryDisplay: Joe
|
|
_id: ro_ta_...
|
|
hasNextPage: true
|
|
bookmark: 10
|
|
table:
|
|
value:
|
|
data:
|
|
_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
|
|
tables:
|
|
value:
|
|
data:
|
|
- _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
|
|
query:
|
|
value:
|
|
data:
|
|
_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:
|
|
data:
|
|
- _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
|
|
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
|
|
user:
|
|
value:
|
|
data:
|
|
_id: us_693a73206518477283a8d5ae31103252
|
|
email: test@example.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
|
|
users:
|
|
value:
|
|
data:
|
|
- _id: us_693a73206518477283a8d5ae31103252
|
|
email: test@example.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
|
|
metrics:
|
|
value: >
|
|
# HELP budibase_os_uptime Time in seconds that the host operating system
|
|
has been up.
|
|
|
|
# TYPE budibase_os_uptime counter
|
|
|
|
budibase_os_uptime 54958
|
|
|
|
# HELP budibase_os_free_mem Bytes of memory free for usage on the host operating system.
|
|
|
|
# TYPE budibase_os_free_mem gauge
|
|
|
|
budibase_os_free_mem 804507648
|
|
|
|
# HELP budibase_os_total_mem Total bytes of memory on the host operating system.
|
|
|
|
# TYPE budibase_os_total_mem gauge
|
|
|
|
budibase_os_total_mem 16742404096
|
|
|
|
# HELP budibase_os_used_mem Total bytes of memory in use on the host operating system.
|
|
|
|
# TYPE budibase_os_used_mem gauge
|
|
|
|
budibase_os_used_mem 15937896448
|
|
|
|
# HELP budibase_os_load1 Host operating system load average.
|
|
|
|
# TYPE budibase_os_load1 gauge
|
|
|
|
budibase_os_load1 1.91
|
|
|
|
# HELP budibase_os_load5 Host operating system load average.
|
|
|
|
# TYPE budibase_os_load5 gauge
|
|
|
|
budibase_os_load5 1.75
|
|
|
|
# HELP budibase_os_load15 Host operating system load average.
|
|
|
|
# TYPE budibase_os_load15 gauge
|
|
|
|
budibase_os_load15 1.56
|
|
|
|
# HELP budibase_tenant_user_count The number of users created.
|
|
|
|
# TYPE budibase_tenant_user_count gauge
|
|
|
|
budibase_tenant_user_count 1
|
|
|
|
# HELP budibase_tenant_app_count The number of apps created by a user.
|
|
|
|
# TYPE budibase_tenant_app_count gauge
|
|
|
|
budibase_tenant_app_count 2
|
|
|
|
# HELP budibase_tenant_production_app_count The number of apps a user has published.
|
|
|
|
# TYPE budibase_tenant_production_app_count gauge
|
|
|
|
budibase_tenant_production_app_count 1
|
|
|
|
# HELP budibase_tenant_dev_app_count The number of apps a user has unpublished in development.
|
|
|
|
# TYPE budibase_tenant_dev_app_count gauge
|
|
|
|
budibase_tenant_dev_app_count 1
|
|
|
|
# HELP budibase_tenant_db_count The number of couchdb databases including global tables such as _users.
|
|
|
|
# TYPE budibase_tenant_db_count gauge
|
|
|
|
budibase_tenant_db_count 3
|
|
|
|
# HELP budibase_quota_usage_apps The number of apps created.
|
|
|
|
# TYPE budibase_quota_usage_apps gauge
|
|
|
|
budibase_quota_usage_apps 1
|
|
|
|
# HELP budibase_quota_limit_apps The limit on the number of apps that can be created.
|
|
|
|
# TYPE budibase_quota_limit_apps gauge
|
|
|
|
budibase_quota_limit_apps 9007199254740991
|
|
|
|
# HELP budibase_quota_usage_rows The number of database rows used from the quota.
|
|
|
|
# TYPE budibase_quota_usage_rows gauge
|
|
|
|
budibase_quota_usage_rows 0
|
|
|
|
# HELP budibase_quota_limit_rows The limit on the number of rows that can be created.
|
|
|
|
# TYPE budibase_quota_limit_rows gauge
|
|
|
|
budibase_quota_limit_rows 9007199254740991
|
|
|
|
# HELP budibase_quota_usage_plugins The number of plugins in use.
|
|
|
|
# TYPE budibase_quota_usage_plugins gauge
|
|
|
|
budibase_quota_usage_plugins 0
|
|
|
|
# HELP budibase_quota_limit_plugins The limit on the number of plugins that can be created.
|
|
|
|
# TYPE budibase_quota_limit_plugins gauge
|
|
|
|
budibase_quota_limit_plugins 9007199254740991
|
|
|
|
# HELP budibase_quota_usage_user_groups The number of user groups created.
|
|
|
|
# TYPE budibase_quota_usage_user_groups gauge
|
|
|
|
budibase_quota_usage_user_groups 0
|
|
|
|
# HELP budibase_quota_limit_user_groups The limit on the number of user groups that can be created.
|
|
|
|
# TYPE budibase_quota_limit_user_groups gauge
|
|
|
|
budibase_quota_limit_user_groups 9007199254740991
|
|
|
|
# HELP budibase_quota_usage_queries The number of queries used in the current month.
|
|
|
|
# TYPE budibase_quota_usage_queries gauge
|
|
|
|
budibase_quota_usage_queries 0
|
|
|
|
# HELP budibase_quota_limit_queries The limit on the number of queries for the current month.
|
|
|
|
# TYPE budibase_quota_limit_queries gauge
|
|
|
|
budibase_quota_limit_queries 9007199254740991
|
|
|
|
# HELP budibase_quota_usage_automations The number of automations used in the current month.
|
|
|
|
# TYPE budibase_quota_usage_automations gauge
|
|
|
|
budibase_quota_usage_automations 0
|
|
|
|
# HELP budibase_quota_limit_automations The limit on the number of automations that can be created.
|
|
|
|
# TYPE budibase_quota_limit_automations gauge
|
|
|
|
budibase_quota_limit_automations 9007199254740991
|
|
view:
|
|
value:
|
|
data:
|
|
name: peopleView
|
|
tableId: ta_896a325f7e8147d2a2cda93c5d236511
|
|
schema:
|
|
name:
|
|
visible: true
|
|
readonly: false
|
|
order: 1
|
|
width: 300
|
|
age:
|
|
visible: true
|
|
readonly: true
|
|
order: 2
|
|
width: 200
|
|
salary:
|
|
visible: false
|
|
readonly: false
|
|
primaryDisplay: name
|
|
views:
|
|
value:
|
|
data:
|
|
- name: peopleView
|
|
tableId: ta_896a325f7e8147d2a2cda93c5d236511
|
|
schema:
|
|
name:
|
|
visible: true
|
|
readonly: false
|
|
order: 1
|
|
width: 300
|
|
age:
|
|
visible: true
|
|
readonly: true
|
|
order: 2
|
|
width: 200
|
|
salary:
|
|
visible: false
|
|
readonly: false
|
|
primaryDisplay: name
|
|
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.
|
|
schemas:
|
|
application:
|
|
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
|
|
required:
|
|
- name
|
|
applicationOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
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
|
|
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
|
|
deploymentOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: object
|
|
properties:
|
|
_id:
|
|
description: The ID of the app.
|
|
type: string
|
|
status:
|
|
description: Status of the deployment, whether it succeeded or failed
|
|
type: string
|
|
enum:
|
|
- SUCCESS
|
|
- FAILURE
|
|
appUrl:
|
|
description: The URL of the published app
|
|
type: string
|
|
required:
|
|
- _id
|
|
- status
|
|
- appUrl
|
|
required:
|
|
- data
|
|
appExport:
|
|
type: object
|
|
properties:
|
|
encryptPassword:
|
|
description: An optional password used to encrypt the export.
|
|
type: string
|
|
excludeRows:
|
|
description: Set whether the internal table rows should be excluded from the
|
|
export.
|
|
type: boolean
|
|
required:
|
|
- encryptPassword
|
|
- excludeRows
|
|
row:
|
|
description: The row to be created/updated, based on the table schema.
|
|
type: object
|
|
additionalProperties:
|
|
description: Key value properties of any type, depending on the table schema.
|
|
searchOutput:
|
|
type: object
|
|
required:
|
|
- data
|
|
properties:
|
|
data:
|
|
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:
|
|
- type: string
|
|
- type: integer
|
|
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
|
|
additionalProperties:
|
|
description: Key value properties of any type, depending on the table schema.
|
|
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
|
|
required:
|
|
- data
|
|
table:
|
|
description: The table to be created/updated.
|
|
type: object
|
|
required:
|
|
- name
|
|
- schema
|
|
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
|
|
- attachment_single
|
|
- link
|
|
- formula
|
|
- auto
|
|
- ai
|
|
- json
|
|
- internal
|
|
- barcodeqr
|
|
- signature_single
|
|
- bigint
|
|
- bb_reference
|
|
- bb_reference_single
|
|
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.
|
|
tableOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
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
|
|
- attachment_single
|
|
- link
|
|
- formula
|
|
- auto
|
|
- ai
|
|
- json
|
|
- internal
|
|
- barcodeqr
|
|
- signature_single
|
|
- bigint
|
|
- bb_reference
|
|
- bb_reference_single
|
|
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
|
|
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
|
|
- attachment_single
|
|
- link
|
|
- formula
|
|
- auto
|
|
- ai
|
|
- json
|
|
- internal
|
|
- barcodeqr
|
|
- signature_single
|
|
- bigint
|
|
- bb_reference
|
|
- bb_reference_single
|
|
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
|
|
executeQuery:
|
|
description: The parameters required for executing a query.
|
|
type: object
|
|
properties:
|
|
parameters:
|
|
type: object
|
|
description: This contains the required parameters for the query, this depends
|
|
on query type, setup and bindings.
|
|
additionalProperties:
|
|
description: Key value properties of any type, depending on the query output
|
|
schema.
|
|
pagination:
|
|
type: object
|
|
description: For supported query types (currently on REST) pagination can be
|
|
performed using these properties.
|
|
properties:
|
|
page:
|
|
type: string
|
|
description: The page which has been returned from a previous query.
|
|
limit:
|
|
type: number
|
|
description: The number of rows to return per page.
|
|
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 datasource 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
|
|
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 datasource 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
|
|
user:
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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). This field can only be set on a business or
|
|
enterprise license.
|
|
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
|
|
userOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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). This field can only be set on a business or
|
|
enterprise license.
|
|
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
|
|
- _id
|
|
required:
|
|
- data
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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. This field can only
|
|
be set on a business or enterprise license.
|
|
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). This field can only be set on a business or
|
|
enterprise license.
|
|
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
|
|
- _id
|
|
required:
|
|
- data
|
|
rowSearch:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: object
|
|
properties:
|
|
allOr:
|
|
type: boolean
|
|
description: Specifies that a row should be returned if it satisfies any of the
|
|
specified options, rather than requiring it to fulfill all the
|
|
search parameters. This defaults to false, meaning AND logic
|
|
will be used.
|
|
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: Searches for a sub-string within a string column, e.g. searching
|
|
for 'dib' will match 'Budibase'.
|
|
range:
|
|
type: object
|
|
description: Searches within a range, the format of this must be in the format
|
|
of an object with a "low" and "high" property.
|
|
example:
|
|
columnName1:
|
|
low: 10
|
|
high: 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].
|
|
contains:
|
|
type: object
|
|
description: Searches for a value, or set of values in array column types (such
|
|
as a multi-select). If an array of search options is provided
|
|
then it must match all.
|
|
example:
|
|
arrayColumn:
|
|
- a
|
|
- b
|
|
notContains:
|
|
type: object
|
|
description: The logical inverse of contains. Only works on array column types.
|
|
If an array of values is passed, the row must not match any of
|
|
them to be returned in the response.
|
|
example:
|
|
arrayColumn:
|
|
- a
|
|
- b
|
|
containsAny:
|
|
type: object
|
|
description: As with the contains search, only works on array column types and
|
|
searches for any of the provided values when given an array.
|
|
example:
|
|
arrayColumn:
|
|
- a
|
|
- b
|
|
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.
|
|
required:
|
|
- query
|
|
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.
|
|
required:
|
|
- name
|
|
rolesAssign:
|
|
type: object
|
|
properties:
|
|
appBuilder:
|
|
type: object
|
|
properties:
|
|
appId:
|
|
description: The app that the users should have app builder privileges granted
|
|
for.
|
|
type: string
|
|
description: Allow setting users to builders per app.
|
|
required:
|
|
- appId
|
|
builder:
|
|
type: boolean
|
|
description: Add/remove global builder permissions from the list of users.
|
|
admin:
|
|
type: boolean
|
|
description: Add/remove global admin permissions from the list of users.
|
|
role:
|
|
type: object
|
|
properties:
|
|
roleId:
|
|
description: The role ID, such as BASIC, ADMIN or a custom role ID.
|
|
type: string
|
|
appId:
|
|
description: The app that the role relates to.
|
|
type: string
|
|
description: Add/remove a per-app role, such as BASIC, ADMIN etc.
|
|
required:
|
|
- roleId
|
|
- appId
|
|
userIds:
|
|
description: The user IDs to be updated to add/remove the specified roles.
|
|
type: array
|
|
items:
|
|
type: string
|
|
required:
|
|
- userIds
|
|
rolesUnAssign:
|
|
type: object
|
|
properties:
|
|
appBuilder:
|
|
type: object
|
|
properties:
|
|
appId:
|
|
description: The app that the users should have app builder privileges granted
|
|
for.
|
|
type: string
|
|
description: Allow setting users to builders per app.
|
|
required:
|
|
- appId
|
|
builder:
|
|
type: boolean
|
|
description: Add/remove global builder permissions from the list of users.
|
|
admin:
|
|
type: boolean
|
|
description: Add/remove global admin permissions from the list of users.
|
|
role:
|
|
type: object
|
|
properties:
|
|
roleId:
|
|
description: The role ID, such as BASIC, ADMIN or a custom role ID.
|
|
type: string
|
|
appId:
|
|
description: The app that the role relates to.
|
|
type: string
|
|
description: Add/remove a per-app role, such as BASIC, ADMIN etc.
|
|
required:
|
|
- roleId
|
|
- appId
|
|
userIds:
|
|
description: The user IDs to be updated to add/remove the specified roles.
|
|
type: array
|
|
items:
|
|
type: string
|
|
required:
|
|
- userIds
|
|
rolesOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: object
|
|
properties:
|
|
userIds:
|
|
description: The updated users' IDs
|
|
type: array
|
|
items:
|
|
type: string
|
|
required:
|
|
- userIds
|
|
required:
|
|
- data
|
|
view:
|
|
description: The view to be created/updated.
|
|
type: object
|
|
required:
|
|
- name
|
|
- schema
|
|
properties:
|
|
name:
|
|
description: The name of the view.
|
|
type: string
|
|
type:
|
|
description: The type of view - standard (empty value) or calculation.
|
|
type: string
|
|
enum:
|
|
- calculation
|
|
primaryDisplay:
|
|
type: string
|
|
description: A column used to display rows from this view - usually used when
|
|
rendered in tables.
|
|
schema:
|
|
type: object
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: object
|
|
properties:
|
|
visible:
|
|
type: boolean
|
|
description: Defines whether the column is visible or not - rows
|
|
retrieved/updated through this view will not be able to
|
|
access it.
|
|
readonly:
|
|
type: boolean
|
|
description: "When used in combination with 'visible: true' the column will be
|
|
visible in row responses but cannot be updated."
|
|
order:
|
|
type: integer
|
|
description: A number defining where the column shows up in tables, lowest being
|
|
first.
|
|
width:
|
|
type: integer
|
|
description: A width for the column, defined in pixels - this affects rendering
|
|
in tables.
|
|
column:
|
|
type: array
|
|
description: If this is a relationship column, we can set the columns we wish to
|
|
include
|
|
items:
|
|
type: object
|
|
properties:
|
|
readonly:
|
|
type: boolean
|
|
- type: object
|
|
properties:
|
|
calculationType:
|
|
type: string
|
|
description: This column should be built from a calculation, specifying a type
|
|
and field. It is important to note when a calculation is
|
|
configured all non-calculation columns will be used for
|
|
grouping.
|
|
enum:
|
|
- sum
|
|
- avg
|
|
- count
|
|
- min
|
|
- max
|
|
field:
|
|
type: string
|
|
description: The field from the table to perform the calculation on.
|
|
distinct:
|
|
type: boolean
|
|
description: Can be used in tandem with the count calculation type, to count
|
|
unique entries.
|
|
viewOutput:
|
|
type: object
|
|
properties:
|
|
data:
|
|
description: The view to be created/updated.
|
|
type: object
|
|
required:
|
|
- name
|
|
- schema
|
|
- id
|
|
properties:
|
|
name:
|
|
description: The name of the view.
|
|
type: string
|
|
type:
|
|
description: The type of view - standard (empty value) or calculation.
|
|
type: string
|
|
enum:
|
|
- calculation
|
|
primaryDisplay:
|
|
type: string
|
|
description: A column used to display rows from this view - usually used when
|
|
rendered in tables.
|
|
schema:
|
|
type: object
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: object
|
|
properties:
|
|
visible:
|
|
type: boolean
|
|
description: Defines whether the column is visible or not - rows
|
|
retrieved/updated through this view will not be able
|
|
to access it.
|
|
readonly:
|
|
type: boolean
|
|
description: "When used in combination with 'visible: true' the column will be
|
|
visible in row responses but cannot be updated."
|
|
order:
|
|
type: integer
|
|
description: A number defining where the column shows up in tables, lowest being
|
|
first.
|
|
width:
|
|
type: integer
|
|
description: A width for the column, defined in pixels - this affects rendering
|
|
in tables.
|
|
column:
|
|
type: array
|
|
description: If this is a relationship column, we can set the columns we wish to
|
|
include
|
|
items:
|
|
type: object
|
|
properties:
|
|
readonly:
|
|
type: boolean
|
|
- type: object
|
|
properties:
|
|
calculationType:
|
|
type: string
|
|
description: This column should be built from a calculation, specifying a type
|
|
and field. It is important to note when a calculation
|
|
is configured all non-calculation columns will be used
|
|
for grouping.
|
|
enum:
|
|
- sum
|
|
- avg
|
|
- count
|
|
- min
|
|
- max
|
|
field:
|
|
type: string
|
|
description: The field from the table to perform the calculation on.
|
|
distinct:
|
|
type: boolean
|
|
description: Can be used in tandem with the count calculation type, to count
|
|
unique entries.
|
|
id:
|
|
description: The ID of the view.
|
|
type: string
|
|
required:
|
|
- data
|
|
viewSearch:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: array
|
|
items:
|
|
description: The view to be created/updated.
|
|
type: object
|
|
required:
|
|
- name
|
|
- schema
|
|
- id
|
|
properties:
|
|
name:
|
|
description: The name of the view.
|
|
type: string
|
|
type:
|
|
description: The type of view - standard (empty value) or calculation.
|
|
type: string
|
|
enum:
|
|
- calculation
|
|
primaryDisplay:
|
|
type: string
|
|
description: A column used to display rows from this view - usually used when
|
|
rendered in tables.
|
|
schema:
|
|
type: object
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: object
|
|
properties:
|
|
visible:
|
|
type: boolean
|
|
description: Defines whether the column is visible or not - rows
|
|
retrieved/updated through this view will not be able
|
|
to access it.
|
|
readonly:
|
|
type: boolean
|
|
description: "When used in combination with 'visible: true' the column will be
|
|
visible in row responses but cannot be updated."
|
|
order:
|
|
type: integer
|
|
description: A number defining where the column shows up in tables, lowest being
|
|
first.
|
|
width:
|
|
type: integer
|
|
description: A width for the column, defined in pixels - this affects rendering
|
|
in tables.
|
|
column:
|
|
type: array
|
|
description: If this is a relationship column, we can set the columns we wish to
|
|
include
|
|
items:
|
|
type: object
|
|
properties:
|
|
readonly:
|
|
type: boolean
|
|
- type: object
|
|
properties:
|
|
calculationType:
|
|
type: string
|
|
description: This column should be built from a calculation, specifying a type
|
|
and field. It is important to note when a
|
|
calculation is configured all non-calculation
|
|
columns will be used for grouping.
|
|
enum:
|
|
- sum
|
|
- avg
|
|
- count
|
|
- min
|
|
- max
|
|
field:
|
|
type: string
|
|
description: The field from the table to perform the calculation on.
|
|
distinct:
|
|
type: boolean
|
|
description: Can be used in tandem with the count calculation type, to count
|
|
unique entries.
|
|
id:
|
|
description: The ID of the view.
|
|
type: string
|
|
required:
|
|
- data
|
|
security:
|
|
- ApiKeyAuth: []
|
|
paths:
|
|
/applications:
|
|
post:
|
|
operationId: appCreate
|
|
summary: Create an application
|
|
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:
|
|
operationId: appUpdate
|
|
summary: Update an application
|
|
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:
|
|
operationId: appDestroy
|
|
summary: Delete an application
|
|
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:
|
|
operationId: appGetById
|
|
summary: Retrieve an application
|
|
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"
|
|
"/applications/{appId}/unpublish":
|
|
post:
|
|
operationId: appUnpublish
|
|
summary: Unpublish an application
|
|
tags:
|
|
- applications
|
|
parameters:
|
|
- $ref: "#/components/parameters/appIdUrl"
|
|
responses:
|
|
"204":
|
|
description: The app was published successfully.
|
|
"/applications/{appId}/publish":
|
|
post:
|
|
operationId: appPublish
|
|
summary: Publish an application
|
|
tags:
|
|
- applications
|
|
parameters:
|
|
- $ref: "#/components/parameters/appIdUrl"
|
|
responses:
|
|
"200":
|
|
description: Returns the deployment object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/deploymentOutput"
|
|
examples:
|
|
deployment:
|
|
$ref: "#/components/examples/deploymentOutput"
|
|
"/applications/{appId}/import":
|
|
post:
|
|
operationId: appImport
|
|
summary: Import an app to an existing app 🔒
|
|
description: This endpoint is only available on a business or enterprise license.
|
|
tags:
|
|
- applications
|
|
parameters:
|
|
- $ref: "#/components/parameters/appIdUrl"
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
encryptedPassword:
|
|
description: Password for the export if it is encrypted.
|
|
type: string
|
|
appExport:
|
|
description: The app export to import.
|
|
type: string
|
|
format: binary
|
|
required:
|
|
- appExport
|
|
responses:
|
|
"204":
|
|
description: Application has been updated.
|
|
"/applications/{appId}/export":
|
|
post:
|
|
operationId: appExport
|
|
summary: Export an app 🔒
|
|
description: This endpoint is only available on a business or enterprise license.
|
|
tags:
|
|
- applications
|
|
parameters:
|
|
- $ref: "#/components/parameters/appIdUrl"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/appExport"
|
|
responses:
|
|
"200":
|
|
description: A gzip tarball containing the app export, encrypted if password
|
|
provided.
|
|
content:
|
|
application/gzip:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
example: Tarball containing database and object store contents...
|
|
/applications/search:
|
|
post:
|
|
operationId: appSearch
|
|
summary: Search for applications
|
|
description: Based on application properties (currently only name) search for
|
|
applications.
|
|
tags:
|
|
- applications
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/nameSearch"
|
|
responses:
|
|
"200":
|
|
description: Returns the applications that were found based on the search
|
|
parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/applicationSearch"
|
|
examples:
|
|
applications:
|
|
$ref: "#/components/examples/applications"
|
|
/metrics:
|
|
get:
|
|
operationId: metricsGet
|
|
summary: Retrieve Budibase tenant metrics
|
|
description: Output metrics in OpenMetrics format compatible with Prometheus
|
|
tags:
|
|
- metrics
|
|
responses:
|
|
"200":
|
|
description: Returns tenant metrics.
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
examples:
|
|
metrics:
|
|
$ref: "#/components/examples/metrics"
|
|
"/queries/{queryId}":
|
|
post:
|
|
operationId: queryExecute
|
|
summary: Execute a query
|
|
description: Queries which have been created within a Budibase app can be
|
|
executed using this,
|
|
tags:
|
|
- queries
|
|
parameters:
|
|
- $ref: "#/components/parameters/queryId"
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/executeQuery"
|
|
responses:
|
|
"200":
|
|
description: Returns the result of the query execution.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/executeQueryOutput"
|
|
examples:
|
|
REST:
|
|
$ref: "#/components/examples/restResponse"
|
|
SQL:
|
|
$ref: "#/components/examples/sqlResponse"
|
|
/queries/search:
|
|
post:
|
|
operationId: querySearch
|
|
summary: Search for queries
|
|
description: Based on query properties (currently only name) search for queries.
|
|
tags:
|
|
- queries
|
|
parameters:
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/nameSearch"
|
|
responses:
|
|
"200":
|
|
description: Returns the queries found based on the search parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/querySearch"
|
|
examples:
|
|
queries:
|
|
$ref: "#/components/examples/queries"
|
|
/roles/assign:
|
|
post:
|
|
operationId: roleAssign
|
|
summary: Assign a role to a list of users
|
|
description: This is a business/enterprise only endpoint
|
|
tags:
|
|
- roles
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rolesAssign"
|
|
responses:
|
|
"200":
|
|
description: Returns a list of updated user IDs
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rolesOutput"
|
|
/roles/unassign:
|
|
post:
|
|
operationId: roleUnAssign
|
|
summary: Un-assign a role from a list of users
|
|
description: This is a business/enterprise only endpoint
|
|
tags:
|
|
- roles
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rolesUnAssign"
|
|
responses:
|
|
"200":
|
|
description: Returns a list of updated user IDs
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rolesOutput"
|
|
"/tables/{tableId}/rows":
|
|
post:
|
|
operationId: rowCreate
|
|
summary: Create a row
|
|
description: Creates a row within the specified table.
|
|
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:
|
|
operationId: rowUpdate
|
|
summary: Update a row
|
|
description: Updates a row within the specified table.
|
|
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:
|
|
operationId: rowDestroy
|
|
summary: Delete a row
|
|
description: Deletes a row within the specified table.
|
|
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:
|
|
operationId: rowGetById
|
|
summary: Retrieve a row
|
|
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.
|
|
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:
|
|
enrichedRow:
|
|
$ref: "#/components/examples/enrichedRow"
|
|
"/tables/{tableId}/rows/search":
|
|
post:
|
|
operationId: rowSearch
|
|
summary: Search for rows
|
|
tags:
|
|
- rows
|
|
parameters:
|
|
- $ref: "#/components/parameters/tableId"
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rowSearch"
|
|
responses:
|
|
"200":
|
|
description: The response will contain an array of rows that match the search
|
|
parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/searchOutput"
|
|
examples:
|
|
search:
|
|
$ref: "#/components/examples/rows"
|
|
"/views/{viewId}/rows/search":
|
|
post:
|
|
operationId: rowViewSearch
|
|
summary: Search for rows in a view
|
|
tags:
|
|
- rows
|
|
parameters:
|
|
- $ref: "#/components/parameters/viewId"
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/rowSearch"
|
|
responses:
|
|
"200":
|
|
description: The response will contain an array of rows that match the search
|
|
parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/searchOutput"
|
|
examples:
|
|
search:
|
|
$ref: "#/components/examples/rows"
|
|
/tables:
|
|
post:
|
|
operationId: tableCreate
|
|
summary: Create a table
|
|
description: Create a table, this could be internal or external.
|
|
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 datasources.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tableOutput"
|
|
examples:
|
|
table:
|
|
$ref: "#/components/examples/table"
|
|
"/tables/{tableId}":
|
|
put:
|
|
operationId: tableUpdate
|
|
summary: Update a table
|
|
description: Update a table, this could be internal or external.
|
|
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:
|
|
operationId: tableDestroy
|
|
summary: Delete a table
|
|
description: Delete a table, this could be internal or external.
|
|
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:
|
|
operationId: tableGetById
|
|
summary: Retrieve a table
|
|
description: Lookup a table, this could be internal or external.
|
|
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"
|
|
/tables/search:
|
|
post:
|
|
operationId: tableSearch
|
|
summary: Search for tables
|
|
description: Based on table properties (currently only name) search for tables.
|
|
This could be an internal or an external table.
|
|
tags:
|
|
- tables
|
|
parameters:
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/nameSearch"
|
|
responses:
|
|
"200":
|
|
description: Returns the found tables, based on the search parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tableSearch"
|
|
examples:
|
|
tables:
|
|
$ref: "#/components/examples/tables"
|
|
/users:
|
|
post:
|
|
operationId: userCreate
|
|
summary: Create a user
|
|
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:
|
|
operationId: userUpdate
|
|
summary: Update a user
|
|
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:
|
|
operationId: userDestroy
|
|
summary: Delete a user
|
|
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:
|
|
operationId: userGetById
|
|
summary: Retrieve a user
|
|
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"
|
|
/users/search:
|
|
post:
|
|
operationId: userSearch
|
|
summary: Search for users
|
|
description: Based on user properties (currently only name) search for users.
|
|
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:
|
|
$ref: "#/components/schemas/userSearch"
|
|
examples:
|
|
users:
|
|
$ref: "#/components/examples/users"
|
|
/views:
|
|
post:
|
|
operationId: viewCreate
|
|
summary: Create a view
|
|
description: Create a view, this can be against an internal or external table.
|
|
tags:
|
|
- views
|
|
parameters:
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/view"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
responses:
|
|
"200":
|
|
description: Returns the created view, including the ID which has been generated
|
|
for it.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/viewOutput"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
"/views/{viewId}":
|
|
put:
|
|
operationId: viewUpdate
|
|
summary: Update a view
|
|
description: Update a view, this can be against an internal or external table.
|
|
tags:
|
|
- views
|
|
parameters:
|
|
- $ref: "#/components/parameters/viewId"
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/view"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
responses:
|
|
"200":
|
|
description: Returns the updated view.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/viewOutput"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
delete:
|
|
operationId: viewDestroy
|
|
summary: Delete a view
|
|
description: Delete a view, this can be against an internal or external table.
|
|
tags:
|
|
- views
|
|
parameters:
|
|
- $ref: "#/components/parameters/viewId"
|
|
- $ref: "#/components/parameters/appId"
|
|
responses:
|
|
"200":
|
|
description: Returns the deleted view.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/viewOutput"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
get:
|
|
operationId: viewGetById
|
|
summary: Retrieve a view
|
|
description: Lookup a view, this could be internal or external.
|
|
tags:
|
|
- views
|
|
parameters:
|
|
- $ref: "#/components/parameters/viewId"
|
|
- $ref: "#/components/parameters/appId"
|
|
responses:
|
|
"200":
|
|
description: Returns the retrieved view.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/viewOutput"
|
|
examples:
|
|
view:
|
|
$ref: "#/components/examples/view"
|
|
/views/search:
|
|
post:
|
|
operationId: viewSearch
|
|
summary: Search for views
|
|
description: Based on view properties (currently only name) search for views.
|
|
tags:
|
|
- views
|
|
parameters:
|
|
- $ref: "#/components/parameters/appId"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/nameSearch"
|
|
responses:
|
|
"200":
|
|
description: Returns the found views, based on the search parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/viewSearch"
|
|
examples:
|
|
views:
|
|
$ref: "#/components/examples/views"
|
|
tags: []
|