Apply an approved import plan.
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/import/apply"), Content = new StringContent("{ \"Yaml\": \"example\", \"TargetEntityDefinitionId\": \"example\", \"Refinements\": [ { \"FieldId\": \"example\", \"ResolvedEntityDefinitionId\": \"example\" } ], \"ConflictResolutions\": [ { \"ItemId\": \"example\", \"Action\": 0 } ], \"ApplyHeader\": true, \"SelectedItemIds\": [ \"example\" ], \"Security\": { \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"UserSlotMappings\": { \"additionalProperty\": \"example\" }, \"PlanToken\": \"example\", \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } }") { 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/import/apply';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Yaml":"example","TargetEntityDefinitionId":"example","Refinements":[{"FieldId":"example","ResolvedEntityDefinitionId":"example"}],"ConflictResolutions":[{"ItemId":"example","Action":0}],"ApplyHeader":true,"SelectedItemIds":["example"],"Security":{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","UserSlotMappings":{"additionalProperty":"example"},"PlanToken":"example","ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}}'};
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/import/apply \ --header 'Content-Type: application/json' \ --data '{ "Yaml": "example", "TargetEntityDefinitionId": "example", "Refinements": [ { "FieldId": "example", "ResolvedEntityDefinitionId": "example" } ], "ConflictResolutions": [ { "ItemId": "example", "Action": 0 } ], "ApplyHeader": true, "SelectedItemIds": [ "example" ], "Security": { "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "UserSlotMappings": { "additionalProperty": "example" }, "PlanToken": "example", "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “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 apply an approved import plan.
object
YAML document content (same as used for plan generation).
Target entity definition for update mode; null for create mode.
User-provided reference refinements.
User-provided mapping for a reference field whose target entity was not found.
object
Field identifier from YAML.
Mapped entity definition ID; null to skip the field.
User-provided conflict resolutions for update mode.
User decision for a conflicting plan item.
object
Plan item identifier.
Whether to apply entity-definition header changes.
Selected actionable plan item identifiers; null applies all actionable items.
Apply input for an Entity YAML v8 Security configuration.
object
Caller-owned idempotency key used by the matching plan.
Workspace-local user mappings for portable user slots.
object
Opaque token returned by the matching Security plan.
Security configuration row version returned by the matching plan.
Request payload to apply an approved import plan.
object
YAML document content (same as used for plan generation).
Target entity definition for update mode; null for create mode.
User-provided reference refinements.
User-provided mapping for a reference field whose target entity was not found.
object
Field identifier from YAML.
Mapped entity definition ID; null to skip the field.
User-provided conflict resolutions for update mode.
User decision for a conflicting plan item.
object
Plan item identifier.
Whether to apply entity-definition header changes.
Selected actionable plan item identifiers; null applies all actionable items.
Apply input for an Entity YAML v8 Security configuration.
object
Caller-owned idempotency key used by the matching plan.
Workspace-local user mappings for portable user slots.
object
Opaque token returned by the matching Security plan.
Security configuration row version returned by the matching plan.
Request payload to apply an approved import plan.
object
YAML document content (same as used for plan generation).
Target entity definition for update mode; null for create mode.
User-provided reference refinements.
User-provided mapping for a reference field whose target entity was not found.
object
Field identifier from YAML.
Mapped entity definition ID; null to skip the field.
User-provided conflict resolutions for update mode.
User decision for a conflicting plan item.
object
Plan item identifier.
Whether to apply entity-definition header changes.
Selected actionable plan item identifiers; null applies all actionable items.
Apply input for an Entity YAML v8 Security configuration.
object
Caller-owned idempotency key used by the matching plan.
Workspace-local user mappings for portable user slots.
object
Opaque token returned by the matching Security plan.
Security configuration row version returned by the matching plan.
Responses
Section titled “Responses”OK
object
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}