Overview
This web service inserts, updates or deletes one or more project issues. Project issues to be inserted or updated are passed in SaveProjectIssues (PwsProjectIssueDetail). Issues to be deleted are passed in DeleteProjectissues (PwsProjectIssueRef). One or more of the project issues specified to this request may fail without preventing the remaining issues from being saved or deleted. The response will include ProjectIssueResults (PwsSaveProjectIssueResult) which will provide details about each specified issue, including the full details of the saved issue (PwsProjectIssueDetail), whether the issue was successfully saved or deleted, and if not, the specific reason for the failure.
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. |
|
DeleteProjectIssues | PwsProjectIssueRef[] | No |
| This is the identity of the project issue to be deleted. Click here for more information. |
|
ProjectIdentity | PwsProjectRef | Yes |
| This is the identity of the project. Click here for more information. |
|
SaveProjectIssues | PwsProjectIssueDetail[] | No |
| The detailed project issue information to be inserted or updated. Click here for more information. |
|
OverrideDocumentLockFlag | Boolean | No |
| If set to 'true', then request can update the attachment on the issue even if it is checked out/locked. If set to 'false', the save will fail if the attachment on the issue is checked out/locked. |
|
Request Usage Example(s)
<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:PwsSaveProjectIssues>
<pws:serviceRequest>
<req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
<web:ProjectIdentity>
<com:ProjectCode>P001125-001</com:ProjectCode>
</web:ProjectIdentity>
<web:SaveProjectIssues>
<web:PwsProjectIssueDetail>
<com:ReferenceId>#1</com:ReferenceId>
<!--com:ProjectIssueid>28481</com:ProjectIssueid-->
<!--web:AttachmentClearFlag>true</web:AttachmentClearFlag-->
<web:Attachments>
</web:Attachments>
<web:CategoryIdentity>
<com:ProjectIssueCategoryUid>1152921504607339490</com:ProjectIssueCategoryUid>
</web:CategoryIdentity>
<web:Description>This is an update of existing issue</web:Description>
<web:DueDate>2018-10-31z</web:DueDate>
<web:DueDateClearFlag>false</web:DueDateClearFlag>
<web:EmailIssueOwnerFlag>false</web:EmailIssueOwnerFlag>
<web:EmailPmTeamFlag>false</web:EmailPmTeamFlag>
<web:IssueNumber>10</web:IssueNumber>
<web:OwnerIdentity>
<com:UserDisplayName>krakauer, larry</com:UserDisplayName>
</web:OwnerIdentity>
<web:Priority>M</web:Priority>
<web:Resolution>pending</web:Resolution>
<web:ResolutionClearFlag>false</web:ResolutionClearFlag>
<web:StatusIdentity>
<com:ProjectIssueStatusUid>1152921504608004811</com:ProjectIssueStatusUid>
</web:StatusIdentity>
</web:PwsProjectIssueDetail>
</web:SaveProjectIssues>
</pws:serviceRequest>
</pws:PwsSaveProjectIssues>
</soapenv:Body>
</soapenv:Envelope>
<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:PwsSaveProjectIssues>
<pws:serviceRequest>
<req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
<web:DeleteProjectIssues>
<com:PwsProjectIssueRef>
<com:ProjectIssueUid>1152921504606877025</com:ProjectIssueUid>
</com:PwsProjectIssueRef>
</web:DeleteProjectIssues>
<web:ProjectIdentity>
<com:ProjectCode>P001125-001</com:ProjectCode>
</web:ProjectIdentity>
<web:SaveProjectIssues>
</web:SaveProjectIssues>
</pws:serviceRequest>
</pws:PwsSaveProjectIssues>
</soapenv:Body>
</soapenv:Envelope>
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 | Click here for more information. |
|
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-06T14:14:21.9169814Z |
ProjectIssueResults | PwsSaveProjectIssueResult[] | This structure is part of a response of web service PwsSaveProjectIssues. Click here for more information. |
|
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveProjectIssuesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveProjectIssuesResult 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-11-12T20:26:44.0483182Z</ServerTimestampUtc>
<a:ProjectIssueResults>
<a:PwsSaveProjectIssueResult>
<a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:ProjectIssue>
<ProjectIssueId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606877025</ProjectIssueUid>
<ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">#1</ReferenceId>
<ExternalSystemIdentifier 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 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>2</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>AAAAABFDKdg=</a:Timestamp>
<a:NewExternalSystemIdentifier i:nil="true"/>
<a:UserDefinedFields xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</a:ProjectIssue>
<a:ReferenceId>#1</a:ReferenceId>
</a:PwsSaveProjectIssueResult>
</a:ProjectIssueResults>
</PwsSaveProjectIssuesResult>
</PwsSaveProjectIssuesResponse>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveProjectIssuesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveProjectIssuesResult 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-11-12T20:32:01.0306358Z</ServerTimestampUtc>
<a:ProjectIssueResults/>
</PwsSaveProjectIssuesResult>
</PwsSaveProjectIssuesResponse>
</s:Body>
</s:Envelope>
PwsSaveProject - Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|
57550 | UserNotSpecified | User is required. (*owner identity is missing) |
84007 | WorkspaceProjectIssueNotFound | Project issue not found. |
84009 | ProjectIssueCategoryRefInvalid | ProjectIssueCategoryRef is required. |
84011 | ProjectIssueCategoryNotFound | Project issue category not found. |
84012 | ProjectIssueStatusRefInvalid | ProjectIssueStatusRef is required. |
84014 | ProjectIssueStatusNotFound | Project issue status not found. |
84015 | InvalidValueForIssuePriority | Invalid priority value. |
84017 | PriorityRequiredForSaveProjectIssue | Priority is required. |
84018 | DescriptionRequiredForSaveProjectIssue | Description is required. |
84019 | SpecifiedIssueDoesNotBelongToSpecifiedProject | Project mismatch. |
84057 | IssueExternalSystemIdentifierAlreadyInUse | The specified project issue external system identifier is already in use. External system identifiers must be globally unique. |