List assignment targets.

GET

/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/assignments/{relationDefinitionId}/targets

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/assignments/example/targets"),
};
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/assignments/example/targets';
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/assignments/example/targets

Returns server-approved assignment target options for one relation slot on one active entity instance. The caller must hold explicit assignment authority for the addressed relation slot.

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

Entity definition identifier or normalized entity key.

instanceId

required

string

Entity instance identifier.

relationDefinitionId

required

string

Relation definition identifier for the assignment slot.

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

Server-approved assignment target options for one record relation slot.

object

Relation

Runtime relation slot metadata for record-scoped assignments.

object

Relation definition identifier.

string

nullable

Key

Relation definition key.

string

nullable

DisplayName

Relation display name.

string

nullable

Cardinality

integer format: int32

Allowed values: 0 1

IsRequired

Whether the relation must keep at least one assignment.

boolean

SubjectMode

integer format: int32

Allowed values: 0 1 2

SortOrder

Relation display order.

integer format: int32

Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object

CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean

Targets

Eligible assignment target options.

Array<object>

nullable

Server-approved assignment target option for one relation slot.

object

SubjectType

integer format: int32

Allowed values: 0 1

SubjectId

Assignment subject identifier.

string

nullable

DisplayName

Display name shown by assignment pickers.

string

nullable

Description

Optional secondary description.

string

nullable

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": {
    "Relation": {
      "Cardinality": 0,
      "SubjectMode": 0
    },
    "Targets": [
      {
        "SubjectType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Server-approved assignment target options for one record relation slot.

object

Relation

Runtime relation slot metadata for record-scoped assignments.

object

Relation definition identifier.

string

nullable

Key

Relation definition key.

string

nullable

DisplayName

Relation display name.

string

nullable

Cardinality

integer format: int32

Allowed values: 0 1

IsRequired

Whether the relation must keep at least one assignment.

boolean

SubjectMode

integer format: int32

Allowed values: 0 1 2

SortOrder

Relation display order.

integer format: int32

Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object

CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean

Targets

Eligible assignment target options.

Array<object>

nullable

Server-approved assignment target option for one relation slot.

object

SubjectType

integer format: int32

Allowed values: 0 1

SubjectId

Assignment subject identifier.

string

nullable

DisplayName

Display name shown by assignment pickers.

string

nullable

Description

Optional secondary description.

string

nullable

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": {
    "Relation": {
      "Cardinality": 0,
      "SubjectMode": 0
    },
    "Targets": [
      {
        "SubjectType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Server-approved assignment target options for one record relation slot.

object

Relation

Runtime relation slot metadata for record-scoped assignments.

object

Relation definition identifier.

string

nullable

Key

Relation definition key.

string

nullable

DisplayName

Relation display name.

string

nullable

Cardinality

integer format: int32

Allowed values: 0 1

IsRequired

Whether the relation must keep at least one assignment.

boolean

SubjectMode

integer format: int32

Allowed values: 0 1 2

SortOrder

Relation display order.

integer format: int32

Permissions

Server-computed mutation permissions for one relation slot on one entity instance.

object

CanUpdate

Whether the caller can replace the assignment set for the relation slot.

boolean

Targets

Eligible assignment target options.

Array<object>

nullable

Server-approved assignment target option for one relation slot.

object

SubjectType

integer format: int32

Allowed values: 0 1

SubjectId

Assignment subject identifier.

string

nullable

DisplayName

Display name shown by assignment pickers.

string

nullable

Description

Optional secondary description.

string

nullable

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": {
    "Relation": {
      "Cardinality": 0,
      "SubjectMode": 0
    },
    "Targets": [
      {
        "SubjectType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

List assignment targets.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

409

Example

Example^generated