Return the runtime UI target that should open for one entity instance.

GET

/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/open-target

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/example/open-target"),
};
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/instances/example/open-target';
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/entity/example/instances/example/open-target

Normal entity rows resolve to themselves. Enabled Projection Entity rows resolve to the concrete source row behind the projection row. The caller must be able to read both the requested row and the resolved target row.

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

Entity definition identifier or normalized entity key.

instanceId

required

string

Requested entity instance identifier.

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

Resolved runtime target for opening one entity instance from UI navigation.

object

RequestedEntityDefinitionId

string

nullable

RequestedInstanceId

string

nullable

TargetEntityDefinitionId

string

nullable

TargetInstanceId

string

nullable

TargetEntityDisplayNameSingular

string

nullable

TargetEntityDisplayNamePlural

string

nullable

IsProjectionUnwrapped

boolean

ProjectionReferenceFieldId

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Resolved runtime target for opening one entity instance from UI navigation.

object

RequestedEntityDefinitionId

string

nullable

RequestedInstanceId

string

nullable

TargetEntityDefinitionId

string

nullable

TargetInstanceId

string

nullable

TargetEntityDisplayNameSingular

string

nullable

TargetEntityDisplayNamePlural

string

nullable

IsProjectionUnwrapped

boolean

ProjectionReferenceFieldId

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

Data

Resolved runtime target for opening one entity instance from UI navigation.

object

RequestedEntityDefinitionId

string

nullable

RequestedInstanceId

string

nullable

TargetEntityDefinitionId

string

nullable

TargetInstanceId

string

nullable

TargetEntityDisplayNameSingular

string

nullable

TargetEntityDisplayNamePlural

string

nullable

IsProjectionUnwrapped

boolean

ProjectionReferenceFieldId

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

404

Not Found

application/json

object

Data

Resolved runtime target for opening one entity instance from UI navigation.

object

RequestedEntityDefinitionId

string

nullable

RequestedInstanceId

string

nullable

TargetEntityDefinitionId

string

nullable

TargetInstanceId

string

nullable

TargetEntityDisplayNameSingular

string

nullable

TargetEntityDisplayNamePlural

string

nullable

IsProjectionUnwrapped

boolean

ProjectionReferenceFieldId

string

nullable

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}