...
Panel | ||
---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
ProjectCode | String (24) | One of ProjectCode or ProjectUid is required |
The project code is a unique identifier for a project. See "NewProjectCode" for guidance on how to change the project code of an existing engagement. | P001395-001 | ||
ProjectId | Int32 | No |
The project Id is a unique identifier for a project. For internal use only. |
ProjectUid | Int64 | See ProjectCode |
A unique and immutable identifier for a project | 1152921504607412209 | |
EngagementDescriptor | Yes |
This structure contains key fields associated with an engagement |
LocationIdentity | Yes |
The location associated with the project |
ProjectCloseDate | DateTime | No |
The project close / end date |
ProjectDescription | String (1000) | No |
The project description |
ProjectManager | Yes |
The project manager |
ProjectName | String | Yes |
The project name | New Web Services Project (A) |
ProjectOpenDate | DateTime | Yes |
The project start / open date | 2018-01-01T00:00:00Z | ||
ProjectRoles | PwsRole [???] | No |
The project roles |
ProjectStageIdentity | Yes |
The project stage |
UnavailableReasonCode | String | No |
The reason code in the instance that the project is unavailable for time or expense |
Udf1InactiveFlag | Boolean | No | false | If set to 'true, the first time / cost card user defined field is inactive | false |
Udf1Values | String [???] | No |
If the first user defined field is a pick list these are the values in the list |
Udf2InactiveFlag | Boolean | No | false | If set to 'true, the second time / cost card user defined field is inactive | false |
Udf2Values | String [???] | No |
If the second user defined field is a pick list these are the values in the list |
Udf1DefaultValue | String (4000) | No |
If the first user defined field is a pick list this is the default value |
Udf2DefaultValue | String (4000) | No |
If the second user defined field is a pick list this is the default value |
ExpenseTypeIdentities | PwsExpenseTypeRef [???] | No |
The expense types that are valid for this project. If expense type configuration is not a factor, all expense types that are enabled for expense entry will be returned. |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<a:ProjectDescriptor> <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001395-001</ProjectCode> <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607412209</ProjectUid> <a:EngagementDescriptor> <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001395</EngagementCode> <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607324698</EngagementUid> <a:ClientDescriptor> <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber> <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid> <a:ClientName>Projector PSA</a:ClientName> <a:ParentClientDescriptor i:nil="true"/> </a:ClientDescriptor> <a:EngagementManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:EngagementManager> <a:EngagementName>Web Services Engagement</a:EngagementName> <a:EngagementTypeDescriptor> <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time and Materials</EngagementTypeName> <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">TandM</EngagementTypeShortName> <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606863884</EngagementTypeUid> <a:BillableFlag>true</a:BillableFlag> </a:EngagementTypeDescriptor> <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits> <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:CurrencyCode>USD</b:CurrencyCode> <b:CurrencyId i:nil="true"/> <b:CurrencyUid>1152921504606851838</b:CurrencyUid> </a:EngagementCurrencyIdentity> </a:EngagementDescriptor> <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:LocationId i:nil="true"/> <b:LocationName>USA</b:LocationName> <b:LocationUid>1152921504606855985</b:LocationUid> </a:LocationIdentity> <a:ProjectCloseDate i:nil="true"/> <a:ProjectDescription i:nil="true"/> <a:ProjectManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:ProjectManager> <a:ProjectName>New Web Services Project (A)</a:ProjectName> <a:ProjectOpenDate>2018-01-01T00:00:00Z</a:ProjectOpenDate> <a:ProjectRoles> <a:PwsRole> <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609522500</ProjectRoleUid> <a:RoleEndDate i:nil="true"/> <a:RoleName>JS</a:RoleName> <a:RoleStartDate>2018-01-01T00:00:00Z</a:RoleStartDate> </a:PwsRole> </a:ProjectRoles> <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ProjectStageId i:nil="true"/> <b:ProjectStageName>Delivery</b:ProjectStageName> <b:ProjectStageShortName>Delivery</b:ProjectStageShortName> <b:ProjectStageUid>1152921504606853304</b:ProjectStageUid> </a:ProjectStageIdentity> <a:UnavailableReasonCode i:nil="true"/> <a:Udf1InactiveFlag>false</a:Udf1InactiveFlag> <a:Udf1Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <a:Udf2InactiveFlag>false</a:Udf2InactiveFlag> <a:Udf2Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <a:Udf1DefaultValue i:nil="true"/> <a:Udf2DefaultValue i:nil="true"/> <a:ExpenseTypeIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> </a:ProjectDescriptor> |
...