GetUdfValues
- Thomas Sherman (Deactivated)
- Bettina Borces
For a given user-defined field (UDF), get a list of Projector entities that have a defined value for the UDF, along with the UDF values.
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 | string(1) | yes | Set to type of UDF: "C" for client, "E" for Engagement, "P" for Project, "R" for Resource or "I" for Invoice. Service does not support Role, Task, Issue, Time card, or Cost card UDF types. | |
UdfName | string(32) | yes | The name of the UDF. Stoplight UDFs are not supported. | |
UdfValueInteger | integer | no | If a value is specified here, and the UDF is an integer UDF, results will be limited to those Clients, Engagements, Projects, Resources or Invoices whose value for the given UDF matches this value. | |
UdfValueString | string(255) | no | If a value is specified here, and the UDF is a string UDF, results will be limited to those Clients, Engagements, Projects, Resources or Invoices whose value for the given UDF matches this value. | |
UdfValueDate | date | no | If a value is specified here, and the UDF is a date UDF, results will be limited to those Clients, Engagements, Projects, Resources or Invoices whose value for the given UDF matches this value. |
Response
For each value in the result set the following data is returned:
Name | Data Type | Discussion |
|---|---|---|
EntityReferenceID | string | Content depends on UDF type. For Clients, it is the Client Number, for Engagements, the Engagement Code, for Projects the Project Code, for Resources, the Resource Reference System Id and for Invoices, the Invoice Number |
EntityName | string | Content depends on UDF type. For Clients, it is the Client Name, for Engagements, the Engagement Name, for Projects the Project Name, for Resources, the Resource Display Name and for Invoices, the Invoice Number |
UdfValue | string | The UDF value, converted to a string if necessary. |