Plan a field metadata 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-fields/example/schema-change-plan"), Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"VisibleWhen\": \"example\", \"RequiredWhen\": \"example\", \"EditableWhen\": \"example\", \"DecimalPrecision\": 1, \"DecimalScale\": 1, \"StringMaxLength\": 1, \"AllowMultiple\": true, \"ReferenceToEntityDefinitionId\": \"example\", \"PairedReferenceFieldId\": \"example\", \"AllowSort\": true, \"ReferenceDeleteBehavior\": 0, \"Options\": [ { \"Key\": \"example\", \"Value\": \"example\" } ], \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"AddressCoordinatesRequired\": true, \"IsReadOnly\": true, \"SchemaChangeConfirmationToken\": \"example\", \"VisibleWhenOperationMode\": 0, \"RequiredWhenOperationMode\": 0, \"EditableWhenOperationMode\": 0, \"BaseCurrencyCode\": \"example\", \"ReferenceArchiveBehavior\": 0, \"ReferenceAuditRollupBehavior\": 0, \"SemanticRole\": 0, \"SemanticRoleScopeFieldId\": \"example\", \"ClassifierCatalogDefinitionId\": \"example\", \"DefaultValue\": { \"Kind\": 0, \"Value\": {} } }") { 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-fields/example/schema-change-plan';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Key":"example","DisplayName":"example","VisibleWhen":"example","RequiredWhen":"example","EditableWhen":"example","DecimalPrecision":1,"DecimalScale":1,"StringMaxLength":1,"AllowMultiple":true,"ReferenceToEntityDefinitionId":"example","PairedReferenceFieldId":"example","AllowSort":true,"ReferenceDeleteBehavior":0,"Options":[{"Key":"example","Value":"example"}],"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","AddressCoordinatesRequired":true,"IsReadOnly":true,"SchemaChangeConfirmationToken":"example","VisibleWhenOperationMode":0,"RequiredWhenOperationMode":0,"EditableWhenOperationMode":0,"BaseCurrencyCode":"example","ReferenceArchiveBehavior":0,"ReferenceAuditRollupBehavior":0,"SemanticRole":0,"SemanticRoleScopeFieldId":"example","ClassifierCatalogDefinitionId":"example","DefaultValue":{"Kind":0,"Value":{}}}'};
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-fields/example/schema-change-plan \ --header 'Content-Type: application/json' \ --data '{ "Key": "example", "DisplayName": "example", "VisibleWhen": "example", "RequiredWhen": "example", "EditableWhen": "example", "DecimalPrecision": 1, "DecimalScale": 1, "StringMaxLength": 1, "AllowMultiple": true, "ReferenceToEntityDefinitionId": "example", "PairedReferenceFieldId": "example", "AllowSort": true, "ReferenceDeleteBehavior": 0, "Options": [ { "Key": "example", "Value": "example" } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "AddressCoordinatesRequired": true, "IsReadOnly": true, "SchemaChangeConfirmationToken": "example", "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "BaseCurrencyCode": "example", "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "SemanticRoleScopeFieldId": "example", "ClassifierCatalogDefinitionId": "example", "DefaultValue": { "Kind": 0, "Value": {} } }'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 field metadata without changing the type.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Expected row version.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
Request payload to update field metadata without changing the type.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Expected row version.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
Request payload to update field metadata without changing the type.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Expected row version.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field. Null preserves the current value.
Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
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 } ]}