Preview active and archived data plus saved-surface impact for a proposed expression.
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/reference-eligibility/impact"), Content = new StringContent("{ \"Expression\": \"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-fields/example/reference-eligibility/impact';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Expression":"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-fields/example/reference-eligibility/impact \ --header 'Content-Type: application/json' \ --data '{ "Expression": "example" }'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 to preview persisted-data and saved-surface impact.
object
Proposed eligibility expression.
Examplegenerated
{ "Expression": "example"}Request to preview persisted-data and saved-surface impact.
object
Proposed eligibility expression.
Examplegenerated
{ "Expression": "example"}Request to preview persisted-data and saved-surface impact.
object
Proposed eligibility expression.
Examplegenerated
{ "Expression": "example"}Responses
Section titled “Responses”OK
object
Preview of data and saved-surface impact for a proposed eligibility expression.
object
Whether at least one persisted assignment violates the proposed rule.
Exact violation count only when the caller may observe the complete set.
At most five actor-readable source record identifiers.
Whether an affected saved Form or Table surface lacks required context.
Exact incompatible-surface count when authorized.
At most five readable incompatible surfaces.
Display-safe incompatible saved-surface sample.
object
Surface identifier.
Optional configured surface name.
object
object
object
object
Example
{ "Data": { "IncompatibleSurfaceSamples": [ { "Surface": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Preview of data and saved-surface impact for a proposed eligibility expression.
object
Whether at least one persisted assignment violates the proposed rule.
Exact violation count only when the caller may observe the complete set.
At most five actor-readable source record identifiers.
Whether an affected saved Form or Table surface lacks required context.
Exact incompatible-surface count when authorized.
At most five readable incompatible surfaces.
Display-safe incompatible saved-surface sample.
object
Surface identifier.
Optional configured surface name.
object
object
object
object
Example
{ "Data": { "IncompatibleSurfaceSamples": [ { "Surface": 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
Preview of data and saved-surface impact for a proposed eligibility expression.
object
Whether at least one persisted assignment violates the proposed rule.
Exact violation count only when the caller may observe the complete set.
At most five actor-readable source record identifiers.
Whether an affected saved Form or Table surface lacks required context.
Exact incompatible-surface count when authorized.
At most five readable incompatible surfaces.
Display-safe incompatible saved-surface sample.
object
Surface identifier.
Optional configured surface name.
object
object
object
object
Example
{ "Data": { "IncompatibleSurfaceSamples": [ { "Surface": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Service Unavailable
object
Preview of data and saved-surface impact for a proposed eligibility expression.
object
Whether at least one persisted assignment violates the proposed rule.
Exact violation count only when the caller may observe the complete set.
At most five actor-readable source record identifiers.
Whether an affected saved Form or Table surface lacks required context.
Exact incompatible-surface count when authorized.
At most five readable incompatible surfaces.
Display-safe incompatible saved-surface sample.
object
Surface identifier.
Optional configured surface name.
object
object
object
object
Example
{ "Data": { "IncompatibleSurfaceSamples": [ { "Surface": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}