Overview

This structure represents an instruction to save one or more user defined field values for a given entity. This structure is utilized by the web service PwsSaveUserDefinedFields.

The user defined field can be associated with a client, engagement, project, role, task, project issue or resource. This structure is not used for time and cost card UDFs. The EntityId, EntityUid, EntityCode and EntityName together identify the Projector entity whose user defined field values are to be modified. These fields have different meanings, depending upon the entity type (as identified by UdfType argument to PwsSaveUserDefinedFields):

Entity	EntityId	EntityUid	EntityCode	EntityName
Client	ClientId	ClientUid	ClientNumber	N/A
Engagement	EngagementId	EngagementUid	EngagementCode	N/A
Project	ProjectId	ProjectUid	ProjectCode	N/A
Role	ProjectRoleId	ProjectRoleUid	ExternalSystemId	N/A
Task	ProjectTaskId	ProjectTaskUid	ExternalsystemId	N/A
Project Issue	ProjectIssueId	ProjectIssueUid	ExternalSystemId	N/A
Resource	ResourceId	ResourceUid	ResourceReferenceSystemId	ResourceDisplayName

Format

PwsSaveUserDefinedFieldsOrder

PwsSaveUserDefinedFieldsOrder
- EntityCode: String (24)
- EntityId: Int32
- EntityName: String (255)
- EntityUid: Int64
- UserDefinedFields: PwsUserDefinedFieldDetail[1..100]

Elements

Element	Data Type	Required?	Description	Sample Data
EntityCode	String (24)	One of EntityCode, EntityName or EntityUid is required	The entity code identifying the entity to which the UDF values are associated (see table above).	P001468-001
EntityId	Int32	No	The entity id identifying the entity to which the UDF values are associated (see table above).
EntityName	String (255)	See EntityCode	The entity name identifying the entity to which the UDF values are associated (see table above).
EntityUid	Int64	See EntityCode	The entity UID identifying the entity to which the UDF values are associated (see table above).
UserDefinedFields	PwsUserDefinedFieldDetail[1..100]	Yes	The UDF values to be inserted or updated.

Usage Example(s)

Example 01

           <req:SaveOrders>
               <com:PwsSaveUserDefinedFieldsOrder>
                  <com:EntityCode>P001468-001</com:EntityCode>
                  <com:UserDefinedFields>
                     <com:PwsUserDefinedFieldDetail>
                        <com:UdfName>PR-Assigned Resource</com:UdfName>
                        <com:ResourceIdentityValue>
                           <com:ResourceReferenceSystemId>IT Manager</com:ResourceReferenceSystemId>
                        </com:ResourceIdentityValue>
                     </com:PwsUserDefinedFieldDetail>
                  </com:UserDefinedFields>
               </com:PwsSaveUserDefinedFieldsOrder>
            </req:SaveOrders>