Read UDFCodes
get
/udfCode
Reads UDFCode 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<UDFCode>
Type:
array
Title:
Show Source
List<UDFCode>
-
Array of:
object UDFCode
Title:
UDFCode
UDFCode Entity
Nested Schema : UDFCode
Type:
object
Title:
UDFCode
UDFCode Entity
Show Source
-
CodeTypeObjectId: integer
(int32)
The unique ID of the code type.
-
CodeTypeTitle: string
The title of the parent code type for this code.
-
CodeValue: string
The short ID that uniquely identifies the code within the code type.
-
CreateDate: string
(date-time)
The date this code was created.
-
CreateUser: string
The name of the user that created this code.
-
Description: string
The description of the code.
-
LastUpdateDate: string
(date-time)
The date this code was last updated.
-
LastUpdateUser: string
The name of the user that last updated this code.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
SequenceNumber: integer
(int32)
The sequence number for sorting.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.