User Interface / Table Reference

What can you do with UITableReference?


Properties

Property Details
id
"id": 123
Type: Number
This is the unique numeric identifier for the UITableReference
name
"name": "Hello World"
Type: String
tableDtoTypeKey
"tableDtoTypeKey": "Hello World"
Type: String
filterColumn
"filterColumn": "Hello World"
Type: String
caption
"caption": "Hello World"
Type: String
icon
"icon": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • tableDtoTypeKey
  • filterColumn
  • caption
  • icon

DataFlow PATCH objects:


End Points

DELETEapi/v1/UI/Table/Reference/{id:int}
Delete an instance of the UITableReference object.
GETapi/v1/UI/Table/Reference
Retrieve all of the UITableReference objects.
GETapi/v1/UI/Table/Reference/Metadata
Retrieve all of the meta data details of the UITableReference object.
GETapi/v1/UI/Table/Reference/Metadata/{option}
Retrieve all the meta data details of the UITableReference object based on provided options.
{option}Metadata options for the UITableReference object.
GETapi/v1/UI/Table/Reference/Paged
Retreive all of the UITableReference objects in a paged fashion.
GETapi/v1/UI/Table/Reference/{id:int}
Retrieve an instance of the UITableReference object by it's ID.
{id:int}Unique identifier for the UITableReference object.
POSTapi/v1/UI/Table/Reference
Create a new instance of the UITableReference object.
PUTapi/v1/UI/Table/Reference/{id:int}
Update an existing instance of the UITableReference object.