Atomically creates or replaces one Assignment Rule per selected assignment actor.

POST

/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/assignment-rules/apply

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/security/assignment-rules/apply"),
    Content = new StringContent("{ \"OperationKey\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ReplacedRuleKeys\": [ \"example\" ], \"Rules\": [ { \"Key\": \"example\", \"ResponsibilityKey\": \"example\", \"ActorSelectorType\": \"example\", \"ActorSelectorKey\": \"example\", \"Actions\": [ \"example\" ], \"EligibleTargets\": [ { \"SelectorType\": \"example\", \"SelectorKey\": \"example\" } ], \"Enabled\": true } ] }")
    {
        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/admin/entity-definitions/example/security/assignment-rules/apply';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"OperationKey":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ReplacedRuleKeys":["example"],"Rules":[{"Key":"example","ResponsibilityKey":"example","ActorSelectorType":"example","ActorSelectorKey":"example","Actions":["example"],"EligibleTargets":[{"SelectorType":"example","SelectorKey":"example"}],"Enabled":true}]}'
};

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/admin/entity-definitions/example/security/assignment-rules/apply \
  --header 'Content-Type: application/json' \
  --data '{ "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ReplacedRuleKeys": [ "example" ], "Rules": [ { "Key": "example", "ResponsibilityKey": "example", "ActorSelectorType": "example", "ActorSelectorKey": "example", "Actions": [ "example" ], "EligibleTargets": [ { "SelectorType": "example", "SelectorKey": "example" } ], "Enabled": true } ] }'

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

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^required

Atomically replaces zero or more responsibility Assignment Rules with one rule per selected assignment actor.

object

OperationKey

required

string format: uuid

RowVersion

required

string format: uuid

ReplacedRuleKeys

required

Array<string>

Rules

required

Array<object>

Defines one responsibility assignment rule inside an atomic rule-set change.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ReplacedRuleKeys": [
    "example"
  ],
  "Rules": [
    {
      "Key": "example",
      "ResponsibilityKey": "example",
      "ActorSelectorType": "example",
      "ActorSelectorKey": "example",
      "Actions": [
        "example"
      ],
      "EligibleTargets": [
        {
          "SelectorType": "example",
          "SelectorKey": "example"
        }
      ],
      "Enabled": true
    }
  ]
}

Atomically replaces zero or more responsibility Assignment Rules with one rule per selected assignment actor.

object

OperationKey

required

string format: uuid

RowVersion

required

string format: uuid

ReplacedRuleKeys

required

Array<string>

Rules

required

Array<object>

Defines one responsibility assignment rule inside an atomic rule-set change.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ReplacedRuleKeys": [
    "example"
  ],
  "Rules": [
    {
      "Key": "example",
      "ResponsibilityKey": "example",
      "ActorSelectorType": "example",
      "ActorSelectorKey": "example",
      "Actions": [
        "example"
      ],
      "EligibleTargets": [
        {
          "SelectorType": "example",
          "SelectorKey": "example"
        }
      ],
      "Enabled": true
    }
  ]
}

Atomically replaces zero or more responsibility Assignment Rules with one rule per selected assignment actor.

object

OperationKey

required

string format: uuid

RowVersion

required

string format: uuid

ReplacedRuleKeys

required

Array<string>

Rules

required

Array<object>

Defines one responsibility assignment rule inside an atomic rule-set change.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

Example^generated

{
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ReplacedRuleKeys": [
    "example"
  ],
  "Rules": [
    {
      "Key": "example",
      "ResponsibilityKey": "example",
      "ActorSelectorType": "example",
      "ActorSelectorKey": "example",
      "Actions": [
        "example"
      ],
      "EligibleTargets": [
        {
          "SelectorType": "example",
          "SelectorKey": "example"
        }
      ],
      "Enabled": true
    }
  ]
}

Responses

200

application/json

object

Data

Returns the current concurrency token after deleting an artifact.

object

RowVersion

required

string format: uuid

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

Returns the current concurrency token after deleting an artifact.

object

RowVersion

required

string format: uuid

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

401

Unauthorized

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

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

Returns the current concurrency token after deleting an artifact.

object

RowVersion

required

string format: uuid

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

Returns the current concurrency token after deleting an artifact.

object

RowVersion

required

string format: uuid

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

Atomically creates or replaces one Assignment Rule per selected assignment actor.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

401

Examplegenerated

403

Examplegenerated

404

Example

409

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated