User Interface / Screen

What can you do with UIScreen?


Properties

Property Details
id
"id": 444
Type: Number
This is the unique numeric identifier for the UIScreen
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
filterColumn
"filterColumn": "Hello World"
Type: String
resource
"resource": "Hello World"
Type: String
uiModuleId
"uiModuleId": 597
Type: Number
Unique identifier for the associated UIModule object.
showFilters
"showFilters": true
Type: Boolean
allowNone
"allowNone": true
Type: Boolean
allowCreate
"allowCreate": true
Type: Boolean
allowRead
"allowRead": true
Type: Boolean
allowUpdate
"allowUpdate": true
Type: Boolean
allowDelete
"allowDelete": true
Type: Boolean


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
  • filterColumn
  • resource
  • uiModuleId
  • showFilters
  • allowNone
  • allowCreate
  • allowRead
  • allowUpdate
  • allowDelete

DataFlow PATCH objects:


End Points

DELETEapi/v1/UI/Screen/{id:int}
Delete an instance of the UIScreen object.
GETapi/v1/UI/Screen
Retrieve all of the UIScreen objects.
GETapi/v1/UI/Screen/Metadata
Retrieve all of the meta data details of the UIScreen object.
GETapi/v1/UI/Screen/Metadata/{option}
Retrieve all the meta data details of the UIScreen object based on provided options.
{option}Metadata options for the UIScreen object.
GETapi/v1/UI/Screen/Paged
Retreive all of the UIScreen objects in a paged fashion.
GETapi/v1/UI/Screen/Paged/Detail
Retreive all of the UIScreen objects in a paged fashion with all object details.
GETapi/v1/UI/Screen/{id:int}
Retrieve an instance of the UIScreen object by it's ID.
{id:int}Unique identifier for the UIScreen object.
GETapi/v1/UI/Screen/{id:int}/Detail
Retreive all of the Detail objects for the specified UIScreen.
{id:int}Unique identifier for the UIScreen object.
PATCHapi/v1/UI/Screen/{id:int}
Update the UIScreen object and optionally make changes to any child objects.
POSTapi/v1/UI/Screen
Create a new instance of the UIScreen object.
PUTapi/v1/UI/Screen/{id:int}
Update an existing instance of the UIScreen object.