Versions Compared

Old Version 8

changes.mady.by.user Luke Wright

Saved on

compared with

New Version Current

changes.mady.by.user Min Zeng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure 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.

...

Panel
titlePwsCardUdf
  • PwsCardUdf
    • UdfDatatype: String
    • UdfRequiredFlag: Boolean
    • UdfValues: String (4000)
    • UdfIdentity: PwsUserDefinedFieldRef
    • UdfConnectorCode: String
    • UdfDetailSubstitutionCode: String
    • UdfItemDetailPageUrl: String
    • DecimalDigits: Byte
    • UdfPromptText: String

Elements


Element

Data Type

Required?

Default

Description

Sample Data

UdfDatatype

String

N/A


The UDF data type:

"D" for date

"I" for numeric

"T" for text

"L" for text list

"Y" for boolean

"P" for relationshp type (i.e. JIRA and Zendesk)

I

UdfRequiredFlag

Boolean

N/A


Will be 'true' if the UDF is marked as required. Note that boolean UDFs may not be considered required.

false

UdfValues

String[]

N/A


The values associated with a text list type user defined field.


UdfIdentity

PwsUserDefinedFieldRef

N/A


This structure represents the unique key fields associated with identifying a user defined field.


UdfConnectorCode

String

N/A


The UDF connector code is associated with relationship type user defined fields. This field identifies the external connector that applies to this user defined field. External connectors must be separately configured in Projector.


UdfDetailSubstitutionCode

String

N/A


The UDF detail substitution code is associated with relationship type user defined fields. 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

String

N/A


The 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

N/A


The number of decimal places associated with a numeric type user defined field.

0
UdfPromptTextStringN/A
The prompt test for the UDF field.

Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <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>