Create a new changeset for modeling manipulations
POST {{baseUrl}}/api/model/changesets
Creates a new changeset.
This request will return a changeset ID, which will be used in subsequent requests to read, create, and/or update objects through the modeling APIs (i.e. filters, facts, attributes, etc.).
A changeset maintains an indivisible group of creations or modifications on modeling objects.
Eventually the changes in the changeset should be either committed as one transaction, or abandoned altogether. Set A project ID and authorization token are required to execute the request. An authorization token can be obtained using Authentication endpoints.schemaEdit
to true if this changeset ID is used to create or update schema objects through their corresponding APIs (tables, facts, attributes, hierarchies, transformations, partitions, functions). It places an exclusive_constituent
lock on the schema.
Body
PARAM
| Key | Datatype | Required | Description |
schemaEdit
|
boolean | Specify whether the changeset includes the creation or update of schema objects. Set "schemaEdit" to `true` if this changeset ID is used to create or update schema objects through their corresponding APIs (tables, facts, attributes, hierarchies, transformations, partitions, functions). It places an "exclusive_constituent" lock on the schema. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status Created
| {
"id": "168A02052B8E449F816A7611B613A902",
"type": "metadata",
"dateCreated": "2022-03-03T19:47:42.331380Z",
"dateModified": "2022-03-03T19:47:42.331428Z",
"status": "Ready",
"schemaEdit": false,
"mstrProjectId": "B7CA92F04B9FAE8D941C3E9B7E0CD754",
"mstrUserId": "7FC05A65473CE2FD845CE6A1D3F13233",
"userDateNumberLocale": "en-US",
"userMetadataLocale": "en-US",
"userWarehouseLocale": "en-US",
"userName": "MSTR User"
} |
ENDPOINTS