CustomFields.ReadCustomFields Method

Gets enterprise custom field definitions.

Namespace:  [CustomFields Web service]
Service reference: http://ServerName:32843/[Project Service Application GUID]/PSI/CustomFields.svc
Web service reference: http://ServerName/ProjectServerName/_vti_bin/PSI/CustomFields.asmx?wsdl

[SoapDocumentMethodAttribute("", RequestNamespace = "", 
	ResponseNamespace = "", 
	Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public CustomFieldDataSet ReadCustomFields(
	string xmlFilter,
	bool autoCheckOut


Type: System.String
Limits the amount of data returned.
Type: System.Boolean
If true, check out the custom fields for modification.

Return Value

Type: [CustomFields Web service].CustomFieldDataSet
The CustomFieldDataSet contains information specified by the xmlFilter parameter.

The primary DataTable in the CustomFieldDataSet is the CustomFieldsDataTable. There are no secondary datatables. The xmlFilter parameter works with the Criteria operators to filter rows in the CustomFieldsDataTable. You can use the Fields.Add method to filter columns in the primary CustomFieldsDataTable.


For Project Server 2010, the returned CustomFieldDataSet can include the Relative Importance custom field and the Project Impact custom fields. Project Web App does not show these custom fields in the Enterprise Custom Fields and Lookup Tables page, because they are built-in for portfolio analyses and cannot be modified or deleted.


The ReadCustomFields method ignores the locale setting of the computer running Project Server. The ReadCustomFields2 method returns locale-dependent values for formulas that calculate custom fields and graphical indicators.

For a code example that uses the ReadCustomFields2 method, see ReadCustomFields2. For more information, see How to: Use a Filter Parameter with PSI Methods

Project Server Permissions




Allows a user to connect to the Project Server database from Project Professional. Global permission.


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


Allows a user to manage Project Server users and groups. Global permission.


Allows a user to create a project. Global permission.


Allows a user to view resource allocation data. Global permission.

Community Additions