Plan a base entity definition update and return schema-impacting warnings.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/base/schema-change-plan"), Content = new StringContent("{ \"Name\": \"example\", \"DisplayNameSingular\": \"example\", \"DisplayNamePlural\": \"example\", \"Description\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"IsReadOnly\": true, \"DisabledOperations\": 0, \"SchemaChangeConfirmationToken\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/entity-definitions/example/base/schema-change-plan';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Name":"example","DisplayNameSingular":"example","DisplayNamePlural":"example","Description":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","IsReadOnly":true,"DisabledOperations":0,"SchemaChangeConfirmationToken":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/entity-definitions/example/base/schema-change-plan \ --header 'Content-Type: application/json' \ --data '{ "Name": "example", "DisplayNameSingular": "example", "DisplayNamePlural": "example", "Description": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "IsReadOnly": true, "DisabledOperations": 0, "SchemaChangeConfirmationToken": "example" }'Call this with the intended update payload first; when the plan requires confirmation, repeat the update with the returned confirmation token.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload to update base entity definition settings.
object
Internal entity name.
User-facing singular name.
User-facing plural name.
Optional entity description.
Expected row version.
Whether runtime writes should be blocked for this entity. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Request payload to update base entity definition settings.
object
Internal entity name.
User-facing singular name.
User-facing plural name.
Optional entity description.
Expected row version.
Whether runtime writes should be blocked for this entity. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Request payload to update base entity definition settings.
object
Internal entity name.
User-facing singular name.
User-facing plural name.
Optional entity description.
Expected row version.
Whether runtime writes should be blocked for this entity. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Responses
Section titled “Responses”OK
object
Schema change awareness result for a planned entity schema mutation.
object
Warnings produced by the planned schema mutation.
object
object
Whether the mutation must be explicitly confirmed before it can be applied.
Stateless confirmation token accepted by the matching apply endpoint.
object
object
object
object
Example
{ "Data": { "Warnings": [ { "Type": 0, "Severity": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Schema change awareness result for a planned entity schema mutation.
object
Warnings produced by the planned schema mutation.
object
object
Whether the mutation must be explicitly confirmed before it can be applied.
Stateless confirmation token accepted by the matching apply endpoint.
object
object
object
object
Example
{ "Data": { "Warnings": [ { "Type": 0, "Severity": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Schema change awareness result for a planned entity schema mutation.
object
Warnings produced by the planned schema mutation.
object
object
Whether the mutation must be explicitly confirmed before it can be applied.
Stateless confirmation token accepted by the matching apply endpoint.
object
object
object
object
Example
{ "Data": { "Warnings": [ { "Type": 0, "Severity": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}