Create instance.

POST

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

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"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"EntityDefinitionKey\": \"example\", \"Values\": { \"additionalProperty\": \"example\" }, \"ResponsibilityCandidates\": [ { \"ResponsibilityKey\": \"example\", \"Subjects\": [ { \"SubjectType\": \"example\", \"SubjectId\": \"example\", \"EffectiveFrom\": \"2026-04-15T12:00:00Z\", \"EffectiveTo\": \"2026-04-15T12:00:00Z\" } ] } ], \"ExpectedDefinitionRowVersion\": \"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';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","EntityDefinitionKey":"example","Values":{"additionalProperty":"example"},"ResponsibilityCandidates":[{"ResponsibilityKey":"example","Subjects":[{"SubjectType":"example","SubjectId":"example","EffectiveFrom":"2026-04-15T12:00:00Z","EffectiveTo":"2026-04-15T12:00:00Z"}]}],"ExpectedDefinitionRowVersion":"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 POST \
  --url https://example.com/api/workspace/entity/example/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "EntityDefinitionKey": "example", "Values": { "additionalProperty": "example" }, "ResponsibilityCandidates": [ { "ResponsibilityKey": "example", "Subjects": [ { "SubjectType": "example", "SubjectId": "example", "EffectiveFrom": "2026-04-15T12:00:00Z", "EffectiveTo": "2026-04-15T12:00:00Z" } ] } ], "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

The current Entity Security configuration must allow Create, every caller-supplied field must allow CreateWrite, every caller-proposed responsibility must match a StageOnCreate assignment rule, and the complete staged record must remain visible. Any denial rolls the entire create back. A successful response always has Data.Kind = "AuthorizedEntityDetail"; the created identity and concurrency token are Data.Data.EntityInstanceId and Data.Data.RowVersion. This endpoint never returns the safe "Receipt" variant.

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Entity definition identifier or normalized entity key.

Query Parameters

access_token

string

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

Request Body^required

Dynamic instance payload.

Creates one Entity record through the governed application-automation boundary.

object

OperationKey

required

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

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key matched by the route.

string

Values

required

Caller-supplied primary field values keyed by stable field key.

object

key

additional properties

ResponsibilityCandidates

required

StageOnCreate responsibility candidates; pass an empty list when none are proposed.

Array<object>

Groups caller-proposed initial subjects under one stable responsibility key.

object

ResponsibilityKey

required

string

Subjects

required

Array<object>

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

ExpectedDefinitionRowVersion

required

Latest Entity Definition row version used as the schema concurrency token.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": "example"
  },
  "ResponsibilityCandidates": [
    {
      "ResponsibilityKey": "example",
      "Subjects": [
        {
          "SubjectType": "example",
          "SubjectId": "example",
          "EffectiveFrom": "2026-04-15T12:00:00Z",
          "EffectiveTo": "2026-04-15T12:00:00Z"
        }
      ]
    }
  ],
  "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Creates one Entity record through the governed application-automation boundary.

object

OperationKey

required

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

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key matched by the route.

string

Values

required

Caller-supplied primary field values keyed by stable field key.

object

key

additional properties

ResponsibilityCandidates

required

StageOnCreate responsibility candidates; pass an empty list when none are proposed.

Array<object>

Groups caller-proposed initial subjects under one stable responsibility key.

object

ResponsibilityKey

required

string

Subjects

required

Array<object>

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

ExpectedDefinitionRowVersion

required

Latest Entity Definition row version used as the schema concurrency token.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": "example"
  },
  "ResponsibilityCandidates": [
    {
      "ResponsibilityKey": "example",
      "Subjects": [
        {
          "SubjectType": "example",
          "SubjectId": "example",
          "EffectiveFrom": "2026-04-15T12:00:00Z",
          "EffectiveTo": "2026-04-15T12:00:00Z"
        }
      ]
    }
  ],
  "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Creates one Entity record through the governed application-automation boundary.

object

OperationKey

required

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

string format: uuid

EntityDefinitionKey

required

Entity definition identifier or normalized key matched by the route.

string

Values

required

Caller-supplied primary field values keyed by stable field key.

object

key

additional properties

ResponsibilityCandidates

required

StageOnCreate responsibility candidates; pass an empty list when none are proposed.

Array<object>

Groups caller-proposed initial subjects under one stable responsibility key.

object

ResponsibilityKey

required

string

Subjects

required

Array<object>

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

ExpectedDefinitionRowVersion

required

Latest Entity Definition row version used as the schema concurrency token.

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": "example"
  },
  "ResponsibilityCandidates": [
    {
      "ResponsibilityKey": "example",
      "Subjects": [
        {
          "SubjectType": "example",
          "SubjectId": "example",
          "EffectiveFrom": "2026-04-15T12:00:00Z",
          "EffectiveTo": "2026-04-15T12:00:00Z"
        }
      ]
    }
  ],
  "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

Created

application/json

object

Data

One of: discriminator: Kind

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

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

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

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

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

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

Create instance.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

201

Example

400

Example

403

Example

404

Example

409

Example

503

Example

Request Body^required

Example^generated

Example^generated

Example^generated