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

« Previous Version 12 Next »

Overview

This web service retrieves a list of project issue, based upon a unique project identifier (PwsProjectRef) and a list of optional filters. 

Request Format

PwsGetProjectIssueList Request

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

ASA2SxZGgEWiNl525Vyqzw==

IssueOwnerIdentity

PwsUserRef

No


This is a filter that narrows down the result set and only project issues with this owner will be included.


LimitToClosedIssuesFlag

Boolean

No

false

If set to 'true', only closed issues will be included in the result set.


LimitToLateIssuesFlag

Boolean

No

false

If set to 'true', only late issues will be included in the result set.


LimitToOpenIssuesFlag

Boolean

No

false

If set to 'true', only open issues will be included in the result set.


MaxPriority

String (1)

No


This is a filter that narrows down the result set and only project issues at or below this value will be included.

'L' for low

'M' for medium

'H' for high


MinPriority

String (1)

No


This is a filter that narrows down the result set and only project issues at or above this value will be included.

'L' for low

'M' for medium

'H' for high


ProjectIdentity

PwsProjectRef

Yes


The identity of the project that we are retrieving issues from. Click here for more information.


ProjectIssueCategoryIdentity

PwsProjectIssueCategoryRef

No


This is a filter that narrows down the result set. Only project issues that matches this category will be included. Click here for more information.


ProjectIssueIdentity

PwsProjectIssueRef

No




ProjectIssueStatusIdentity

PwsProjectIssueStatusRef

No


This is a filter that narrows down the result set. Only project issues that matches this status will be included. Click here for more information.


Request Usage Example(s)

Example 01 - without project issue identity
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectIssueList>
         <pws:serviceRequest>
            <req:SessionTicket>ASA2SxZGgEWiNl525Vyqzw==</req:SessionTicket>
            <web:IssueOwnerIdentity>
               <com:UserDisplayName>Larry Krakauer</com:UserDisplayName>
            </web:IssueOwnerIdentity>
            <web:LimitToClosedIssuesFlag>false</web:LimitToClosedIssuesFlag>
            <web:LimitToLateIssuesFlag>true</web:LimitToLateIssuesFlag>
            <web:LimitToOpenIssuesFlag>true</web:LimitToOpenIssuesFlag>
            <web:MaxPriority>H</web:MaxPriority>
            <web:MinPriority>M</web:MinPriority>
            <web:ProjectIdentity>
               <com:ProjectCode>P001053-WS2</com:ProjectCode>
            </web:ProjectIdentity>
            <web:ProjectIssueCategoryIdentity>
               <com:ProjectIssueCategoryUid>1152921504606992779</com:ProjectIssueCategoryUid>
            </web:ProjectIssueCategoryIdentity>
            <web:ProjectIssueStatusIdentity>
               <com:ProjectIssueStatusUid>1152921504607253230</com:ProjectIssueStatusUid>
            </web:ProjectIssueStatusIdentity>
         </pws:serviceRequest>
      </pws:PwsGetProjectIssueList>
   </soapenv:Body>
</soapenv:Envelope>
Example 02 - with project issue identity
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectIssueList>
         <pws:serviceRequest>
            <req:SessionTicket>ASA2SxZGgEWiNl525Vyqzw==</req:SessionTicket>
            <web:ProjectIdentity>
               <com:ProjectCode>P001053-WS2</com:ProjectCode>
            </web:ProjectIdentity>
            <web:ProjectIssueIdentity>
               <com:ProjectIssueUid>1152921504606875498</com:ProjectIssueUid>
            </web:ProjectIssueIdentity>
         </pws:serviceRequest>
      </pws:PwsGetProjectIssueList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetProjectIssueList Response

Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatus

Result of this request. Click here for more information.

Ok

ServerTimestampUtc

DateTime

This is the UTC time when request completes. Click here for more information.

2018-02-06T20:34:17.3332354Z

ProjectIssues

PwsProjectIssueElement



ProjectUsers

PwsUserRef

???. Click here for more information.


CanAddDocumentsFlag

Boolean

If it is 'true', ???

true


Response Usage Example(s)

