Overview
This web service retrieves a list of the configured project issue , based upon a unique project identifier statuses for a specified (PwsProjectRef) and a list of optional filters. The list can further be filter to include or exclude inactive statuses based on the IncludeInactiveFlag filter.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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. | ARNkL4C1bp7KLtsSXQW6/g== | |
IncludeInactiveFlag | Boolean | No | false | If set to 'true', both inactive and active issue statuses are included in the response. | false |
ProjectIdentity | Yes | The project for which to retrieve the list of configured issue statuses. Click here for more information. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsGetProjectIssueStatuses> <pws:serviceRequest> <req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket> <web:IncludeInactiveFlag>true</web:IncludeInactiveFlag> <web:ProjectIdentity> <com:ProjectCode>P001053-001</com:ProjectCode> </web:ProjectIdentity> </pws:serviceRequest> </pws:PwsGetProjectIssueStatuses> </soapenv:Body> </soapenv:Envelope> |
Response Format
| Panelcode | ||
|---|---|---|
| ||
| ||
| title | Example 02 - with project issue identity | |
| collapse | true | |
</soapenv:Envelope>
|
Response Format
Response Elements
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-07T14:44:11.9219745Z |
IssueStatuses | This structure contains the complete set of information about each configured issue status for the specified project. Click here for more information. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetProjectIssueStatusesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetProjectIssueStatusesResult 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-03-07T14:44:11.9219745Z</ServerTimestampUtc> <a:IssueStatuses> <a:PwsProjectIssueStatus> <ProjectIssueStatusId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1119752</ProjectIssueStatusId> <ProjectIssueStatusUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607966728</ProjectIssueStatusUid> <a:InactiveFlag>false</a:InactiveFlag> <a:Name>New</a:Name> <a:SortOrder>1</a:SortOrder> <a:TreatAsClosedFlag>false</a:TreatAsClosedFlag> </s:Envelope> | ||||||
| Code Block | ||||||
| ||||||
a:PwsProjectIssueStatus> <a:PwsProjectIssueStatus> <ProjectIssueStatusId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1119750</ProjectIssueStatusId> <ProjectIssueStatusUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607966726</ProjectIssueStatusUid> <a:InactiveFlag>false</a:InactiveFlag> <a:Name>Assigned</a:Name> <a:SortOrder>2</a:SortOrder> <a:TreatAsClosedFlag>false</a:TreatAsClosedFlag> </a:PwsProjectIssueStatus> <a:PwsProjectIssueStatus> <ProjectIssueStatusId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1119751</ProjectIssueStatusId> <ProjectIssueStatusUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607966727</ProjectIssueStatusUid> <a:InactiveFlag>false</a:InactiveFlag> <a:Name>Closed</a:Name> <a:SortOrder>3</a:SortOrder> <a:TreatAsClosedFlag>true</a:TreatAsClosedFlag> </a:PwsProjectIssueStatus> </a:IssueStatuses> </PwsGetProjectIssueStatusesResult> </PwsGetProjectIssueStatusesResponse> </s:Body> </s:Envelope> |
...
PwsGetProjectIssueStatuses - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 54282 | ProjectNotFound | Specified project does not exist. |