deleteRequests
Purpose
This operation deletes one or more requests in PPM Center.
Function
This operation is to delete one or more requests in PPM Center.
Limitations
No security check on this operation. The specified request(s) will be deleted by this Web service operation even if the user does not have permissions to delete the request.
Related Information
The following data type:
Input
A collection of request IDs.
Return
Return number of requests deleted.
Java Interface
DeleteRequestsResponseDocument
deleteRequests(DeleteRequestsDocument in)
Parameters |
Description |
---|---|
DeleteRequestsDocument |
Wrapper of a list of request ID, or Identifier[]. |
DeleteRequestsResponseDocument |
Wrapper of the return code of this operation. |
Java Examples
Example: update a remote reference of an existing request.
public class ExampleDeleteRequests { . . . private void deleteRequests(String serviceURL, String[] requestIds) throws Exception { // construct the Identifier array Identifier[] ids = new Identifier[requestIds.length]; for (int i = 0; i < requestIds.length; i++) { ids[i] = Identifier.Factory.newInstance(); ids[i].setId(requestIds[i]); }
// get Webservice handle DemandServiceStub stub = new DemandServiceStub(ctx, serviceURL); // Construct message to send DeleteRequestsDocument inDoc = DeleteRequestsDocument.Factory.newInstance(); DeleteRequestsDocument.DeleteRequests deletes = inDoc.addNewDeleteRequests(); deletes.setRequestIdsArray(ids); . . . } }
Errors and Exceptions
Message Code |
Message |
Cause(s) |
Possible Corrective Action |
---|---|---|---|
KNTA-11186 |
Internal error has occurred while calling PPM Web Service. Contact PPM support with the detail information if the problem persists. (KNTA-11186) Details: Non digit data was set for number field. Original exception message: For input string: "30364A". |
The request ID is invalid (includes non-numeric data). |
Provide a valid request ID. |
KNTA-11186 |
Internal error has occurred while calling PPM Web Service. Contact PPM support with the detail information if the problem persists. (KNTA-11186) Details: Non digit data was set for number field. Original exception message: For input string: "" |
The request ID is null. |
Provide a valid request ID. |
N/A |
Delete Requests Succeeded. Return Code: 0 |
The request ID is not found in the system. |
Provide an existing request ID. |