Example 01 - without project issue identity
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectIssueListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectIssueListResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-06T20:34:17.3332354Z</ServerTimestampUtc>
            <a:ProjectIssues>
               <a:PwsProjectIssueElement>
                  <a:ClosedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ClosedTimestamp i:nil="true"/>
                  <a:LastUpdatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944261</b:UserUid>
                     <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>PPSA Support User</b:FirstName>
                     <b:LastName>PPSA Support User</b:LastName>
                     <b:MiddleName>PPSA Support User</b:MiddleName>
                  </a:LastUpdatedByUser>
                  <a:LastUpdatedTimestamp>2018-02-06T20:32:57.423Z</a:LastUpdatedTimestamp>
                  <a:OpenedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId i:nil="true"/>
                     <b:UserUid>1152921504606950320</b:UserUid>
                     <b:EmailAddress>bruce@revcorp.doc</b:EmailAddress>
                     <b:FirstName>Bruce</b:FirstName>
                     <b:LastName>Wayne</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:OpenedByUser>
                  <a:OpenedTimestamp>2018-02-05T20:22:21.79Z</a:OpenedTimestamp>
                  <a:ProjectIssue>
                     <ProjectIssueId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606875457</ProjectIssueUid>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:AttachmentClearFlag>false</a:AttachmentClearFlag>
                     <a:Attachments>
                        <a:PwsProjectIssueAttachmentDetail>
                           <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607634579</DocumentRefUid>
                        </a:PwsProjectIssueAttachmentDetail>
                     </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>Do Not Delete</a:Description>
                     <a:DueDate>2018-01-31T00:00:00Z</a:DueDate>
                     <a:DueDateClearFlag>false</a:DueDateClearFlag>
                     <a:EmailIssueOwnerFlag>false</a:EmailIssueOwnerFlag>
                     <a:EmailPmTeamFlag>false</a:EmailPmTeamFlag>
                     <a:IssueNumber>5</a:IssueNumber>
                     <a:OwnerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Larry Krakauer</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>851626</b:ProjectIssueStatusId>
                        <b:ProjectIssueStatusUid>1152921504607253230</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                     <a:Timestamp>AAAAAA+RpAg=</a:Timestamp>
                  </a:ProjectIssue>
                  <a:ProjectIssueFolderIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:FolderId i:nil="true"/>
                     <b:FolderUid>1152921504607335265</b:FolderUid>
                  </a:ProjectIssueFolderIdentity>
                  <a:IssueClosedFlag>false</a:IssueClosedFlag>
                  <a:IssueLateFlag>true</a:IssueLateFlag>
                  <a:IssueOwnerFlag>false</a:IssueOwnerFlag>
               </a:PwsProjectIssueElement>
            </a:ProjectIssues>
            <a:ProjectUsers xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsUserRef>
                  <b:UserDisplayName>Allison Moore</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>016</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944228</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Barry Allen</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>barry1</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607004852</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId i:nil="true"/>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944254</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Ronni Skerker</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>030</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944264</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Steve Chong</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>095</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944267</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>T_Lili James_US</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>020</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944255</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Tony Bailey</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>024</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944269</b:UserUid>
               </b:PwsUserRef>
            </a:ProjectUsers>
            <a:CanAddDocumentsFlag>true</a:CanAddDocumentsFlag>
         </PwsGetProjectIssueListResult>
      </PwsGetProjectIssueListResponse>
   </s:Body>
</s:Envelope>
Example 02 - with project issue identity
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectIssueListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectIssueListResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-07T19:25:54.5466383Z</ServerTimestampUtc>
            <a:ProjectIssues>
               <a:PwsProjectIssueElement>
                  <a:ClosedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944261</b:UserUid>
                     <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>PPSA Support User</b:FirstName>
                     <b:LastName>PPSA Support User</b:LastName>
                     <b:MiddleName>PPSA Support User</b:MiddleName>
                  </a:ClosedByUser>
                  <a:ClosedTimestamp>2018-02-07T16:41:09.057Z</a:ClosedTimestamp>
                  <a:LastUpdatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944261</b:UserUid>
                     <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>PPSA Support User</b:FirstName>
                     <b:LastName>PPSA Support User</b:LastName>
                     <b:MiddleName>PPSA Support User</b:MiddleName>
                  </a:LastUpdatedByUser>
                  <a:LastUpdatedTimestamp>2018-02-07T16:41:09.057Z</a:LastUpdatedTimestamp>
                  <a:OpenedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId i:nil="true"/>
                     <b:UserUid>1152921504606950320</b:UserUid>
                     <b:EmailAddress>bruce@revcorp.doc</b:EmailAddress>
                     <b:FirstName>Bruce</b:FirstName>
                     <b:LastName>Wayne</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:OpenedByUser>
                  <a:OpenedTimestamp>2018-02-06T20:31:39.163Z</a:OpenedTimestamp>
                  <a:ProjectIssue>
                     <ProjectIssueId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606875498</ProjectIssueUid>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <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>This is an update of existing issue</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>30</a:IssueNumber>
                     <a:OwnerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Larry Krakauer</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>851625</b:ProjectIssueStatusId>
                        <b:ProjectIssueStatusUid>1152921504607253232</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                     <a:Timestamp>AAAAAA+SmWY=</a:Timestamp>
                  </a:ProjectIssue>
                  <a:ProjectIssueFolderIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:IssueClosedFlag>true</a:IssueClosedFlag>
                  <a:IssueLateFlag>false</a:IssueLateFlag>
                  <a:IssueOwnerFlag>false</a:IssueOwnerFlag>
               </a:PwsProjectIssueElement>
            </a:ProjectIssues>
            <a:ProjectUsers xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsUserRef>
                  <b:UserDisplayName>Allison Moore</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>016</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944228</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Barry Allen</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>barry1</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607004852</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId i:nil="true"/>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944254</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Ronni Skerker</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>030</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944264</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Steve Chong</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>095</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944267</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>T_Lili James_US</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>020</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944255</b:UserUid>
               </b:PwsUserRef>
               <b:PwsUserRef>
                  <b:UserDisplayName>Tony Bailey</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>024</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944269</b:UserUid>
               </b:PwsUserRef>
            </a:ProjectUsers>
            <a:CanAddDocumentsFlag>true</a:CanAddDocumentsFlag>
         </PwsGetProjectIssueListResult>
      </PwsGetProjectIssueListResponse>
   </s:Body>
</s:Envelope>

PwsGetProject - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

23001ProjectIdentityRequiredForGetIssueListA project identity must be specified.
84007WorkspaceProjectIssueNotFoundProject issue not found.
84011ProjectIssueCategoryNotFoundProject issue category not found.
84014ProjectIssueStatusNotFoundProject issue status not found.
  • No labels