REST Service API examples

The following are examples of API change requests between the WCM and a change management system:

EXAMPLE 1: In this implementation, WCM sends validateChangeState to the change management system to create or update a ticket:

1. WCM sends this validateChangeState request:

   POST validateChangeState

   ctmRequestID=”Workspace22”

   name=”please review my workspace”

   newState=”Submitted”

   creationTime=” 20211027123500”

   endUser=”James”

2. The change management system sends one of the following:
   • After recording the change request:

     200 HTTP code

     changeID=”request222”

   • If the change management system rejects the change request, it returns the following:

     400 HTTP code

     changeID=”request222”

EXAMPLE 2: In this implementation, WCM sends validateChangeState to the change management system before creating or updating the change state, and stateChanged afterwards:

1. WCM sends this validateChangeState request:

   POST validateChangeState

   ctmRequestID=”Workspace22”

   name=”please review my workspace”

   newState=”Submitted”

   creationTime=” 20211027123500”

   endUser=”James”

2. The change management system identifies the change request, and returns the following:

   200 HTTP code

   changeID=”request222”

3. WCM sends this stateChanged request:

   POST stateChanged

   changeID=”request222”

   ctmRequestID=”Workspace22”

   name=”please review my workspace”

   newState=”Submitted”

   creationTime=” 20211027123500”

   endUser=”James”

4. The change management system records the change request, and returns the following:

   200 HTTP code

   changeID=”request222”

EXAMPLE 3: The Web user wants to check the status in the change management system of one of his tickets:

1. The change management system sends this getChangeStatus request:

   POST getChangeStatus

   changeID=”request222”

   ctmRequestID=”Workspace22”

   name=”please review my workspace”

   newState=”Submitted”

   oldState=”Rejected”

   creationTime=” 20211027123500”

   endUser=”James”

   scheduler=”Frank”

2. The change management system records the change request, and returns the following:

   200 HTTP code

   changeID=”request222”

   message=”The change is approved”