Overview
This web service updates the one or more user defined fields for a one or more specified entityentities.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | |
String | Yes | Click here for more information. | AVqwYHFUvUT/fJlt22N2DA== | |
Int32 | No | Click here for more |
information. | 3884 | |
SaveOrders | PwsSaveUserDefinedFieldsOrder[1..100] | Yes |
One or more "instructions" to modify user defined field values. | ||||
UdfType | String (1) | Yes | The user defined field type: "C" for Client "E" for Engagement "P" for Project "A" for Role "K" for Task "S" for Issue "R" for Resource "T" for Time Card "X" for Cost Card | P |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveUserDefinedFields>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AVqwYHFUvUT/fJlt22N2DA==</req:SessionTicket>
<req:ProjectorLockSetId>3884</req:ProjectorLockSetId>
<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>
<req:UdfType>P</req:UdfType>
</pws:serviceRequest>
</pws:PwsSaveUserDefinedFields>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-11-06T22:29:22.7960743Z |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10126 | InvalidEnumerationValueSpecified | An invalid value was specified for UdfType. Valid values are C, E, P, A, K, S, R, T, X. |
| 50024 | EntityNotFound | Error 50024, State 3: Entity not found ### [refStructureName:PwsProjectRef] |
| 50469 | EntityAlreadyLocked | Error 50469, State 1: One or more existing locks prevent acquisition of requested lock. |
| 50471 | LockStolen | Error 50471, State 1: Lock has been stolen. ### [referenceId1:3891] |
| 62438 | UdfValueUnexpected | When specifying user defined field values, be sure to only populate the proper type-specific value, based on the UDF data type. |