Read UDFTypes
get
/udfType
Reads UDFType 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<UDFType>
Type:
array
Title:
Show Source
List<UDFType>
-
Array of:
object UDFType
Title:
UDFType
UDFType Entity
Nested Schema : UDFType
Type:
object
Title:
UDFType
UDFType Entity
Show Source
-
CreateDate: string
(date-time)
The date this user-defined field was created.
-
CreateUser: string
The name of the user that created this user-defined field.
-
DataType: string
The data type of the user-defined field: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code".
-
DisplayIndicatorFlag: boolean
-
Formula: string
-
IsCalculated: boolean
The flag indicating whether this is a calculated user defined field type.
-
IsConditional: boolean
The flag indicating whether this is a indicator user defined field type.
-
IsSecureCode: boolean
the flag indicating whether this is a secure code type
-
LastUpdateDate: string
(date-time)
The date this user-defined field was last updated.
-
LastUpdateUser: string
The name of the user that last updated this user-defined field.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
SubjectArea: string
The subject area of the user-defined field: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents".
-
SummaryMethod: string
-
Title: string
The name/title of the user-defined field.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.