Custom

The Custom resource allows you to extend the API in two ways. First, it allows you to configure standard or custom tables or views for access via the API. Using the Custom/{Resource} endpoint allows you to perform basic Create, Put, and Delete operations against configured database objects. This highly configurble option is the preferred way to interact with custom database objects. If more extensive customization is needed, then custom local stored procedures can be created and installed in your database, and exposed to the API for use with the Custom/Execute endpoint. While this provides the highest level of flexibility, it also is the most difficult to maintain. For more information about using the Custom resource, see the documentation under Home->Custom Data in these API help pages.

Http Verb Operation
Get Custom/{resourceName}/{id} Get details of an entry in the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.
GET Method: Get, URL: Custom/{resourceName}/{id} Test

Get details of an entry in the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.

GetAll Custom/{resourceName} Get all data for the resource configured in TR_DATASERVICE_TABLES. The {resourceName} in the URL should be replaced by the name of the resource as configured in TR_DATASERVICE_TABLES. The data can be filtered by using a set of query parameters. The format for the filter query parameters is ?column1=value1&column2=value2, where column1 can either be the name of the column in the table or a formatted name for the column as defined in TR_DATASERVICE_COLUMNS. For more information about Custom resources including setup and use, please look at the Custom Data help page.
GET Method: GetAll, URL: Custom/{resourceName} Test

Get all data for the resource configured in TR_DATASERVICE_TABLES. The {resourceName} in the URL should be replaced by the name of the resource as configured in TR_DATASERVICE_TABLES. The data can be filtered by using a set of query parameters. The format for the filter query parameters is ?column1=value1&column2=value2, where column1 can either be the name of the column in the table or a formatted name for the column as defined in TR_DATASERVICE_COLUMNS.

GetMetadata Custom/Metadata Get the metadata information of a custom table as defined by TR_DATASERVICE_TABLES and TR_DATASERVICE_COLUMNS.
GET Method: GetMetadata, URL: Custom/Metadata Test

Get the metadata information of a custom table as defined by TR_DATASERVICE_TABLES and TR_DATASERVICE_COLUMNS.

Create Custom/{resourceName} Create an entry with the given data for the table as defined by the {resourceName} in TR_DATASERVICE_TABLES.
POST Method: Create, URL: Custom/{resourceName} Test

Create an entry with the given data for the table as defined by the {resourceName} in TR_DATASERVICE_TABLES.

ExecuteLocalProcedure Custom/Execute Executes a local procedure defined in TR_LOCAL_PROCEDURE. This will only return a collection of the first result set in a registered procedure. For the result set, null values in each data row are not returned as properties.
POST Method: ExecuteLocalProcedure, URL: Custom/Execute Test

Executes a local procedure defined in TR_LOCAL_PROCEDURE. This will only return a collection of the first result set in a registered procedure. For the result set, null values in each data row are not returned as properties.

ExecuteLocalProcedureWithMultipleResultSets Custom/Execute/MultipleResultSets Executes a local procedure defined in TR_LOCAL_PROCEDURE. This resource supports multiple result sets in a registered procedure. The response object is different from Custom/Execute. For each result set, null values are not returned as properties.
POST Method: ExecuteLocalProcedureWithMultipleResultSets, URL: Custom/Execute/MultipleResultSets Test

Executes a local procedure defined in TR_LOCAL_PROCEDURE. This resource supports multiple result sets in a registered procedure. The response object is different from Custom/Execute. For each result set, null values are not returned as properties.

Update Custom/{resourceName}/{id} Update the details of an entry in the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.
PUT Method: Update, URL: Custom/{resourceName}/{id} Test

Update the details of an entry in the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.

Delete Custom/{resourceName}/{id} Delete an entry from the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.
DELETE Method: Delete, URL: Custom/{resourceName}/{id} Test

Delete an entry from the table for the resource as defined by {resourceName} in TR_DATASERVICE_TABLES with the given id {Id}.