Return entitlement context rows visible to the caller for one owner entity instance.

GET

/api/workspace/entitlement-operations/entity-instances/{entityDefinitionId}/{entityInstanceId}/context

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/entity-instances/example/example/context"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
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/entitlement-operations/entity-instances/example/example/context';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/api/workspace/entitlement-operations/entity-instances/example/example/context \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityDefinitionId

required

string

entityInstanceId

required

string

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

Object-centric Entitlement Operations context for one entity instance.

object

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

Items

Array<object>

nullable

Runtime entitlement summary row.

object

string

nullable

EntitlementNumber

integer format: int64

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

EntitlementPlanId

string

nullable

EntitlementPlanDisplayName

string

nullable

Owner

Compact customer-owned entity instance reference.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3 4 5 6

EffectiveState

integer format: int32

Allowed values: 0 1 2 3 4 5 6 8

StartsAtUtc

string format: date-time

EndsAtUtc

string format: date-time

nullable

GraceUntilUtc

string format: date-time

nullable

IssuedAtUtc

string format: date-time

IssuedByUserId

string

nullable

ResourceCount

integer format: int32

BeneficiaryCount

integer format: int32

PlanFamilies

Array<object>

nullable

Plan family reference shown on runtime entitlement rows.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object

Resource

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>

nullable

Current safe state of one Business Invariant target for one resource.

object

InvariantKey

Stable invariant key.

string

nullable

TargetKey

Stable target key within the invariant.

string

nullable

IsActive

Whether the invariant is active for the current resource state.

boolean

SafeMessage

Localized safe active-state message, or null when inactive.

string

nullable

Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object

key

additional properties

Composed current decision for one applicable object operation.

object

OperationKey

Stable Object Operation Catalog key.

string

nullable

IsAllowed

Whether all independent authorities allow the operation.

boolean

Denials

Deterministically ordered safe denial details.

Array<object>

nullable

One safe denial contributing to a composed object-operation decision.

object

Source

Identifies the independent authority that denied an object operation.

integer format: int32

Allowed values: 0 1 2 3

SourceKey

Stable source identity, such as an invariant key or domain policy key.

string

nullable

ReasonCode

Stable machine-readable reason code.

string

nullable

SafeMessage

Non-empty localized safe message.

string

nullable

RowVersion

string format: uuid

HasRestrictedItems

Whether the target has entitlements hidden by the caller’s entitlement model permissions.

