User Interface / Screen / Extension

What can you do with UIScreenExtension?


Properties

Property Details
id
"id": 159
Type: Number
This is the unique numeric identifier for the UIScreenExtension
name
"name": "Hello World"
Type: String
uiScreenId
"uiScreenId": 881
Type: Number
Unique identifier for the associated UIScreen object.
sortOrder
"sortOrder": 280
Type: Number


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
  • uiScreenId
  • sortOrder

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 UIScreenExtension object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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