/
PwsProjectRef

PwsProjectRef

Overview


This structure represents the unique key fields associated with identifying a project. Projects can be identified by ProjectCode or ProjectUid. When specifying a PwsProjectRef as an input to a web service, you may specify one or both the ProjectCode and/or ProjectUid. However, if you do specify both, they must both refer to the same project or the project reference will not be considered valid. When a PwsProjectRef is returned in the response to a web service, both the ProjectCode and ProjectUid will be populated, and guaranteed to refer to a single project.

Format


PwsProjectRef
  • PwsProjectRef
    • ProjectCode: String (24)
    • ProjectId: Int32
    • ProjectUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

ProjectCode

String (24)

One of ProjectCode or ProjectUid is required

The project code is a unique identifier for a project.

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.

1152921504607412208

Usage Example(s)


Example 01 - ProjectCode Only
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
               </com:PwsProjectRef>
Example 02 - ProjectCode and ProjectUid
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
                  <com:ProjectUid>1152921504607412209</com:ProjectUid>
               </com:PwsProjectRef>

Related content

PwsProjectSummary
PwsProjectSummary
More like this
PwsGetProject
PwsGetProject
Read with this
PwsProjectIssueRef
PwsProjectIssueRef
More like this
PwsGetProjectList
PwsGetProjectList
Read with this
PwsProjectStageRef
PwsProjectStageRef
More like this
PwsProjectDetail
PwsProjectDetail
Read with this