DBObjects API`s
In this chategory there are API's with which you can get, insert or update 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
|
1. Short description of DBObjects API`s:
| POST/api/DBObjects/execproc |
Executes stored procedure(s), and creates PA temp tables |
| POST/api/DBObjects/selecttables |
Selects data from table(s), and creates PA temp tables |
| POST/api/DBObjects/inserttable |
Insert data to table, with columns |
| POST/api/DBObjects/updatetable |
Update data in table, with columns and optional condition |
2. POST/api/DBObjects/execproc
This API enables you to execute one or more procedures. If procedure uses Temp Tables it can be specified in the tempTables array parameters. In block procParams you must specify the procedure parameters. The results can presentet in JSON file in the structure as the procedure returns the results.
{
"procedures": [
{
"procname": "string",
"procParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"tempTables": [
"string"
]
}
3. POST/api/DBObojects/selecttables
This API enables you to define to get data as result of query defined as parameter masterTable with join tables in params tableFKs with custom Conditions in customConditions params.
Additional you can sort your data with param sortColumn and sortOrder. You can use param 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 table defined in param masterTable. Additional the tempTables can be created with param tempTables and insert data in this temp table.
{
"masterTable": "string",
"fieldvalues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
5. POST/api/DBObjects/updatetable
This API enables you to update data in tabele as as parameter masterTable, update data in param fieldvalues with ability to join tables in params tableFKs with custom Conditions in customConditions params.
{
"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"
]
}
}