User Interface / Screen Filter

What can you do with UIScreenFilter?


Properties

Property Details
id
"id": 680
Type: Number
This is the unique numeric identifier for the UIScreenFilter
name
"name": "Hello World"
Type: String
isDefault
"isDefault": true
Type: Boolean
isFavorite
"isFavorite": true
Type: Boolean
uiScreenId
"uiScreenId": 442
Type: Number
Unique identifier for the associated UIScreen object.
userId
"userId": 570
Type: Number
Unique identifier for the associated User 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
  • isDefault
  • isFavorite
  • uiScreenId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the UIScreenFilter object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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