Return Manual Order move capabilities for a persisted Lookup table.

POST

/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/move-options

curl --request POST \
  --url https://example.com/api/workspace/entity/example/ui/form/example/items/example/lookup-table/move-options \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "MovedInstanceId": "example", "ExpectedLookupFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

formSurfaceId

required

string

formItemId

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

Lookup-host move-options request with the saved Form revision from bootstrap.

object

MovedInstanceId

required

Entity Instance whose move capabilities are requested.

string

>= 1 characters

ExpectedLookupFormSurfaceRowVersion

required

Expected saved Form Surface revision that owns the Lookup item.

string format: uuid

Example^generated

{
  "MovedInstanceId": "example",
  "ExpectedLookupFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Lookup-host move-options request with the saved Form revision from bootstrap.

object

MovedInstanceId

required

Entity Instance whose move capabilities are requested.

string

>= 1 characters

ExpectedLookupFormSurfaceRowVersion

required

Expected saved Form Surface revision that owns the Lookup item.

string format: uuid

Example^generated

{
  "MovedInstanceId": "example",
  "ExpectedLookupFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Lookup-host move-options request with the saved Form revision from bootstrap.

object

MovedInstanceId

required

Entity Instance whose move capabilities are requested.

string

>= 1 characters

ExpectedLookupFormSurfaceRowVersion

required

Expected saved Form Surface revision that owns the Lookup item.

string format: uuid

Example^generated

{
  "MovedInstanceId": "example",
  "ExpectedLookupFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

Data

Coarse actor- and surface-bound Manual Order move capabilities for one instance.

object

InstanceId

Entity Instance identifier.

string

nullable

InstanceRowVersion

Current Entity Instance concurrency token.

string format: uuid

TableSurfaceId

Resolved Table Surface identifier.

string

nullable

TableSurfaceRowVersion

Current Table Surface concurrency token.

string format: uuid

CanReorder

Whether rank-only movement may be attempted.

boolean

CanReparent

Whether Parent-changing movement may be attempted.

boolean

CanMoveToRoot

Whether movement to the root level may be attempted.

boolean

DisabledReasons

Access-safe localized reasons for disabled capabilities.

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

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

400

Bad Request

Media typeapplication/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"
}

403

Forbidden

Media typeapplication/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

Media typeapplication/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"
}

409

Conflict

Media typeapplication/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"
}

503

Service Unavailable