Replace one common responsibility timeline for an Entity instance.

PUT

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/example/assignments/example"),
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Resource\": { \"ResourceModule\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"ResponsibilityKey\": \"example\", \"Subjects\": [ { \"SubjectType\": \"example\", \"SubjectId\": \"example\", \"EffectiveFrom\": \"2026-04-15T12:00:00Z\", \"EffectiveTo\": \"2026-04-15T12:00:00Z\" } ], \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Reason\": \"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/instances/example/assignments/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Resource":{"ResourceModule":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"ResponsibilityKey":"example","Subjects":[{"SubjectType":"example","SubjectId":"example","EffectiveFrom":"2026-04-15T12:00:00Z","EffectiveTo":"2026-04-15T12:00:00Z"}],"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Reason":"example"}'
};

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

curl --request PUT \
  --url https://example.com/api/workspace/entity/example/instances/example/assignments/example \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Resource": { "ResourceModule": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "ResponsibilityKey": "example", "Subjects": [ { "SubjectType": "example", "SubjectId": "example", "EffectiveFrom": "2026-04-15T12:00:00Z", "EffectiveTo": "2026-04-15T12:00:00Z" } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Reason": "example" }'

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

Entity definition identifier or normalized key.

instanceId

required

string

Entity instance identifier.

relationDefinitionId

required

string

Stable responsibility code. The route parameter name is retained by the frozen Sprint 2 route contract; it no longer identifies an Entity relation definition.

Query Parameters

access_token

string

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

Request Body

Replay-safe complete responsibility timeline replacement.

object

OperationKey

string format: uuid

Resource

object

ResourceModule

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

ResponsibilityKey

string

nullable

Subjects

Array<object>

nullable

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

RowVersion

string format: uuid

Reason

string

nullable

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Resource": {
    "ResourceModule": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "ResponsibilityKey": "example",
  "Subjects": [
    {
      "SubjectType": "example",
      "SubjectId": "example",
      "EffectiveFrom": "2026-04-15T12:00:00Z",
      "EffectiveTo": "2026-04-15T12:00:00Z"
    }
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Reason": "example"
}

object

OperationKey

string format: uuid

Resource

object

ResourceModule

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

ResponsibilityKey

string

nullable

Subjects

Array<object>

nullable

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

RowVersion

string format: uuid

Reason

string

nullable

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Resource": {
    "ResourceModule": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "ResponsibilityKey": "example",
  "Subjects": [
    {
      "SubjectType": "example",
      "SubjectId": "example",
      "EffectiveFrom": "2026-04-15T12:00:00Z",
      "EffectiveTo": "2026-04-15T12:00:00Z"
    }
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Reason": "example"
}

object

OperationKey

string format: uuid

Resource

object

ResourceModule

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

ResponsibilityKey

string

nullable

Subjects

Array<object>

nullable

object

SubjectType

required

string

SubjectId

required

string

EffectiveFrom

required

string format: date-time

EffectiveTo

string format: date-time

nullable

RowVersion

string format: uuid

Reason

string

nullable

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Resource": {
    "ResourceModule": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "ResponsibilityKey": "example",
  "Subjects": [
    {
      "SubjectType": "example",
      "SubjectId": "example",
      "EffectiveFrom": "2026-04-15T12:00:00Z",
      "EffectiveTo": "2026-04-15T12:00:00Z"
    }
  ],
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Reason": "example"
}

Responses

200

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

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

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

Replace one common responsibility timeline for an Entity instance.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Example

404

Example

409

Example

Example^generated

Example^generated

Example^generated