Resolve or create the projection row that wraps one concrete source record.

POST

/api/workspace/entity/{entityIdOrKey}/projection/wrap-source

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/projection/wrap-source"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"SourceEntityDefinitionId\": \"example\", \"SourceInstanceId\": \"example\", \"OperationKey\": \"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/entity/example/projection/wrap-source';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"SourceEntityDefinitionId":"example","SourceInstanceId":"example","OperationKey":"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/entity/example/projection/wrap-source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "SourceEntityDefinitionId": "example", "SourceInstanceId": "example", "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Projection entity definition identifier or normalized key.

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Concrete source record identifier to wrap.

Request payload to resolve or create a projection row for a concrete source record.

object

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

OperationKey

string format: uuid

Example^generated

{
  "SourceEntityDefinitionId": "example",
  "SourceInstanceId": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request payload to resolve or create a projection row for a concrete source record.

object

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

OperationKey

string format: uuid

Example^generated

{
  "SourceEntityDefinitionId": "example",
  "SourceInstanceId": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request payload to resolve or create a projection row for a concrete source record.

object

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

OperationKey

string format: uuid

Example^generated

{
  "SourceEntityDefinitionId": "example",
  "SourceInstanceId": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Projection row resolved for one concrete source row and ready to store as a reference value.

object

ProjectionEntityDefinitionId

string

nullable

ProjectionInstanceId

string

nullable

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

ReferenceFieldId

string

nullable

Reference

Compact runtime payload for one resolved or unresolved entity reference.

object

State

integer format: int32

Allowed values: 0 1 2

Linked entity identifier when resolved.

string

nullable

Number

Linked entity number when resolved.

string

nullable

DisplayName

Linked entity display name from the presentation cache when resolved.

string

nullable

Subtitle

Linked entity subtitle from the presentation cache when resolved.

string

nullable

ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object

key

additional properties

nullable

EntityDefinitionId

Linked entity definition identifier when resolved.

string

nullable

ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object

key

additional properties

Safe compact visible-text representation of a Markdown value.

object

Text

Visible text when available.

string

nullable

IsTruncated

Whether the visible text was shortened for compact presentation.

boolean

State

integer format: int32

Allowed values: 0 1 2 3

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

Created

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Reference": {
      "State": 0,
      "ProjectedPlainTextPreviews": {
        "additionalProperty": {
          "State": 0
        }
      },
      "SemanticPresentation": {
        "UsageType": 0
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Projection row resolved for one concrete source row and ready to store as a reference value.

object

ProjectionEntityDefinitionId

string

nullable

ProjectionInstanceId

string

nullable

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

ReferenceFieldId

string

nullable

Reference

Compact runtime payload for one resolved or unresolved entity reference.

object

State

integer format: int32

Allowed values: 0 1 2

Linked entity identifier when resolved.

string

nullable

Number

Linked entity number when resolved.

string

nullable

DisplayName

Linked entity display name from the presentation cache when resolved.

string

nullable

Subtitle

Linked entity subtitle from the presentation cache when resolved.

string

nullable

ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object

key

additional properties

nullable

EntityDefinitionId

Linked entity definition identifier when resolved.

string

nullable

ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object

key

additional properties

Safe compact visible-text representation of a Markdown value.

object

Text

Visible text when available.

string

nullable

IsTruncated

Whether the visible text was shortened for compact presentation.

boolean

State

integer format: int32

Allowed values: 0 1 2 3

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

Created

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Reference": {
      "State": 0,
      "ProjectedPlainTextPreviews": {
        "additionalProperty": {
          "State": 0
        }
      },
      "SemanticPresentation": {
        "UsageType": 0
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

Data

Projection row resolved for one concrete source row and ready to store as a reference value.

object

ProjectionEntityDefinitionId

string

nullable

ProjectionInstanceId

string

nullable

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

ReferenceFieldId

string

nullable

Reference

Compact runtime payload for one resolved or unresolved entity reference.

object

State

integer format: int32

Allowed values: 0 1 2

Linked entity identifier when resolved.

string

nullable

Number

Linked entity number when resolved.

string

nullable

DisplayName

Linked entity display name from the presentation cache when resolved.

string

nullable

Subtitle

Linked entity subtitle from the presentation cache when resolved.

string

nullable

ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object

key

additional properties

nullable

EntityDefinitionId

Linked entity definition identifier when resolved.

string

nullable

ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object

key

additional properties

Safe compact visible-text representation of a Markdown value.

object

Text

Visible text when available.

string

nullable

IsTruncated

Whether the visible text was shortened for compact presentation.

boolean

State

integer format: int32

Allowed values: 0 1 2 3

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

Created

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Reference": {
      "State": 0,
      "ProjectedPlainTextPreviews": {
        "additionalProperty": {
          "State": 0
        }
      },
      "SemanticPresentation": {
        "UsageType": 0
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

404

Not Found

application/json

object

Data

Projection row resolved for one concrete source row and ready to store as a reference value.

object

ProjectionEntityDefinitionId

string

nullable

ProjectionInstanceId

string

nullable

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

ReferenceFieldId

string

nullable

Reference

Compact runtime payload for one resolved or unresolved entity reference.

object

State

integer format: int32

Allowed values: 0 1 2

Linked entity identifier when resolved.

string

nullable

Number

Linked entity number when resolved.

string

nullable

DisplayName

Linked entity display name from the presentation cache when resolved.

string

nullable

Subtitle

Linked entity subtitle from the presentation cache when resolved.

string

nullable

ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object

key

additional properties

nullable

EntityDefinitionId

Linked entity definition identifier when resolved.

string

nullable

ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object

key

additional properties

Safe compact visible-text representation of a Markdown value.

object

Text

Visible text when available.

string

nullable

IsTruncated

Whether the visible text was shortened for compact presentation.

boolean

State

integer format: int32

Allowed values: 0 1 2 3

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

Created

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Reference": {
      "State": 0,
      "ProjectedPlainTextPreviews": {
        "additionalProperty": {
          "State": 0
        }
      },
      "SemanticPresentation": {
        "UsageType": 0
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Projection row resolved for one concrete source row and ready to store as a reference value.

object

ProjectionEntityDefinitionId

string

nullable

ProjectionInstanceId

string

nullable

SourceEntityDefinitionId

string

nullable

SourceInstanceId

string

nullable

ReferenceFieldId

string

nullable

Reference

Compact runtime payload for one resolved or unresolved entity reference.

object

State

integer format: int32

Allowed values: 0 1 2

Linked entity identifier when resolved.

string

nullable

Number

Linked entity number when resolved.

string

nullable

DisplayName

Linked entity display name from the presentation cache when resolved.

string

nullable

Subtitle

Linked entity subtitle from the presentation cache when resolved.

string

nullable

ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object

key

additional properties

nullable

EntityDefinitionId

Linked entity definition identifier when resolved.

string

nullable

ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object

key

additional properties

Safe compact visible-text representation of a Markdown value.

object

Text

Visible text when available.

string

nullable

IsTruncated

Whether the visible text was shortened for compact presentation.

boolean

State

integer format: int32

Allowed values: 0 1 2 3

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

Created

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Reference": {
      "State": 0,
      "ProjectedPlainTextPreviews": {
        "additionalProperty": {
          "State": 0
        }
      },
      "SemanticPresentation": {
        "UsageType": 0
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Resolve or create the projection row that wraps one concrete source record.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Example

404

Example

409

Example

Example^generated

Example^generated

Example^generated