Evaluate update-form mutation effects without saving a record.

POST

/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/form-evaluation

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/instances/example/form-evaluation"),
    Content = new StringContent("{ \"Mode\": 0, \"DraftFields\": { \"additionalProperty\": {} }, \"ChangedFields\": [ \"example\" ], \"FieldOrigins\": { \"additionalProperty\": 0 } }")
    {
        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/instances/example/form-evaluation';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Mode":0,"DraftFields":{"additionalProperty":{}},"ChangedFields":["example"],"FieldOrigins":{"additionalProperty":0}}'
};

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/instances/example/form-evaluation \
  --header 'Content-Type: application/json' \
  --data '{ "Mode": 0, "DraftFields": { "additionalProperty": {} }, "ChangedFields": [ "example" ], "FieldOrigins": { "additionalProperty": 0 } }'

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

instanceId

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 for debounced entity form mutation-effect evaluation.

object

Mode

integer format: int32

Allowed values: 0 1 2

DraftFields

object

key

additional properties

object

ChangedFields

Array<string>

nullable

FieldOrigins

object

key

additional properties

integer format: int32

Allowed values: 0 1 2

Responses

200

application/json

object

Data

Result of server-side form mutation-effect evaluation.

object

Patch

object

key

additional properties

object

FieldOrigins

object

key

additional properties

integer format: int32

Allowed values: 0 1 2

LoadingFieldKeys

Array<string>

nullable

FieldErrors

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

Skips

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

400

Bad Request

application/json

object

Data

Result of server-side form mutation-effect evaluation.

object

Patch

object

key

additional properties

object

FieldOrigins

object

key

additional properties

integer format: int32

Allowed values: 0 1 2

LoadingFieldKeys

Array<string>

nullable

FieldErrors

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

Skips

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": {
    "FieldOrigins": {
      "additionalProperty": 0
    },
    "FieldErrors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ],
    "Skips": [
      {
        "Type": 0,
        "Severity": 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

Result of server-side form mutation-effect evaluation.

object

Patch

object

key

additional properties

object

FieldOrigins

object

key

additional properties

integer format: int32

Allowed values: 0 1 2

LoadingFieldKeys

Array<string>

nullable

FieldErrors

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

Skips

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

Evaluate update-form mutation effects without saving a record.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated