DBObjects API
In this chategory, you will find APIs that enable you to get, insert, update or delete almost any data from or to PANTHEON.
Table of contents
- Short description of DBObjects
- POST/api/DBObjects/execproc
- POST/api/DBObjects/selecttables
- POST/api/DBObjects/inserttable
- POST/api/DBObjects/updatetable
- POST/api/DBObjects/deletetable
|
1. Short description of DBObjects APIs:
| POST/api/DBObjects/execproc |
Executes stored procedure(s) and creates PANTHEON temporary tables. |
| POST/api/DBObjects/selecttables |
Selects data from table(s) and creates PANTHEON temporary tables. |
| POST/api/DBObjects/inserttable |
Inserts data into a table using columns. |
| POST/api/DBObjects/updatetable |
Updates data in the table using columns and optional condition. |
| POST/api/DBObjects/deletetable |
Delete data from table(s) base on condition (s) |
2. POST/api/DBObjects/execproc
This API enables you to execute one or more procedures. If the procedure uses tempTables, it can be specified in the tempTables array parameters. In the block procParams, you must specify procedure parameters. Results returned by the procedure can be presented in a .json file structure.
{
"procedures": [
{
"procname": "string",
"procParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"inserts": [
{
"masterTable": "string",
"fieldvalues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"updates": [
{
"masterTable": {
"table": "string",
"alias": "string"
},
"fieldvalues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
}
}
],
"tempTables": [
"string"
]
}
3. POST/api/DBObojects/selecttables
This API enables you to get data as a result of a query defined as the parameter masterTable with join tables in the parameters tableFKs with custom conditions in the parameters customConditions.
Additionally, you can sort your data using the parameters sortColumn and sortOrder. You can use the parameter tempTable in the query if you execute store procedure with result set.
{
"start": 0,
"length": 0,
"fieldsToReturn": "string",
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
},
"sortColumn": "string",
"sortOrder": "string",
"withSubSelects": 0,
"masterTable": {
"table": "string",
"alias": "string"
},
"tempTables": [
"string"
]
}
4. POST/api/DBObjects/inserttable
This API enables you to insert data into the table defined in the parameter masterTable. Additionally, tempTables can be created with parameters tempTables and data can be inserted in these temporary tables.
{
"masterTable": "string",
"fieldvalues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
5. POST/api/DBObjects/updatetable
This API enables you to update data in the table as parameter masterTable, update data in the parameter fieldvalues with the ability to join tables in the parameters tableFKs with custom conditions in the parameters customConditions.
{
"masterTable": {
"table": "string",
"alias": "string"
},
"fieldvalues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
}
}
6. POST/api/DBObjects/deletetable
This API enables you to delete data in the table as parameter masterTable, delete data in the parameter fieldvalues with the ability to join tables in the parameters tableFKs with custom conditions in the parameters customConditions.
{
"masterTable": {
"table": "string",
"alias": "string"
},
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
}
}