Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The PwsProjectSummary data type This structure includes basic information about a project. The information represented in this structure is not comprehensive and only includes certain key attributes of a project that is part of a list. deemed to be useful in a listing of projects.

Format

Panel
titlePwsProjectSummary
  • PwsProjectSummary
    • ProjectCode: String (24)
    • ProjectId: Int32
    • ProjectUid: Int64
    • EngagementIdentity: PwsEngagementRef
    • ProjectName: String (255)

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String

On Insert: Yes

On Update: Yes (if ProjectUid is not supplied

(24)

The project code is a unique identifier for a project. See "NewProjectCode" in PwsProjectDetail for guidance on how to change the project code of an existing project. 

P001053-001

ProjectId

Int32

On Insert: No

On Update: No

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


ProjectUid

Int64

On Insert: No

On Update: Yes (if ProjectCode is not supplied)

A unique and immutable identifier for an engagement.

1152921504607161597

EngagementIdentity

PwsEngagementRef

The engagement that this project belongs to. Click here for more information.


ProjectName

String (255)

On Insert: Yes

On Update: No

The project name.

Don Carlo (2010-2020)

Usage Example(s)

Code Block
languagexml
titleExample 01
collapsetrue
               <b:PwsProjectSummary>
                  <b:ProjectCode>P001052-001</b:ProjectCode>
                  <b:ProjectId i:nil="true"/>
                  <b:ProjectUid>1152921504607161597</b:ProjectUid>
                  <b:EngagementIdentity>
                     <b:EngagementCode>P001052</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607090183</b:EngagementUid>
                  </b:EngagementIdentity>
                  <b:ProjectName>Hello Luke</b:ProjectName>
               </b:PwsProjectSummary>