Overview
This structure contains the complete set of information about a 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)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 used defined field values are to be modified. These fields have different meanings, depending upon the entity type (as identified in PwsUserDefinedFieldDetail):
| 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
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
EntityCode | String (24) | One of EntityCode, EntityName or EntityUid is required | The entity code is a unique identifier for an entity. Entities include Clients, Engagements, Projects, Roles, Tasks, Issues, Resource, Time Card or Cost Cardsidentifying the entity to which the UDF values are associated (see table above). | P001468-001 |
EntityId | Int32 | No | The entity id is a unique identifier for an entity. For internal use onlyidentifying the entity to which the UDF values are associated (see table above). | |
EntityName | String (255) | See EntityCode | The entity name is a unique identifier for an entityidentifying the entity to which the UDF values are associated (see table above). | |
EntityUid | Int64 | See EntityCodeA unique and immutable Id for an entity | The entity UID identifying the entity to which the UDF values are associated (see table above). | |
UserDefinedFields | PwsUserDefinedFieldDetail[1..100] | YesThis represents all the fields that make up a user defined field value | The UDF values to be inserted or updated. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |