Logo
MicroStrategy REST API API Documentation

Lock the schema

POST {{baseUrl}}/api/model/schema/lock

Places a lock on the schema.

In the request body, lockType must be provided. * absolute_individual: When placed, no one, including the administrator, can perform changes on the schema objects. The purpose of this lock is to prevent accidental modifications to the schema in a project. * exclusive_constituent: Not used by this API. When the changeset is created with schemaEdit = true, an exclusive_constituent lock is placed on the schema. It is a lock exclusive to the changeset holding the lock; only that changeset can change the schema or its constituents (tables, attributes, etc.). * "absolute_constituent: Not in use.

A project ID and authorization token are required to execute the request. An authorization token can be obtained using Authentication endpoints.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization Token
X-MSTR-ProjectID
string (Required) Project ID
Content-Type
string




RESPONSES

status





Curl
curl -X POST 'baseUrl/api/model/schema/lock' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"lockType":"absolute_constituent"}'

ENDPOINTS