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"),
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"EntityDefinitionKey\": \"example\", \"Values\": { \"additionalProperty\": {} }, \"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: {'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","EntityDefinitionKey":"example","Values":{"additionalProperty":{}},"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 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "EntityDefinitionKey": "example", "Values": { "additionalProperty": {} }, "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.

Authorizations

None

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.

object

OperationKey

required

string format: uuid

EntityDefinitionKey

required

string

Values

required

object

key

additional properties

object

ResponsibilityCandidates

required

Array<object>

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

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": {}
  },
  "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"
}

object

OperationKey

required

string format: uuid

EntityDefinitionKey

required

string

Values

required

object

key

additional properties

object

ResponsibilityCandidates

required

Array<object>

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

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": {}
  },
  "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"
}

object

OperationKey

required

string format: uuid

EntityDefinitionKey

required

string

Values

required

object

key

additional properties

object

ResponsibilityCandidates

required

Array<object>

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

string format: uuid

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "EntityDefinitionKey": "example",
  "Values": {
    "additionalProperty": {}
  },
  "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

object

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

object

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

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

object

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

object

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

Service Unavailable

application/json

object

Data

object

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

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

Examplegenerated

404

Example

409

Example

503

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated