Create or update explicit field UI preferences for one field.

PUT

/api/workspace/admin/entity-definitions/{entityDefinitionId}/fields/{fieldId}/ui

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-definitions/example/fields/example/ui"),
    Content = new StringContent("{ \"ReferenceInputType\": 0, \"ReferenceRendererType\": 0, \"ReferenceLookupRenderType\": 0, \"ReferencePath\": [ \"example\" ], \"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-definitions/example/fields/example/ui';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"ReferenceInputType":0,"ReferenceRendererType":0,"ReferenceLookupRenderType":0,"ReferencePath":["example"],"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-definitions/example/fields/example/ui \
  --header 'Content-Type: application/json' \
  --data '{ "ReferenceInputType": 0, "ReferenceRendererType": 0, "ReferenceLookupRenderType": 0, "ReferencePath": [ "example" ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

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 payload to create or update explicit field UI preferences.

object

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Optional breadcrumb reference path.

Array<string>

nullable

RowVersion

Expected explicit row version when updating, or null when creating.

string format: uuid

nullable

Responses

200

application/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 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

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Effective admin-facing field UI preferences for one field.

object

HasOverride

Whether an explicit preference row exists for the field.

boolean

ReferenceInputType

integer format: int32

Allowed values: 0 1 2 3

ReferenceRendererType

integer format: int32

Allowed values: 0 1

ReferenceLookupRenderType

integer format: int32

Allowed values: 0 1

ReferencePath

Effective breadcrumb reference path.

Array<string>

nullable

RowVersion

Explicit row version when an override exists.

string format: uuid

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": {
    "ReferenceInputType": 0,
    "ReferenceRendererType": 0,
    "ReferenceLookupRenderType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create or update explicit field UI preferences for one field.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated