Patch instance.

PATCH

/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"EntityDefinitionKey\": \"example\", \"EntityInstanceId\": \"example\", \"Patch\": { \"additionalProperty\": \"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/entity/example/instances/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","EntityDefinitionKey":"example","EntityInstanceId":"example","Patch":{"additionalProperty":"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 PATCH \
  --url https://example.com/api/workspace/entity/example/instances/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "EntityDefinitionKey": "example", "EntityInstanceId": "example", "Patch": { "additionalProperty": "example" }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

PATCH uses tri-state field semantics: omitted keys are undefined and remain unchanged, explicit null clears a field, and any other value replaces the stored value. Undefined fields do not pass through required validation. Unauthorized field inputs are skipped and returned as warnings. A readable final state returns Data.Kind = "AuthorizedEntityDetail". If the write commits but the final state is not readable, Data.Kind = "Receipt" carries OperationKey, CompletedAt, caller-known EntityDefinitionId and EntityInstanceId, AuditCorrelationId, IsIdempotentReplay, Success, and CanViewResult. The safe receipt contains neither the new row version nor record values.

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Entity definition identifier or normalized entity key.

instanceId

required

string

Entity instance identifier.

Query Parameters

access_token

string

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

Request Body^required

Partial mutation payload.

Updates stored field values of one Entity record through the governed application pipeline.

object

OperationKey

required

Caller-generated UUID that identifies one logical update and must be reused only for an exact retry.

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key; it must match the route.

string

EntityInstanceId

required

Target Entity record identifier; it must match the route.

string

Patch

required

Changed field values keyed by stable field key; fields that are left out keep their stored values.

object

key

additional properties

RowVersion

required

Current row version of the record expected by the caller.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "EntityInstanceId": "example",
  "Patch": {
    "additionalProperty": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Updates stored field values of one Entity record through the governed application pipeline.

object

OperationKey

required

Caller-generated UUID that identifies one logical update and must be reused only for an exact retry.

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key; it must match the route.

string

EntityInstanceId

required

Target Entity record identifier; it must match the route.

string

Patch

required

Changed field values keyed by stable field key; fields that are left out keep their stored values.

object

key

additional properties

RowVersion

required

Current row version of the record expected by the caller.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "EntityInstanceId": "example",
  "Patch": {
    "additionalProperty": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Updates stored field values of one Entity record through the governed application pipeline.

object

OperationKey

required

Caller-generated UUID that identifies one logical update and must be reused only for an exact retry.

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key; it must match the route.

string

EntityInstanceId

required

Target Entity record identifier; it must match the route.

string

Patch

required

Changed field values keyed by stable field key; fields that are left out keep their stored values.

object

key

additional properties

RowVersion

required

Current row version of the record expected by the caller.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "EntityInstanceId": "example",
  "Patch": {
    "additionalProperty": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

400

Bad Request

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

403

Forbidden

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

404

Not Found

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

409

Conflict

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

503

Service Unavailable

application/json

object

Data

One of: discriminator: Kind

object
object

Authorized post-mutation Entity detail.

object

Data

required

object

EntityDefinitionId

required

string

EntityInstanceId

required

string

RowVersion

required

string format: uuid

AuthorizedFields

required

object

key

additional properties

IsIdempotentReplay

required

Whether the host returned an earlier durable result without another write.

boolean

CanViewResult

required

boolean

Kind

required

string

Allowed values: AuthorizedEntityDetail

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

Patch instance.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Example

404

Example

409

Example

503

Example

Request Body^required

Example^generated

Example^generated

Example^generated