Logo
MicroStrategy REST API API Documentation

Read lock status of the schema

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

The response returns the lock status of the schema.

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

In the response, the lockType can be:
* absolute_individual: Place using the POST schema lock API. 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: 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.

 

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




RESPONSES

status





Curl
curl -X GET 'baseUrl/api/model/schema/lock' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS