REST APIs Called in the Integration

The following Demand Management REST APIs are called in this integration to convert data from UCMDB into Micro Focus APM compatible data:

  • Get a request

    For more information, see Get Details of a Request section of the RESTful Web Services Guide for Micro Focus PPM 9.20.

  • Create a request

    For more information, see Create/Update a Request section of the RESTful Web Services Guide for Micro Focus PPM 9.20.

  • Update a request

    For more information, see Create/Update a Request section of the RESTful Web Services Guide Micro Focus PPM 9.20.

  • Delete a request

    Added in version 9.22. For more information, see Delete a Request.

Delete a Request

Request: http://<PPM_Server_IP>:<port>/itg/rest/dm/requests/{reqId}

HTTP Method: DELETE

Description: Delete a request with a specific ID. To perform this operation, you must be in one or more of the authorized security groups for the create/update action.

Request path variables:

Attribute

Description

Required?

reqId

Request ID. Indicates which request will be deleted.

Yes

Response entity body:

  • on success: When the operation is successfully executed, no message is returned. However, the REST API automatically calls the GET operation and returns the following message in Response Header (with empty message body):

    Status Code: 204 No Content
    Cache-Control: no-cache
    Date: Mon, 26 Aug 2013 09:20:29 GMT
    Expires: -1
    Pragma: no-cache
  • on failure: The following message codes are returned if the operation fails:

    Message Code

    Message

    Cause

    Possible Corrective Action

    PPMC_WSE108

    Not Found

    The quest is not found.

    The request ID is not passed or the request of this ID doesn’t exist.

    PPMC_WSE001

    Internal Server Error

    There was an error when you tried to delete a request.

    N/A

    PPMC_WSE116

    Internal Server Error

    There was an error when you tried to delete a request.

    N/A

Limitation:

This operation supports field security check, but it ignores user interface (UI) rules or status dependency. Such constraints have to be validated and enforced on the client side before this operation is invoked.