Return projection-entity configuration for one entity definition.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/projection"),};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/projection';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/entity-definitions/example/projectionConcepts, member field rules, and mapping semantics: projection.
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.
Responses
Section titled “Responses”OK
object
Projection-entity configuration for one entity definition.
object
Projection configuration identifier.
Projection entity definition identifier.
Whether projection synchronization is active.
Configured source members, one per member reference field.
Projection-entity source member configuration.
object
Member identifier.
Owning projection configuration identifier.
Projection-managed reference field that links projection rows to source rows.
Key of the member reference field.
Display name of the member reference field.
Source entity definition identifier.
Internal name of the source entity definition.
Display name of the source entity definition.
Stable technical key of the member.
Administrative display name of the member.
Member order in administrative lists.
Whether rows of this source participate in synchronization.
Concurrency token.
Configured field mappings across all members.
Projection-entity field mapping rule.
object
Mapping identifier.
Owning projection configuration identifier.
Member this mapping belongs to.
Reference field of the owning member.
Target projection field identifier when the target kind is Field.
Key of the target projection field when the target kind is Field.
Display name of the target projection field when the target kind is Field.
Field-key path from the source row as ordered segments.
Reserved transform settings; not read by the Copy transform.
Mapping order within the member.
Concurrency token.
Concurrency token for the projection configuration.
object
object
object
object
Example
{ "Data": { "ProjectionKind": 0, "OpenBehavior": 0, "Mappings": [ { "TargetKind": 0, "TransformKind": 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
Projection-entity configuration for one entity definition.
object
Projection configuration identifier.
Projection entity definition identifier.
Whether projection synchronization is active.
Configured source members, one per member reference field.
Projection-entity source member configuration.
object
Member identifier.
Owning projection configuration identifier.
Projection-managed reference field that links projection rows to source rows.
Key of the member reference field.
Display name of the member reference field.
Source entity definition identifier.
Internal name of the source entity definition.
Display name of the source entity definition.
Stable technical key of the member.
Administrative display name of the member.
Member order in administrative lists.
Whether rows of this source participate in synchronization.
Concurrency token.
Configured field mappings across all members.
Projection-entity field mapping rule.
object
Mapping identifier.
Owning projection configuration identifier.
Member this mapping belongs to.
Reference field of the owning member.
Target projection field identifier when the target kind is Field.
Key of the target projection field when the target kind is Field.
Display name of the target projection field when the target kind is Field.
Field-key path from the source row as ordered segments.
Reserved transform settings; not read by the Copy transform.
Mapping order within the member.
Concurrency token.
Concurrency token for the projection configuration.
object
object
object
object
Example
{ "Data": { "ProjectionKind": 0, "OpenBehavior": 0, "Mappings": [ { "TargetKind": 0, "TransformKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}