Create UDFValue
post
/udfValue
Send a request to this endpoint to create one or more UDFValue. An application object will be created for each JSON object provided in the request body.
Request
Header Parameters
-
Authorization(required):
OAuth token
Supported Media Types
- application/json
A list of UDFValue objects.
Root Schema : List<UDFValue>
Type:
array
Title:
Show Source
List<UDFValue>
-
Array of:
object UDFValue
Title:
UDFValue
UDFValue Entity
Nested Schema : UDFValue
Type:
object
Title:
UDFValue
UDFValue Entity
Show Source
-
CodeValue: string
The short ID that uniquely identifies the associated UDF code within the UDF code type.
-
ConditionalIndicator: integer
(int32)
The conditional indicator of the user defined field, obtained by evaluating the conditional expression.
-
Cost: number
(double)
The value of the cost UDF.
-
CreateDate: string
(date-time)
The date this UDF value was created.
-
CreateUser: string
The name of the user that created this UDF value.
-
Description: string
The description of the associated UDF code.
-
Double: number
(double)
The value of the double UDF.
-
FinishDate: string
(date-time)
The value of the finish date UDF.
-
ForeignObjectId: integer
(int32)
The unique ID of the business object to which the UDF is assigned: ProjectObjectId, ActivityObjectId, ResourceObjectId, etc.
-
Formula: string
-
Indicator: string
The value of the indicator UDF.
-
Integer: integer
(int32)
The value of the integer UDF.
-
IsBaseline: boolean
The boolean value indicating if this business object is related to a Project or Baseline
-
IsTemplate: boolean
The boolean value indicating if this business object is related to a template Project.
-
IsUDFTypeCalculated: boolean
The flag indicating whether this is a value associated with a calculated user defined field type.
-
IsUDFTypeConditional: boolean
The flag indicating whether this is a value associated with a user defined field type having a conditional expression.
-
LastUpdateDate: string
(date-time)
The date this UDF value was last updated.
-
LastUpdateUser: string
The name of the user that last updated this UDF value.
-
ProjectObjectId: integer
(int32)
The unique ID of the associated project.
-
StartDate: string
(date-time)
The value of the start date UDF.
-
Text: string
The value of the text UDF.
-
UDFCodeObjectId: integer
(int32)
The data type of the associated user-defined field type: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code".
-
UDFTypeDataType: string
The unique ID of the associated UDF type.
-
UDFTypeObjectId: integer
(int32)
The unique ID of the associated UDF type.
-
UDFTypeSubjectArea: string
The subject area of the associated user-defined field type: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents".
-
UDFTypeTitle: string
The name/title of the associated user-defined field type.
Response
Supported Media Types
- application/json
201 Response
Resource Created.
Root Schema : CreateUDFValueResponse
Type:
object
Title:
CreateUDFValueResponse
CreateUDFValueResponse Entity
Show Source
-
ForeignObjectId: integer
(int32)
The unique ID of the business object to which the UDF is assigned:ProjectObjectId, ActivityObjectId, ResourceObjectId, etc.
-
UDFTypeObjectId: integer
(int32)
The unique ID of the associated UDF type.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.