This endpoint enables a workspace administrator to close a model without having to wait for a time-out. This is particularly useful for root cause analysis when an error occurs.
This supports administrative control and troubleshooting, especially when a model needs to be closed for root cause analysis or maintenance.
To use this endpoint, you must supply a valid authentication and the model id.
Method and endpoint
POST
/workspaces/{workspaceId}/models/{modelId}/close
Parameters
| Parameter | Description |
workspaceId |
|
modelId |
|
Curl example
curl -X POST \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/close \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
-H 'Content-Type: application/json'
Response
Response 200
A successful close action will provide a 200 OK response.
Response 204
A successful close action will provide a 200 No content response.
Response 401
An unsuccessful close action will provide a 401 Unauthorized response if a valid authentication token was not provided.
Response 403
An unsuccessful close action will provide a 403 Forbidden response if your user authentication lacks workspace administrator permissions.
Response 404
An unsuccessful close action will provide a 404 Not found response if the {modelId} or {workspaceId} is not found.
Response 422
An unsuccessful close action will provide a 422 Unprocessable identity response if the model is currently in a state that cannot process the action, for example, if the model is archived.
