"description":"The row to be created/updated, based on the table schema.",
"type":"object",
"properties":{
@ -614,7 +564,7 @@
}
},
"required":[
"row"
"data"
]
},
"table":{
@ -819,7 +769,7 @@
"tableOutput":{
"type":"object",
"properties":{
"table":{
"data":{
"description":"The table to be created/updated.",
"type":"object",
"required":[
@ -1020,7 +970,7 @@
}
},
"required":[
"table"
"data"
]
},
"query":{
@ -1113,7 +1063,7 @@
"userOutput":{
"type":"object",
"properties":{
"user":{
"data":{
"type":"object",
"properties":{
"email":{
@ -1179,7 +1129,7 @@
}
},
"required":[
"user"
"data"
]
},
"nameSearch":{
@ -1204,7 +1154,7 @@
"paths":{
"/applications":{
"post":{
"summary":"Create anew application.",
"summary":"Create an application",
"tags":[
"applications"
],
@ -1244,7 +1194,7 @@
},
"/applications/{appId}":{
"put":{
"summary":"Update an existing application by its ID.",
"summary":"Update an application",
"tags":[
"applications"
],
@ -1282,7 +1232,7 @@
}
},
"delete":{
"summary":"Delete an existing application by its ID.",
"summary":"Delete an application",
"tags":[
"applications"
],
@ -1310,7 +1260,7 @@
}
},
"get":{
"summary":"Retrieve a single application by its ID.",
"summary":"Retrieve an application",
"tags":[
"applications"
],
@ -1340,7 +1290,8 @@
},
"/applications/search":{
"post":{
"summary":"Search for an application based on its app name.",
"summary":"Search for applications",
"description":"Based on application properties (currently only name) search for applications.",
"tags":[
"applications"
],
@ -1367,10 +1318,10 @@
"schema":{
"type":"object",
"required":[
"applications"
"data"
],
"properties":{
"applications":{
"data":{
"type":"array",
"items":{
"$ref":"#/components/schemas/application"
@ -1391,10 +1342,8 @@
},
"/queries/{queryId}":{
"post":{
"summary":"Execute a query and retrieve its response.",
"tags":[
"queries"
],
"summary":"Execute a query",
"description":"Queries which have been created within a Budibase app can be executed using this, - queries",
"parameters":[
{
"$ref":"#/components/parameters/queryId"
@ -1455,7 +1404,8 @@
},
"/queries/search":{
"post":{
"summary":"Search for a query based on its name.",
"summary":"Search for queries",
"description":"Based on query properties (currently only name) search for queries.",
"tags":[
"queries"
],
@ -1482,10 +1432,10 @@
"schema":{
"type":"object",
"required":[
"queries"
"data"
],
"properties":{
"queries":{
"data":{
"type":"array",
"items":{
"$ref":"#/components/schemas/query"
@ -1506,7 +1456,8 @@
},
"/tables/{tableId}/rows":{
"post":{
"summary":"Creates a new row within a specified table.",
"summary":"Create a row",
"description":"Creates a row within the specified table.",
"tags":[
"rows"
],
@ -1554,7 +1505,8 @@
},
"/tables/{tableId}/rows/{rowId}":{
"put":{
"summary":"Update a single row within a specified table.",
"summary":"Update a row",
"description":"Updates a row within the specified table.",
"tags":[
"rows"
],
@ -1603,7 +1555,8 @@
}
},
"delete":{
"summary":"Delete a single row from the specified table.",
"summary":"Delete a row",
"description":"Deletes a row within the specified table.",
"tags":[
"rows"
],
@ -1637,7 +1590,7 @@
}
},
"get":{
"summary":"Get a single row from the specified table.",
"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"
@ -1674,7 +1627,7 @@
},
"/tables/{tableId}/rows/search":{
"post":{
"summary":"Used to search for rows within a table.",
"summary":"Search for rows",
"tags":[
"rows"
],
@ -1808,10 +1761,10 @@
"schema":{
"type":"object",
"required":[
"rows"
"data"
],
"properties":{
"rows":{
"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":{
@ -1848,7 +1801,8 @@
},
"/tables":{
"post":{
"summary":"Create a new table.",
"summary":"Create a table",
"description":"Create a table, this could be internal or external.",
"tags":[
"tables"
],
@ -1892,7 +1846,8 @@
},
"/tables/{tableId}":{
"put":{
"summary":"Update the specified table.",
"summary":"Update a table",
"description":"Update a table, this could be internal or external.",
"tags":[
"tables"
],
@ -1937,7 +1892,8 @@
}
},
"delete":{
"summary":"Delete a single table and all of its data.",
"summary":"Delete a table",
"description":"Delete a table, this could be internal or external.",
"tags":[
"tables"
],
@ -1968,7 +1924,8 @@
}
},
"get":{
"summary":"Gets a single table by its ID.",
"summary":"Retrieve a table",
"description":"Lookup a table, this could be internal or external.",
"tags":[
"tables"
],
@ -2001,7 +1958,8 @@
},
"/tables/search":{
"post":{
"summary":"Search internal and external tables based on their name.",
"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"
],
@ -2028,10 +1986,10 @@
"schema":{
"type":"object",
"required":[
"tables"
"data"
],
"properties":{
"tables":{
"data":{
"type":"array",
"items":{
"$ref":"#/components/schemas/table"
@ -2052,7 +2010,7 @@
},
"/users":{
"post":{
"summary":"Create a new user in the Budibase portal.",
"summary":"Create a user",
"tags":[
"users"
],
@ -2087,7 +2045,7 @@
},
"/users/{userId}":{
"put":{
"summary":"Update an existing user by their ID.",
"summary":"Update a user",
"tags":[
"users"
],
@ -2125,7 +2083,7 @@
}
},
"delete":{
"summary":"Delete an existing user by their ID.",
"summary":"Delete a user",
"tags":[
"users"
],
@ -2153,7 +2111,7 @@
}
},
"get":{
"summary":"Retrieve a single user by their ID.",
"summary":"Retrieve a user",
"tags":[
"users"
],
@ -2183,7 +2141,8 @@
},
"/users/search":{
"post":{
"summary":"Search for a user based on their email/username.",
"summary":"Search for users",
"description":"Based on user properties (currently only name) search for users.",
mike12345567
5 years ago