Overview
This structure represents is part of the response to PwsGetTimeEntryParameters and PwsGetExpenseEntryParameters and it contains metadata about the user defined fields associated with time cards or cost cards. The metadata consists of information such as the UDF data type, and valid values (for text list UDFs), as well as other attributes related to the actual UDF definition.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data | |
|---|---|---|---|---|---|---|
UdfDatatype | Stringtrue | N/A | The UDF data type: "D" for date "I" for numeric "R" for resource"T" for text "L" for text list "Y" for boolean "P" for relationshp type (i.e. JIRA and Zendesk) | I | ||
UdfRequiredFlag | Boolean | false | falseN/A | Will be 'true' if the UDF is marked as required. Note that boolean UDFs may not be considered required. | false | |
UdfValues | String (4000)true (if the UDFDatatype is 'L')[] | N/A | The values associated with a text list type user defined field. | |||
UdfIdentity | N/A | This structure represents the unique key fields associated with identifying a user defined field. | ||||
UdfConnectorCode | Stringfalse | N/A | The UDF connector code is associated with relationship type user defined fields. The UDF connector code is a unique identifier for an external connectorThis field identifies the external connector that applies to this user defined field. External connectors must be separately configured in Projector. | |||
UdfDetailSubstitutionCode | Stringfalse | N/A | The UDF detail substitution code is associated with relationship type user defined field detailed substitution codefields. Projector stores three values for a relationship type UDF, a UID, a code and text. This field determines which of these values should be substituted for {0} in the UdfItemDetailPageUrl. The possible values are: "U": The UDF's UID value "C": The UDF's Code value | |||
UdfItemDetailPageUrl | Stringfalse | N/A | The external connector UDF item detail page URL is associated with relationship type user defined fields. This is a URL that can be used as a link to the external entity referenced by a UDF value. The URL will contain a placeholder '{0}', that should be replaced by either the UID or code component of the UDF value (See UdfDetailSubstitutionCode). | |||
DecimalDigits | Byte | false | 0N/A | The number of decimal places associated with a numeric type user defined field. | 0 | |
| UdfPromptText | String | N/A | The prompt test for the UDF field. |
Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a:Udf1>
<a:UdfDatatype>I<UdfDatatype>P</a:UdfDatatype>
<a:UdfRequiredFlag>false</a:UdfRequiredFlag>
<a:UdfValues xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<a:UdfIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UdfId i:nil="true"/>
<b:UdfName>Attendees<UdfName>TUDF_Jira</b:UdfName>
<b:UdfUid>1152921504606860180<UdfUid>1152921504606857845</b:UdfUid>
</a:UdfIdentity>
<a:UdfConnectorCode i:nil="true"/>UdfConnectorCode>JIRA-V2</a:UdfConnectorCode>
<a:UdfDetailSubstitutionCode>C</a:UdfDetailSubstitutionCode>
<a:UdfDetailSubstitutionCode i:nil="true"/>UdfItemDetailPageUrl>https://projectorpsa.atlassian.net/browse/{0}</a:UdfItemDetailPageUrl>
<a:UdfItemDetailPageUrlDecimalDigits i:nil="true"/>
<a:DecimalDigits>0<UdfPromptText>Search for Issue</a:DecimalDigits>UdfPromptText>
</a:Udf1>
|