CustomFields.UpdateCustomFields method

  • Article

Creates, modifies, or deletes enterprise custom fields.

Namespace:  WebSvcCustomFields
Assembly:  ProjectServerServices (in ProjectServerServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/UpdateCustomFields", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Sub UpdateCustomFields ( _
    cfds As CustomFieldDataSet, _
    validateOnly As Boolean, _
    autoCheckIn As Boolean _
)
'Usage
Dim instance As CustomFields
Dim cfds As CustomFieldDataSet
Dim validateOnly As Boolean
Dim autoCheckIn As Boolean

instance.UpdateCustomFields(cfds, validateOnly, _
    autoCheckIn)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/UpdateCustomFields", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public void UpdateCustomFields(
    CustomFieldDataSet cfds,
    bool validateOnly,
    bool autoCheckIn
)

Parameters

  • validateOnly
    Type: System.Boolean

    If true, validate only the CustomFieldDataSet.

  • autoCheckIn
    Type: System.Boolean

    If true, check in the custom fields after they are updated.

Remarks

UpdateCustomFields creates custom fields if the CustomFieldDataSet includes new custom fields, modifies existing custom fields, and deletes custom fields that are not in the CustomFieldDataSet.

Warning

The UpdateCustomFields method and the UpdateCustomFields2 method, as well as Project Web App, all allow you to create an enterprise project custom field of type Flag, and set the custom field to be workflow controlled. However, Project Server workflows cannot control Flag custom fields. You should not set project custom fields of type Flag for workflow control.

Tip

The UpdateCustomFields method ignores the locale setting of the computer running Project Server. The UpdateCustomFields2(CustomFieldDataSet, Boolean, Boolean) method can use locale-dependent values for formulas that calculate custom fields and graphical indicators.

Project Server Permissions

Permission

Description

ManageEnterpriseCustomFields

Allows a user to modify the definitions of enterprise custom fields and lookup table values. Global permission.

If the user did not check out the custom fields, UpdateCustomFields also requires administrative permissions to force check in.

See also

Reference

CustomFields class

CustomFields members

WebSvcCustomFields namespace

UpdateCustomFields2(CustomFieldDataSet, Boolean, Boolean)