Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

This structure contains the complete set of information about a project issue. The structure is used both to retrieve detailed project information and to pass information about a project back to the server to get updated.

Format

PwsProjectIssueDetail
  • PwsProjectIssueDetail
    • ProjectIssueId: Int32
    • ProjectIssueUid: Int64
    • ReferenceId: String
    • AttachmentClearFlag: Boolean
    • Attachments: PwsProjectIssueAttachmentDetail []
    • CategoryIdentity: PwsProjectIssueCategoryRef
    • Description: String (255)
    • DueDate: DateTime
    • DueDateClearFlag: Boolean
    • EmailIssueOwnerFlag: Boolean
    • EmailPmTeamFlag: Boolean
    • IssueNumber: Int32
    • OwnerIdentity: PwsUserRef
    • Priority: String (1)
    • Resolution: String (4000)
    • ResolutionClearFlag: Boolean
    • StatusIdentity: PwsProjectIssueStatusRef
    • Timestamp: String
    • NewExternalSystemIdentifier:String
    • UserDefinedFields: PwsUdfDefinition []

Elements

Element

Data Type

Required?

Default

Description

Sample Data

ProjectIssueId

Int32

No


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


ProjectIssueUid

Int64

On Insert: No

On Update: Yes


The project issue Uid is a unique and immutable identifier for a project issue.

1152921504606992779

ReferenceId

String

No


This is a user-defined ID for project issue. It allows user to tag project issues that are submitted in a web service request, and is echoed in the web service response to allow user to correlate project issues in the response to the ones in request.

#1

AttachmentClearFlag

Boolean

No

false

If set to 'true, attachment documents are removed from the issue.

false

Attachments

PwsProjectIssueAttachmentDetail[]

No


Document(s) attached to this project issue. Click here for more information.


CategoryIdentity

PwsProjectIssueCategoryRef

On Insert: Yes

On Update: No


The category of the project issue. Click here for more information. Specify NULL on update to leave value as is.


Description

String (255)

On Insert: Yes

On Update: No


Description of the project issue. Specify NULL on update to leave value as is.

Costume design is behind schedule

DueDate

DateTime

No


Due date of the project issue. Specify NULL on update to leave value as is.

2018-02-28z

DueDateClearFlag

Boolean

No

false

If set to 'true', issue due date will be cleared.

false

EmailIssueOwnerFlag

Boolean

No

false

If set to 'true', email will be sent to issue owner when issue is saved.

false

EmailPmTeamFlag

Boolean

No

false

If set to 'true', email will be sent to project management team when issue is saved.

false

IssueNumber

Int32

No


The issue number. This is a system assigned value and if specified when updating an issue, it is ignored.

6

OwnerIdentity

PwsUserRef

On Insert: Yes

On Update: No


The owner of the project issue. Click here for more information. Specify NULL on update to leave value as is.


Priority

String (1)

On Insert: Yes

On Update: No


The priority of a project issue:

'L' for low priority

'M' for medium priority

'H' for high priority

M

Resolution

String (4000)

No


The latest comment associated with a project issue.

Issue is no longer valid.

ResolutionClearFlag

Boolean

No


If set to 'true', the latest resolution will be cleared.

false

StatusIdentity

PwsProjectIssueStatusRef

On Insert: Yes

On Update: No


The status of the project issue. The available status values are defined at the project level. Click here for more information.


Timestamp

String

No


Base64 encoded timestamp. Meaningless on an insert. Caller may optionally supply the value retrieved earlier. If the issue has been updated since it was last retrieved, the update will fail. No checking is done if no value is specified.


NewExternalSystemIdentifierStringNo
it is used in request to create or update a project issue (PwsSaveProjectIssues) to set the value of the ExternalSystemIdentifier. In response to PwsSaveProjectIssues, this data is left as null.
UserDefinedFieldsPwsUdfDefinitionNo
The UDFs that are associated with this project issue.

Usage Example(s)


Example 01
				    <a:ProjectIssue>
                     <ProjectIssueId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">28509</ProjectIssueId>
                     <ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606875485</ProjectIssueUid>
                     <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">#10</ReferenceId>
                     <a:AttachmentClearFlag>false</a:AttachmentClearFlag>
                     <a:Attachments/>
                     <a:CategoryIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId>351612</b:ProjectIssueCategoryId>
                        <b:ProjectIssueCategoryUid>1152921504606992779</b:ProjectIssueCategoryUid>
                     </a:CategoryIdentity>
                     <a:Description>new issue about the set production</a:Description>
                     <a:DueDate>2018-03-31T00:00:00Z</a:DueDate>
                     <a:DueDateClearFlag>false</a:DueDateClearFlag>
                     <a:EmailIssueOwnerFlag>false</a:EmailIssueOwnerFlag>
                     <a:EmailPmTeamFlag>false</a:EmailPmTeamFlag>
                     <a:IssueNumber>28</a:IssueNumber>
                     <a:OwnerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                        <b:UserId>217832</b:UserId>
                        <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944254</b:UserUid>
                     </a:OwnerIdentity>
                     <a:Priority>M</a:Priority>
                     <a:Resolution>testtest</a:Resolution>
                     <a:ResolutionClearFlag>false</a:ResolutionClearFlag>
                     <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueStatusId>851626</b:ProjectIssueStatusId>
                        <b:ProjectIssueStatusUid>1152921504607253230</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                     <a:Timestamp>AAAAAA+RVEI=</a:Timestamp>
                  </a:ProjectIssue>
Example 02 with UDFs
				   <a:ProjectIssue>
                     <ProjectIssueId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606877184</ProjectIssueUid>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ExternalSystemIdentifier xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Test-1212#5</ExternalSystemIdentifier>
                     <a:AttachmentClearFlag>false</a:AttachmentClearFlag>
                     <a:Attachments/>
                     <a:CategoryIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId i:nil="true"/>
                        <b:ProjectIssueCategoryUid>1152921504607339490</b:ProjectIssueCategoryUid>
                     </a:CategoryIdentity>
                     <a:Description>This is an update of existing issue</a:Description>
                     <a:DueDate>2018-10-31T00:00:00Z</a:DueDate>
                     <a:DueDateClearFlag>false</a:DueDateClearFlag>
                     <a:EmailIssueOwnerFlag>false</a:EmailIssueOwnerFlag>
                     <a:EmailPmTeamFlag>false</a:EmailPmTeamFlag>
                     <a:IssueNumber>11</a:IssueNumber>
                     <a:OwnerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944254</b:UserUid>
                     </a:OwnerIdentity>
                     <a:Priority>M</a:Priority>
                     <a:Resolution>pending</a:Resolution>
                     <a:ResolutionClearFlag>false</a:ResolutionClearFlag>
                     <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueStatusId i:nil="true"/>
                        <b:ProjectIssueStatusUid>1152921504608004811</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                     <a:Timestamp>AAAAABGC/HE=</a:Timestamp>
                     <a:NewExternalSystemIdentifier i:nil="true"/>
                     <a:UserDefinedFields xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>IUDF_DT</b:UdfName>
                           <b:UdfUid>1152921504606860448</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-12-13T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>IUDF_TxLst</b:UdfName>
                           <b:UdfUid>1152921504606860447</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>1-Rosina</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                     </a:UserDefinedFields>
                  </a:ProjectIssue>
  • No labels