Workload Change Manager API endpoints

The following table describes the API endpoints that the change management system receives from Control-M Workload Change Manager (WCM):

URL	Response
POST validateChangeState	Responds with one of the following: Automatic Ticket Creation: If the call does not include the changeID, then the change management system creates the ticket and returns a 200 code, the new changeID, and a message back to the WCM. Manual Ticket Creation: If the call includes the changeID but does not include oldstate or newstate, then the change management system returns a 200 code, the new changeID, and a message to the WCM. Change of State: If the call includes the oldState and newState parameters, then the change management system changes the state and returns 200 code, the changeID, and a message to the WCM.
POST stateChanged	Confirms the state of the ticket.
POST getChangeStatus	Returns the state of the ticket with a 200 code, the changeID, and a message, when the Change Management Status option is enabled, as described in Control-M Workload Change Manager system parameters.

URL

Response

POST validateChangeState

Responds with one of the following:

Automatic Ticket Creation: If the call does not include the changeID, then the change management system creates the ticket and returns a 200 code, the new changeID, and a message back to the WCM.
Manual Ticket Creation: If the call includes the changeID but does not include oldstate or newstate, then the change management system returns a 200 code, the new changeID, and a message to the WCM.
Change of State: If the call includes the oldState and newState parameters, then the change management system changes the state and returns 200 code, the changeID, and a message to the WCM.

POST stateChanged

Confirms the state of the ticket.

POST getChangeStatus

Returns the state of the ticket with a 200 code, the changeID, and a message, when the Change Management Status option is enabled, as described in Control-M Workload Change Manager system parameters.

The following table describes the parameters of the API endpoints:

Parameter	Description
changeID	Specifies the ticket ID of the change management system. If a request does not contain a ChangeID, the workload change manager retrieves one and assigns it to the request.
ctmRequestID	Specifies the ID of the Workspace that the Web user submits.
Name	Specifies the name that the Web user gives the request.
newState	Specifies the new status of the request.
OldState	Specifies the old status of the request.
creationTime	Specifies the creation time of the request. UTC time in the following format: YYYYMMDDhhmmssUTC
lastTransferSideTimestamp	Determines the last transfer side timestamp. UTC time in the following format: YYYYMMDDhhmmssUTC
endUser	Specifies the Web user that submitted the request.
scheduler	Specifies the scheduler of the Request.

The following table describes the parameters of the response from the change management system:

Parameter	Description
message	Defines the returned message that is displayed to the Web user or scheduler.
changeID	Determines the ticket ID of the change management system.