Jump to

• Request
• Response

Read UDFCodes

get

/udfCode

Reads UDFCode objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter: 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: string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization:
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<UDFCode>

Type: array

Title: List<UDFCode>

Show Source

• Array of: object UDFCode
  Title: UDFCode

  UDFCode Entity

{
    "title":"List<UDFCode>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UDFCode"
    }
}

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.

{
    "title":"UDFCode",
    "type":"object",
    "properties":{
        "CodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the code type.",
            "format":"int32"
        },
        "CodeTypeTitle":{
            "type":"string",
            "description":"The title of the parent code type for this code."
        },
        "CodeValue":{
            "type":"string",
            "description":"The short ID that uniquely identifies the code within the code type."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this code was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this code."
        },
        "Description":{
            "type":"string",
            "description":"The description of the code."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this code was last updated.\t",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this code."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        }
    },
    "description":"UDFCode Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top