Create or replace disabled Reference Eligibility metadata for one Reference field.

PUT

/api/workspace/admin/entity-fields/{fieldId}/reference-eligibility

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/entity-fields/example/reference-eligibility"),
    Content = new StringContent("{ \"Expression\": \"example\", \"Message\": \"example\", \"MessageTranslations\": { \"additionalProperty\": \"example\" }, \"Enabled\": true, \"RowVersion\": \"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/admin/entity-fields/example/reference-eligibility';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"Expression":"example","Message":"example","MessageTranslations":{"additionalProperty":"example"},"Enabled":true,"RowVersion":"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 PUT \
  --url https://example.com/api/workspace/admin/entity-fields/example/reference-eligibility \
  --header 'Content-Type: application/json' \
  --data '{ "Expression": "example", "Message": "example", "MessageTranslations": { "additionalProperty": "example" }, "Enabled": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

fieldId

required

string

Query Parameters

access_token

string

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

Request Body

Request to create or replace field-owned Reference Eligibility metadata.

object

Expression

required

Expression authored against Current and Candidate.

string

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Requested runtime state.

boolean

RowVersion

Expected row version when replacing an existing rule.

string format: uuid

nullable

Example^generated

{
  "Expression": "example",
  "Message": "example",
  "MessageTranslations": {
    "additionalProperty": "example"
  },
  "Enabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request to create or replace field-owned Reference Eligibility metadata.

object

Expression

required

Expression authored against Current and Candidate.

string

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Requested runtime state.

boolean

RowVersion

Expected row version when replacing an existing rule.

string format: uuid

nullable

Example^generated

{
  "Expression": "example",
  "Message": "example",
  "MessageTranslations": {
    "additionalProperty": "example"
  },
  "Enabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request to create or replace field-owned Reference Eligibility metadata.

object

Expression

required

Expression authored against Current and Candidate.

string

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Requested runtime state.

boolean

RowVersion

Expected row version when replacing an existing rule.

string format: uuid

nullable

Example^generated

{
  "Expression": "example",
  "Message": "example",
  "MessageTranslations": {
    "additionalProperty": "example"
  },
  "Enabled": true,
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Field-owned Reference Eligibility configuration.

object

Stable rule identifier.

string

nullable

EntityDefinitionId

Identifier of the source entity definition.

string

nullable

TargetFieldDefinitionId

Identifier of the dependent Reference field.

string

nullable

Expression

Eligibility expression authored against Current and Candidate.

string

nullable

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Whether the rule participates in runtime enforcement.

boolean

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Owning Net Package identifier when package-owned.

string

nullable

SourcePackageId

Owning package artifact identifier when package-owned.

string

nullable

SourceStableId

Stable source identifier when package-owned.

string

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Dependencies

Compiler-owned dependency summary.

Array<object>

nullable

Compiler-owned Reference Eligibility dependency.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

CanonicalPath

Canonical Current or Candidate operand path.

string

nullable

RootFieldDefinitionId

Direct root field identifier when one exists.

string

nullable

ReferencedEntityDefinitionId

Definition containing the bound operand.

string

nullable

ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string

nullable

DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean

DrivesContributorValidation

Whether contributor changes require reverse validation.

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": {
    "SchemaSource": 0,
    "Dependencies": [
      {
        "Kind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Field-owned Reference Eligibility configuration.

object

Stable rule identifier.

string

nullable

EntityDefinitionId

Identifier of the source entity definition.

string

nullable

TargetFieldDefinitionId

Identifier of the dependent Reference field.

string

nullable

Expression

Eligibility expression authored against Current and Candidate.

string

nullable

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Whether the rule participates in runtime enforcement.

boolean

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Owning Net Package identifier when package-owned.

string

nullable

SourcePackageId

Owning package artifact identifier when package-owned.

string

nullable

SourceStableId

Stable source identifier when package-owned.

string

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Dependencies

Compiler-owned dependency summary.

Array<object>

nullable

Compiler-owned Reference Eligibility dependency.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

CanonicalPath

Canonical Current or Candidate operand path.

string

nullable

RootFieldDefinitionId

Direct root field identifier when one exists.

string

nullable

ReferencedEntityDefinitionId

Definition containing the bound operand.

string

nullable

ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string

nullable

DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean

DrivesContributorValidation

Whether contributor changes require reverse validation.

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": {
    "SchemaSource": 0,
    "Dependencies": [
      {
        "Kind": 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

Field-owned Reference Eligibility configuration.

object

Stable rule identifier.

string

nullable

EntityDefinitionId

Identifier of the source entity definition.

string

nullable

TargetFieldDefinitionId

Identifier of the dependent Reference field.

string

nullable

Expression

Eligibility expression authored against Current and Candidate.

string

nullable

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Whether the rule participates in runtime enforcement.

boolean

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Owning Net Package identifier when package-owned.

string

nullable

SourcePackageId

Owning package artifact identifier when package-owned.

string

nullable

SourceStableId

Stable source identifier when package-owned.

string

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Dependencies

Compiler-owned dependency summary.

Array<object>

nullable

Compiler-owned Reference Eligibility dependency.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

CanonicalPath

Canonical Current or Candidate operand path.

string

nullable

RootFieldDefinitionId

Direct root field identifier when one exists.

string

nullable

ReferencedEntityDefinitionId

Definition containing the bound operand.

string

nullable

ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string

nullable

DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean

DrivesContributorValidation

Whether contributor changes require reverse validation.

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": {
    "SchemaSource": 0,
    "Dependencies": [
      {
        "Kind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Field-owned Reference Eligibility configuration.

object

Stable rule identifier.

string

nullable

EntityDefinitionId

Identifier of the source entity definition.

string

nullable

TargetFieldDefinitionId

Identifier of the dependent Reference field.

string

nullable

Expression

Eligibility expression authored against Current and Candidate.

string

nullable

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Whether the rule participates in runtime enforcement.

boolean

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Owning Net Package identifier when package-owned.

string

nullable

SourcePackageId

Owning package artifact identifier when package-owned.

string

nullable

SourceStableId

Stable source identifier when package-owned.

string

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Dependencies

Compiler-owned dependency summary.

Array<object>

nullable

Compiler-owned Reference Eligibility dependency.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

CanonicalPath

Canonical Current or Candidate operand path.

string

nullable

RootFieldDefinitionId

Direct root field identifier when one exists.

string

nullable

ReferencedEntityDefinitionId

Definition containing the bound operand.

string

nullable

ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string

nullable

DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean

DrivesContributorValidation

Whether contributor changes require reverse validation.

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": {
    "SchemaSource": 0,
    "Dependencies": [
      {
        "Kind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

Service Unavailable

application/json

object

Data

Field-owned Reference Eligibility configuration.

object

Stable rule identifier.

string

nullable

EntityDefinitionId

Identifier of the source entity definition.

string

nullable

TargetFieldDefinitionId

Identifier of the dependent Reference field.

string

nullable

Expression

Eligibility expression authored against Current and Candidate.

string

nullable

Message

Optional default failure message.

string

nullable

MessageTranslations

Optional localized failure messages keyed by supported locale.

object

key

additional properties

string

Enabled

Whether the rule participates in runtime enforcement.

boolean

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Owning Net Package identifier when package-owned.

string

nullable

SourcePackageId

Owning package artifact identifier when package-owned.

string

nullable

SourceStableId

Stable source identifier when package-owned.

string

nullable

RowVersion

Optimistic concurrency token.

string format: uuid

Dependencies

Compiler-owned dependency summary.

Array<object>

nullable

Compiler-owned Reference Eligibility dependency.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

CanonicalPath

Canonical Current or Candidate operand path.

string

nullable

RootFieldDefinitionId

Direct root field identifier when one exists.

string

nullable

ReferencedEntityDefinitionId

Definition containing the bound operand.

string

nullable

ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string

nullable

DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean

DrivesContributorValidation

Whether contributor changes require reverse validation.

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": {
    "SchemaSource": 0,
    "Dependencies": [
      {
        "Kind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create or replace disabled Reference Eligibility metadata for one Reference field.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

503

Example

Example^generated

Example^generated

Example^generated

Example^generated