PwsProjectRoleRef

Overview


This structure represents the unique key fields associated with identifying a project role. A role represents demand for labor. This demand is then supplied by a resource assigned to the role. For example, project X needs a social media director which will be staffed by Henry. Roles are booked hours so that the resource and you know who is working on what and when. Project roles can be identified by an ExternalSystemIdentifier or ProjectRoleUid. When specifying a PwsProjectRoleRef as an input to a web service, you may specify one or both the ExternalSystemIdentifier and ProjectRoleUid. However, if you do specify both, they must both refer to the same project role or the project role reference will not be considered valid. When a PwsProjectRoleRef is returned in the response to a web service, both the ExternalSystemIdentifier and ProjectRoleUid will be populated, and guaranteed to refer to a single project role.

Format


PwsProjectRoleRef
  • PwsProjectRoleRef
    • ExternalSystemIdentifier: String (50)
    • ProjectRoleId: Int32
    • ProjectRoleUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

ExternalSystemIdentifier

String (50)

One of ExternalSystemIdentifier or ProjectRoleUid is required

The external system identifier is a unique identifier for a project task (may be null, but once set can only be updated to a different, non-null value).


ProjectRoleId

Int32

No

The project role Id is a unique identifier for a project role. For internal use only. 


ProjectRoleUid

Int64

See ExternalSystemIdentifier

 A unique and immutable identifier for a project role.

1152921504609219128 

Usage Example(s)


Example 01
                     <com:ProjectRoleIdentity>
                        <com:ProjectRoleUid>1152921504609219128</com:ProjectRoleUid>
                     </com:ProjectRoleIdentity>