Overview
This structure contains the complete set of information about a project role. The structure is used both to retrieve detailed project role information and to pass information about a project role back to the server to get updated.
The candidates, resources and criteria represented in this structure will reflect either the requested values, assigned values or effective values, as determined by the mode specified when retrieving the record (see PwsGetProject). This applies to:
- CandidateIdentities
- CostCenterAnyFlag
- CostCenterCriteria
- CostCenterIdentity
- Keywords
- LocationAnyFlag
- LocationIdentities
- LocationIdentity
- ResourceIdentity
- SkillCriteria
- TitleIdentities
- TitleIdentity
Format
- PwsProjectRoleDetail
- ExternalSystemIdentifier: String (50)
- ProjectRoleId: Int32
- ProjectRoleUid: Int64
- BaseRateOnTitleIdentity: PwsTitleRef
- CandidateIdentities: PwsResourceRef
- CostCenterAnyFlag: Boolean
- CostCenterCriteria: PwsCostCenterCriteria
- CostCenterIdentity: PwsCostCenterRef
- DefaultSchedulingMode: String (1)
- Description: String (255)
- Keywords: String (255)
- LocationAnyFlag: Boolean
- LocationIdentities: PwsLocationRef
- LocationIdentity: PwsLocationRef
- NewExternalSystemIdentifier: String
- ResourceIdentity: PwsResourceRef
- RoleEndDate: DateTime
- RoleName: String (32)
- RoleStartDate: DateTime
- ShareCostCenterIdentity: PwsCostCenterRef
- SkillCriteria: PwsSkillCriteria
- TitleIdentities: PwsTitleRef
- TitleIdentity: PwsTitleRef
- RdcTransferCurrencyIdentity: PwsCurrencyRef
- RdcTransferHourlyRate: Double
- RevenueTransferHourlyRate: Double
- UserDefinedFields: PwsUserDefinedFieldDetail
- RateExceptions: PwsProjectRoleRateException
- RdcExceptions: PwsProjectRoleRDCException
- InheritPurchaseOrderNumberFlag: Boolean
- PurchaseOrderNumber: String (50)
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
ExternalSystemIdentifier | String (50) | One of ExternalSystemIdentifier or ProjectRoleUid is required | The external system identifier is a unique identifier for a project role (may be null, but once set can only be updated to a different, non-null value). | #00001 | |
ProjectRoleId | Int32 | On Insert: No On Update: 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. | 1152921504608152048 | |
BaseRateOnTitleIdentity | On Insert: No On Update: No | If the role has a billing title override, this identifies the title to base rates upon. Click here for more information. | |||
CandidateIdentities | On Insert: No On Update: No | A collection of named resource candidates for the role. Click here for more information. | |||
CostCenterAnyFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', all cost centers are selected as part of the unnamed candidate search criteria. | false |
CostCenterCriteria | On Insert: No On Update: No | A collection of cost centers that are selected as part of the unnamed candidate search criteria. Click here for more information. | |||
CostCenterIdentity | On Insert: No On Update: No | The preferred, allocated or effective cost center in the unnamed candidate search criteria. Click here for more information. | |||
DefaultSchedulingMode | String (1) | On Insert: No On Update: No | Engagement Type's default setting | The scheduling mode for this role: D: daily W: weekly | |
Description | String (255) | On Insert: No On Update: No | The description for this role. | Business analyst (Web Commerce)_ | |
Keywords | String (255) | On Insert: No On Update: No | The keywords used in the unnamed candidate search criteria. | HTML | |
LocationAnyFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', all locations are selected as part of the unnamed candidate search criteria. | false |
LocationIdentities | On Insert: No On Update: No | A collection of locations that are selected as part of the unnamed candidate search criteria. Click here for more information. | |||
LocationIdentity | On Insert: No On Update: No | The preferred, allocated or effective location in the unnamed candidate search criteria. Click here for more information. | |||
NewExternalSystemIdentifier | String | On Insert: No On Update: No | See ExternalSystemIdentifier above. Use this to modify the external system identifier for an existing project role. | #00001-1 | |
ResourceIdentity | On Insert: No On Update: No | The preferred, allocated or effective named candidate for this role. Click here for more information. | |||
RoleEndDate | DateTime | On Insert: No On Update: No | The end date of this role. | 2018-12-31z | |
RoleName | String (32) | On Insert: Yes On Update: No | The name of this role. | Business Analyst | |
RoleStartDate | DateTime | On Insert: No On Update: No | The start date of this role. | 2018-07-01z | |
ShareCostCenterIdentity | On Insert: No On Update: No | The identity of shared cost center for this role. Click here for more information. | |||
SkillCriteria | On Insert: No On Update: No | The collection of skills that are selected in the unnamed candidate search criteria. Click here for more information. | |||
TitleIdentities | On Insert: No On Update: No | A collection of Titles that are selected as part of the unnamed candidate search criteria. Click here for more information. | |||
TitleIdentity | On Insert: No On Update: No | The preferred, allocated or effective title in the unnamed candidate search criteria. Click here for more information. | |||
RdcTransferCurrencyIdentity | On Insert: No On Update: No | Resource's cost center currency | The RDC transfer rate currency for this role. Click here for more information. | ||
RdcTransferHourlyRate | Double | On Insert: No On Update: No | The RDC transfer hourly rate for this role. | 35 | |
RevenueTransferHourlyRate | Double | On Insert: No On Update: No | The revenue transfer hourly rate for this role. | 80 | |
UserDefinedFields | On Insert: No On Update: No | A collection of user defined fields and their values for this role. Click here for more information. | |||
RateExceptions | On Insert: No On Update: No | Overrides to resource's title based rates. Click here for more information. | |||
RdcExceptions | On Insert: No On Update: No | Overrides to resource's RDC rates. Click here for more information. | |||
InheritPurchaseOrderNumberFlag | Boolean | On Insert: No On Update: No | true | If set to 'true', project inherits the purchase order number from the project. | |
PurchaseOrderNumber | String | On Insert: No On Update: No | Project's purchase order number | The purchase order number associated with this project role. Specify only if not inheriting the purchase order number from the project. |