boolean

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": {
    "Items": [
      {
        "ModelType": 0,
        "Status": 0,
        "EffectiveState": 0,
        "ObjectInvariant": {
          "Operations": {
            "additionalProperty": {
              "Denials": [
                {
                  "Source": 0
                }
              ]
            }
          }
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Object-centric Entitlement Operations context for one entity instance.

object

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

Items

Array<object>

nullable

Runtime entitlement summary row.

object

string

nullable

EntitlementNumber

integer format: int64

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

EntitlementPlanId

string

nullable

EntitlementPlanDisplayName

string

nullable

Owner

Compact customer-owned entity instance reference.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3 4 5 6

EffectiveState

integer format: int32

Allowed values: 0 1 2 3 4 5 6 8

StartsAtUtc

string format: date-time

EndsAtUtc

string format: date-time

nullable

GraceUntilUtc

string format: date-time

nullable

IssuedAtUtc

string format: date-time

IssuedByUserId

string

nullable

ResourceCount

integer format: int32

BeneficiaryCount

integer format: int32

PlanFamilies

Array<object>

nullable

Plan family reference shown on runtime entitlement rows.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object

Resource

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>

nullable

Current safe state of one Business Invariant target for one resource.

object

InvariantKey

Stable invariant key.

string

nullable

TargetKey

Stable target key within the invariant.

string

nullable

IsActive

Whether the invariant is active for the current resource state.

boolean

SafeMessage

Localized safe active-state message, or null when inactive.

string

nullable

Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object

key

additional properties

Composed current decision for one applicable object operation.

object

OperationKey

Stable Object Operation Catalog key.

string

nullable

IsAllowed

Whether all independent authorities allow the operation.

boolean

Denials

Deterministically ordered safe denial details.

Array<object>

nullable

One safe denial contributing to a composed object-operation decision.

object

Source

Identifies the independent authority that denied an object operation.

integer format: int32

Allowed values: 0 1 2 3

SourceKey

Stable source identity, such as an invariant key or domain policy key.

string

nullable

ReasonCode

Stable machine-readable reason code.

string

nullable

SafeMessage

Non-empty localized safe message.

string

nullable

RowVersion

string format: uuid

HasRestrictedItems

Whether the target has entitlements hidden by the caller’s entitlement model permissions.

boolean

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": {
    "Items": [
      {
        "ModelType": 0,
        "Status": 0,
        "EffectiveState": 0,
        "ObjectInvariant": {
          "Operations": {
            "additionalProperty": {
              "Denials": [
                {
                  "Source": 0
                }
              ]
            }
          }
        }
      }
    ]
  },
  "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-centric Entitlement Operations context for one entity instance.

object

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

Items

Array<object>

nullable

Runtime entitlement summary row.

object

string

nullable

EntitlementNumber

integer format: int64

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

EntitlementPlanId

string

nullable

EntitlementPlanDisplayName

string

nullable

Owner

Compact customer-owned entity instance reference.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3 4 5 6

EffectiveState

integer format: int32

Allowed values: 0 1 2 3 4 5 6 8

StartsAtUtc

string format: date-time

EndsAtUtc

string format: date-time

nullable

GraceUntilUtc

string format: date-time

nullable

IssuedAtUtc

string format: date-time

IssuedByUserId

string

nullable

ResourceCount

integer format: int32

BeneficiaryCount

integer format: int32

PlanFamilies

Array<object>

nullable

Plan family reference shown on runtime entitlement rows.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object

Resource

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>

nullable

Current safe state of one Business Invariant target for one resource.

object

InvariantKey

Stable invariant key.

string

nullable

TargetKey

Stable target key within the invariant.

string

nullable

IsActive

Whether the invariant is active for the current resource state.

boolean

SafeMessage

Localized safe active-state message, or null when inactive.

string

nullable

Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object

key

additional properties

Composed current decision for one applicable object operation.

object

OperationKey

Stable Object Operation Catalog key.

string

nullable

IsAllowed

Whether all independent authorities allow the operation.

boolean

Denials

Deterministically ordered safe denial details.

Array<object>

nullable

One safe denial contributing to a composed object-operation decision.

object

Source

Identifies the independent authority that denied an object operation.

integer format: int32

Allowed values: 0 1 2 3

SourceKey

Stable source identity, such as an invariant key or domain policy key.

string

nullable

ReasonCode

Stable machine-readable reason code.

string

nullable

SafeMessage

Non-empty localized safe message.

string

nullable

RowVersion

string format: uuid

HasRestrictedItems

Whether the target has entitlements hidden by the caller’s entitlement model permissions.

boolean

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": {
    "Items": [
      {
        "ModelType": 0,
        "Status": 0,
        "EffectiveState": 0,
        "ObjectInvariant": {
          "Operations": {
            "additionalProperty": {
              "Denials": [
                {
                  "Source": 0
                }
              ]
            }
          }
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Object-centric Entitlement Operations context for one entity instance.

object

EntityDefinitionId

string

nullable

EntityInstanceId

string

nullable

Items

Array<object>

nullable

Runtime entitlement summary row.

object

string

nullable

EntitlementNumber

integer format: int64

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

ModelType

integer format: int32

Allowed values: 0 1 2 3

EntitlementPlanId

string

nullable

EntitlementPlanDisplayName

string

nullable

Owner

Compact customer-owned entity instance reference.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

EntityInstanceId

string

nullable

DisplayName

string

nullable

Status

integer format: int32

Allowed values: 0 1 2 3 4 5 6

EffectiveState

integer format: int32

Allowed values: 0 1 2 3 4 5 6 8

StartsAtUtc

string format: date-time

EndsAtUtc

string format: date-time

nullable

GraceUntilUtc

string format: date-time

nullable

IssuedAtUtc

string format: date-time

IssuedByUserId

string

nullable

ResourceCount

integer format: int32

BeneficiaryCount

integer format: int32

PlanFamilies

Array<object>

nullable

Plan family reference shown on runtime entitlement rows.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object

Resource

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>

nullable

Current safe state of one Business Invariant target for one resource.

object

InvariantKey

Stable invariant key.

string

nullable

TargetKey

Stable target key within the invariant.

string

nullable

IsActive

Whether the invariant is active for the current resource state.

boolean

SafeMessage

Localized safe active-state message, or null when inactive.

string

nullable

Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object

key

additional properties

Composed current decision for one applicable object operation.

object

OperationKey

Stable Object Operation Catalog key.

string

nullable

IsAllowed

Whether all independent authorities allow the operation.

boolean

Denials

Deterministically ordered safe denial details.

Array<object>

nullable

One safe denial contributing to a composed object-operation decision.

object

Source

Identifies the independent authority that denied an object operation.

integer format: int32

Allowed values: 0 1 2 3

SourceKey

Stable source identity, such as an invariant key or domain policy key.

string

nullable

ReasonCode

Stable machine-readable reason code.

string

nullable

SafeMessage

Non-empty localized safe message.

string

nullable

RowVersion

string format: uuid

HasRestrictedItems

Whether the target has entitlements hidden by the caller’s entitlement model permissions.

boolean

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": {
    "Items": [
      {
        "ModelType": 0,
        "Status": 0,
        "EffectiveState": 0,
        "ObjectInvariant": {
          "Operations": {
            "additionalProperty": {
              "Denials": [
                {
                  "Source": 0
                }
              ]
            }
          }
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Return entitlement context rows visible to the caller for one owner entity instance.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated