Change Requests API
A change request is a change asked for after the record was agreed: a new requirement, a clarification, a defect in the baseline, a regulatory demand, a client's wish, a piece of technical debt or a scope reduction.
A change request is a change asked for after the record was agreed: a new requirement, a clarification, a defect in the baseline, a regulatory demand, a client's wish, a piece of technical debt or a scope reduction. It numbers on its own sequence (CRM-CR-2), names who asked, the baseline it changes and, as links from the request, the records it touches. An analyst writes the impact on scope, schedule, effort, cost and risk, or asks Heimdall for a draft, and the approvers read the level first. Its approval is the one door through which a frozen baseline's items are unlocked; a rejection keeps the approver's words as the request's decision note.
Every save of a change request writes a version; the versions are read and put back through the endpoints below, under the change requests' own abilities.
A staff token sees the change requests of the projects it may see. A client guest's token raises requests and sees the ones they raised or asked for through their stakeholder seat, without the effort, the cost and Heimdall's draft, which are the team's working numbers until the approvers decide; any other request it asks for is a 404 RESOURCE_NOT_FOUND. Every write runs the same action the Change Requests page runs, under the project permissions, and announces itself as a change_request.* event. Putting a request to its approvers is on the approvals endpoint.
Endpoints
/v1/change-requests/{changeRequest}Get a change requestPATCH/v1/change-requests/{changeRequest}Update a change requestDELETE/v1/change-requests/{changeRequest}Delete a change requestGET/v1/change-requests/{changeRequest}/revisionsList a change request's versionsGET/v1/change-requests/{changeRequest}/revisions/{revision}Get a version of a change requestGET/v1/projects/{project}/change-requestsList change requestsPOST/v1/projects/{project}/change-requestsRaise a change requestPOST/v1/change-requests/{changeRequest}/statusMove a change requestPOST/v1/change-requests/{changeRequest}/verifyVerify a change requestPOST/v1/change-requests/{changeRequest}/analyseAnalyse a change request's impactPOST/v1/change-requests/{changeRequest}/revisions/{revision}/restoreRestore a version of a change requestRelated
How is this guide?
Last updated on