Read UserInterfaceView
get
/userInterfaceView
Reads UserInterfaceView objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter(required): string
Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:Example:
ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'
-
OrderBy(required): string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<UserInterfaceView>
Type:
array
Title:
Show Source
List<UserInterfaceView>
-
Array of:
object UserInterfaceView
Title:
UserInterfaceView
UserInterfaceView Entity
Nested Schema : UserInterfaceView
Type:
object
Title:
UserInterfaceView
UserInterfaceView Entity
Show Source
-
CreateDate: string
(date-time)
The date this user interface view was created.
-
CreateUser: string
The name of the user that created this user interface view.
-
LastUpdateDate: string
(date-time)
The date this user interface view was last updated.
-
LastUpdateUser: string
The name of the user that last updated this user interface view.
-
Name: string
The name of the user interface view.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
UserObjectId: integer
(int32)
The unique ID of the associated user.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.