Validate one exact Manual Order move for Details or Drawer related data.

POST

/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/related/move/validate

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/hosted-layout/related/move/validate"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"MovedInstanceId\": \"example\", \"Kind\": 0, \"TargetInstanceId\": \"example\", \"ExpectedInstanceRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ExpectedTargetInstanceRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ExpectedTableSurfaceId\": \"example\", \"ExpectedTableSurfaceRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"LayoutItemId\": \"example\", \"ExpectedContextRevision\": \"example\" }")
    {
        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/entity/example/ui/hosted-layout/related/move/validate';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","MovedInstanceId":"example","Kind":0,"TargetInstanceId":"example","ExpectedInstanceRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ExpectedTargetInstanceRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ExpectedTableSurfaceId":"example","ExpectedTableSurfaceRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","LayoutItemId":"example","ExpectedContextRevision":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/entity/example/ui/hosted-layout/related/move/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "MovedInstanceId": "example", "Kind": 0, "TargetInstanceId": "example", "ExpectedInstanceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ExpectedTargetInstanceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ExpectedTableSurfaceId": "example", "ExpectedTableSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "LayoutItemId": "example", "ExpectedContextRevision": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Query Parameters

hostSurface

string

surfaceKey

string

instanceId

string

access_token

string

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

Request Body

Details or Drawer related-table Manual Order move intent.

object

OperationKey

required

Caller-owned stable key used to replay one logical move safely.

string format: uuid

MovedInstanceId

required

Entity Instance to move.

string

>= 1 characters

Kind

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6

TargetInstanceId

Target instance for target-bearing kinds; absent for root-boundary kinds.

string

nullable

ExpectedInstanceRowVersion

required

Expected moved Entity Instance concurrency token.

string format: uuid

ExpectedTargetInstanceRowVersion

Expected target Entity Instance concurrency token, required exactly when a target is present.

string format: uuid

nullable

ExpectedTableSurfaceId

required

Expected resolved Table Surface identifier.

string

>= 1 characters

ExpectedTableSurfaceRowVersion

required

Expected resolved Table Surface concurrency token.

string format: uuid

LayoutItemId

required

Related-data layout item that owns the server-side binding.

string

>= 1 characters

ExpectedContextRevision

required

Expected opaque related host-context revision returned by bootstrap.

string

>= 1 characters

Responses

200

application/json

object

Data

Exact server validation of one Manual Order move intent.

object

Allowed

Whether the normalized intent currently passes every move gate.

boolean

WouldChange

Whether executing the normalized intent would change Parent or canonical rank.

boolean

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5 6

TargetInstanceId

Validated visible target identifier, or null for a root-boundary move.

string

nullable

FinalParentInstanceId

Access-safe resolved final Parent identifier, or null for a visible root.

string

nullable

Errors

Localized validation failures. Physical rank bounds are never included.

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

400

Bad Request

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"
}

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

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

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"
}

503

Service Unavailable

Validate one exact Manual Order move for Details or Drawer related data.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

503

Example^generated

Example^generated

Example^generated

Example^generated