Metadata
| API | Description |
|---|---|
| GET api/v1/meta/gettablemetadata/{tableName} |
Gets SAFE Table metadata for specified table |
| GET api/v1/meta/getalltablesmetadata |
Gets SAFE Table metadata for all tables user has access to |
| GET api/v1/meta/gettableinfo/{tableName} |
Gets SAFE Table info for specified table |
| GET api/v1/meta/getalltablesinfo |
Gets SAFE Table info for all tables user has access to |
TestV2
| API | Description |
|---|---|
| GET api/v2/test/hello |
No documentation available. |
DataServiceV2
| API | Description |
|---|---|
| POST api/v2/dataservice/getdatarows |
Gets Data Rows for the provided Row Ids. |
| POST api/v2/dataservice/getdatarows2async |
Gets Data Rows for the provided Row Ids asynchronously. You must call |
| GET api/v2/dataservice/getdatarowsasyncgetresult/{ticketId} |
Retrieves Data from a GetDataRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v2/dataservice/compoundfind |
Finds data in specified table with the supplied query, using sql query syntax. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| POST api/v2/dataservice/compoundfindcount |
Gets the row count for the specified table with the supplied query, using sql query syntax. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| POST api/v2/dataservice/compoundfindasync |
Initiates a Compound Find in specified table with given search parameters asynchronously. You must call compoundfindasyncgetresult to retrieve results. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| GET api/v2/dataservice/compoundfindasyncgetresult/{ticketId} |
Retrieves Data from a CompoundFindASync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v2/dataservice/find |
Finds data in specified table with given search parameters. |
| POST api/v2/dataservice/findcount |
Returns count of rows found for given search parameters. |
| POST api/v2/dataservice/findasync |
Initiates a Finds data request in specified table with given search parameters asynchronously. You must call findasyncgetresult to retrieve results |
| GET api/v2/dataservice/findasyncgetresult/{ticketId} |
Retrieves Data from a FindAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v2/dataservice/addrows |
Adds a collection of data rows in specified table with given the list of columns and values passed |
| POST api/v2/dataservice/addrowsasync |
Adds a collection of data rows in specified table with given the list of columns and values passed asynchronously. You must call addrowsasyncgetresult to retrieve results |
| GET api/v2/dataservice/addrowsasyncgetresult/{ticketId} |
Retrieves Data from a AddRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| PUT api/v2/dataservice/updaterows |
Updates a collection of data rows in specified table with given the list of columns and values passed |
| PUT api/v2/dataservice/updaterowsasync |
Updates a collection of data rows in specified table with given the list of columns and values passed asynchronously. You must call updaterowsasyncgetresult to retrieve results |
| GET api/v2/dataservice/updaterowsasyncgetresult/{ticketId} |
Retrieves Data from a UpdateRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| DELETE api/v2/dataservice/deleterows |
Deletes multiple rows of data. |
| DELETE api/v2/dataservice/deleterowsasync |
Deletes multiple rows of data asynchronously. You must call deleterowsasyncgetresult to retrieve results |
| GET api/v2/dataservice/deleterowsasyncgetresult/{ticketId} |
Retrieves result from a DeleteRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| GET api/v2/dataservice/commit/{transactionId} |
Use to acknowledge successful receipt of result from Add or Update Operations and commit data |
Test
| API | Description |
|---|---|
| GET api/v1/test/hello |
No documentation available. |
MetadataV2
| API | Description |
|---|---|
| POST api/v2/meta/gettablemetadata |
Gets SAFE Table metadata for specified table |
| GET api/v2/meta/getalltablesmetadata |
Gets SAFE Table metadata for all tables user has access to |
| POST api/v2/meta/gettableinfo |
Gets SAFE Table info for specified table |
| GET api/v2/meta/getalltablesinfo |
Gets SAFE Table info for all tables user has access to |
DataService
| API | Description |
|---|---|
| GET api/v1/dataservice/getdatarow/{tableName}/{rowId}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]} |
Gets a Row of Data |
| POST api/v1/dataservice/getdatarows/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]} |
Gets Data Rows for the provided Row Ids. |
| POST api/v1/dataservice/getdatarowsasync/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]} |
Gets Data Rows for the provided Row Ids asynchronously. You must call |
| POST api/v1/dataservice/getdatarows2 |
Gets Data Rows for the provided Row Ids. |
| POST api/v1/dataservice/getdatarows2async |
Gets Data Rows for the provided Row Ids asynchronously. You must call |
| GET api/v1/dataservice/getdatarowsasyncgetresult/{ticketId} |
Retrieves Data from a GetDataRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v1/dataservice/compoundfind |
Finds data in specified table with the supplied query, using sql query syntax. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| POST api/v1/dataservice/compoundfindcount |
Gets the row count for the specified table with the supplied query, using sql query syntax. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| POST api/v1/dataservice/compoundfindasync |
Initiates a Compound Find in specified table with given search parameters asynchronously. You must call compoundfindasyncgetresult to retrieve results. NOTE : Currently, only queries on a single table are supported and only using the 'AND' logical operator. In addition, the only comparison operators supported are '=' and 'like' |
| GET api/v1/dataservice/compoundfindasyncgetresult/{ticketId} |
Retrieves Data from a CompoundFindASync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v1/dataservice/find/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]} |
Finds data in specified table with given search parameters. |
| POST api/v1/dataservice/findcount/{tableName} |
Returns count of rows found for given search parameters. |
| POST api/v1/dataservice/findasync/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]} |
Initiates a Finds data request in specified table with given search parameters asynchronously. You must call findasyncgetresult to retrieve results |
| GET api/v1/dataservice/findasyncgetresult/{ticketId} |
Retrieves Data from a FindAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| POST api/v1/dataservice/addrows/{tableName} |
Adds a collection of data rows in specified table with given the list of columns and values passed |
| POST api/v1/dataservice/addrowsasync/{tableName} |
Adds a collection of data rows in specified table with given the list of columns and values passed asynchronously. You must call addrowsasyncgetresult to retrieve results |
| GET api/v1/dataservice/addrowsasyncgetresult/{ticketId} |
Retrieves Data from a AddRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| PUT api/v1/dataservice/updaterows/{tableName} |
Updates a collection of data rows in specified table with given the list of columns and values passed |
| PUT api/v1/dataservice/updaterowsasync/{tableName} |
Updates a collection of data rows in specified table with given the list of columns and values passed asynchronously. You must call updaterowsasyncgetresult to retrieve results |
| GET api/v1/dataservice/updaterowsasyncgetresult/{ticketId} |
Retrieves Data from a UpdateRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| DELETE api/v1/dataservice/deleterows/{tableName} |
Deletes multiple rows of data. |
| DELETE api/v1/dataservice/deleterowsasync/{tableName} |
Deletes multiple rows of data asynchronously. You must call deleterowsasyncgetresult to retrieve results |
| GET api/v1/dataservice/deleterowsasyncgetresult/{ticketId} |
Retrieves result from a DeleteRowsAsync request. If operation is not yet complete, a 202 Http Code will be returned |
| GET api/v1/dataservice/commit/{transactionId} |
Use to acknowledge successful receipt of result from Add or Update Operations and commit data |