User Interface / Module

What can you do with UIModule?


Properties

Property Details
id
"id": 857
Type: Number
This is the unique numeric identifier for the UIModule
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
sortOrder
"sortOrder": 90
Type: Number
uiApplicationId
"uiApplicationId": 468
Type: Number
Unique identifier for the associated UIApplication object.


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
  • uiApplicationId

DataFlow PATCH objects:


End Points

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