Manage Change Request

Gets and update change requests.

get
/api/v2/tenants/{tenantId}/changeRequests/{changeRequestId}

Gets the details of a change request.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId of the tenant

  • changeRequestIdstringrequired

    Unique Identifier (UUID) of change request

00
post
/api/v2/tenants/{tenantId}/changeRequests/{changeRequestId}

Updates a change request.

Notes:

  • Follow the steps while updating status
    1. Check the Status Flows in Service Desk
    2. Check the Status change reasons enabled or not for particular status of the module (ChangeRequest) in Service Desk Settings
    3. reasons must be configured in Status Change Reasons of Service Desk.
  • Examples for different statuses
    1. Open { "status":"Open","reason":"reason configured to Open","notes":"Re-Open note (Required Resolved to Open)" }
    2. Pending { "status":"Pending","reason":"reason configured to Pending" }
    3. Resolved { "status":"Resolved","reason":"reason configured to Resolve","notes":"summary for resolving" }
    4. Closed { "status":"Closed","reason":"reason configured to Close" }
    5. On Hold { "status":"On Hold","reason":"reason configured for On Hold","suspendEndDate":"2016-02-20T01:00:00+0000" }
  • In the request parameters category and subCategory will take both id and uniqueId but any one is mandatory.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId of the tenant

  • changeRequestIdstringrequired

    Unique Identifier (UUID) of change request

00
00