UpdateUdfValue
- Thomas Sherman (Deactivated)
- Bettina Borces
Updates the value of a UDF (user-defined field). User defined fields can be associated with Projects, Engagements, Clients or Resources, and can be integers, dates, strings, boolean or references to resources.
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request
The service request contains:
Name | Data Type | Required? | Default Value | Discussion |
|---|---|---|---|---|
UdfType | UdfType | yes | 'Project', 'Engagement', 'Client', 'Resource' or 'Invoice' | |
UdfName | string | yes | Name of the UDF | |
EntityUid | long | no | long.MinValue | Unique identifier for entity UDF is to be associated with. Specify this or EntityCode. |
EntityCode | string | no | null | Code for entity UDF is to be associated with. Specify this or EntityUid. |
DeleteUdfValueFlag | bool | no | false | True to delete UDF. |
UdfValueDateTime | DateTime | no | DateTime.MinValue | Specify for Date-valued UDFs, otherwise set to DateTime.MinValue |
UdfValueInteger | int | no | int.MinValue | Specify for integer or boolean valued UDFs, otherwise set to int.MinValue. Use 0 or 1 for boolean valued UDFs. |
UdfValueString | string | no | null | Specify for string-valued UDFs, otherwise leave null. |
UdfValueResourceUid | long | no | long.MinValue | Specify for resource-valued UDFs, otherwise set to long.MinValue. Specify this or UdfValueResourceReferenceSystemId |
UdfValueResource | string | no | null | Specify for resource-valued UDFs, otherwise leave null. Specify this or UdfValueResourceUid. |
Response
The following data is returned (in addition to what is documented in Responses describing the common elements of each web service response):
Name | Data Type | Discussion |
|---|---|---|
LockOwnerDisplayName | string | Name of user currently holding lock on entity (applies to engagements and projects only). This is populated if the web service returns error code 12002, indicating that the UDF could not be updated because the project or engagement it is attached to is currently locked. |