User Interface / Application

What can you do with UIApplication?


Properties

Property Details
id
"id": 113
Type: Number
This is the unique numeric identifier for the UIApplication
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
sortOrder
"sortOrder": 140
Type: Number
audience
"audience": "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
  • description
  • sortOrder
  • audience

DataFlow PATCH objects:


End Points

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