EnterpriseCustomFieldsUpdate Method

  • Article

Description

The PDS updates value list custom fields in the Enterprise Global Template of Microsoft Office Project Server 2003. The requested field must be an enterprise field and must support value lists.

The developer must provide the correct data types for the update. That is, if the field type is a number, then the Value elements in ValueList must all be numbers. The PDS simply updates the custom field with the new definition in the request and does not validate data types.

Syntax

<Request>
   <EnterpriseCustomFieldsUpdate>
      <CustomFields>
         <CustomField>
            <FieldID></FieldID>
            <FieldName></FieldName>
            <SelectionRequired></SelectionRequired>
            <Default></Default>
            <ValuelistInUse></ValuelistInUse>
            <ValuelistSortOrder></ValuelistSortOrder>
            <ValueList>
               <ValueItem>
                  <Phonetic></Phonetic>
                  <Value></Value>
                  <Description></Description>
               </ValueItem>
               <ValueItem>
                  <Phonetic></Phonetic>
                  <Value></Value>
                  <Description></Description>
               </ValueItem>
            </ValueList>
         </CustomField>
      </ CustomFields>
   </ EnterpriseCustomFieldsUpdate >
</Request>

Parameters

Multiple sets of custom fields are valid. Other parameters are optional.

FieldID

Required. Field definition to update. Conversion values for FieldID are listed in Field ID Values for Enterprise Custom Fields.

ValueList

Required. ValueList parameters provide the new field definition.

Return Value

If the custom field update is successful, then EnterpriseCustomFieldsUpdate returns a successful HRESULT and STATUS. If one update fails, the entire request fails.

<Reply>
   <HRESULT></HRESULT>
   <STATUS></STATUS>
   <UserName></UserName>
</Reply>

Remarks

The PDS checks Project Server security to determine whether the logged-on user has valid Project Server permissions.

The current user must also have the Enterprise Global template checked out to use EnterpriseCustomFieldsUpdate.