Use this call to tag the active development configuration with a designated model revision.
For best performance and outcomes, make all API calls to your closest regional server. To learn more about this, read URL, IP, and allowlist requirements.
Note: You must be a Workspace Administrator for both the target and source model workspaces. Additionally, ensure you have access privileges to both models.
Ensure there is at least one uncommitted structural change applied within the model. Ensure the model is running in standard mode.
Make sure you have at least one uncommitted structural change in your model. Confirm your model is in Standard mode.
Method and endpoint
/models/{modelId}/alm/revisions
Parameters
| Parameter | Location | Required | Description |
modelId | Path | Yes | The ID of the model hosting the target revision. |
Curl example
curl -X POST 'https://api.anaplan.com/2/0/models/{modelId}/alm/revisions' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"name": "<new_revision_title>",
"description": "<new_revision_desc>"
}'
Response
Success response
A successful request returns a 201 Created HTTP status code with a response body.
Response body
{
"meta": {
"schema": "https://api.anaplan.com/2/0/objects/revision"
},
"status": {
"code": 201,
"message": "Created"
},
"revision": {
"id": "397FAEF09D8146CF8B537874D3D515D4",
"name": "Revision-123",
"description": "A revision capturing some structural changes to my model",
"createdOn": "2021-02-01T17:19:29Z",
"createdBy": "2c9ba1a8716147830171970589222302",
"creationMethod": "User added revision via API",
"appliedOn": "2021-02-01T17:19:29Z",
"appliedBy": "2c9ba1a8716147830171970589222302"
}
}
Review the ALM API troubleshooting guide to resolve any error responses from API calls.