Skip to content

Get discovered invariants, persisted metadata, and applicable operations for one concrete target context.

POST
/api/workspace/admin/business-invariants/context
curl --request POST \
--url https://example.com/api/workspace/admin/business-invariants/context \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "TargetModuleKey": "example", "TargetResourceKind": "example", "ContextResourceId": "example" }'
access_token
string

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

Requests administration context for one concrete resource-family target.

object
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
ContextResourceId

Concrete target context identifier.

string
nullable
Examplegenerated
{
"TargetModuleKey": "example",
"TargetResourceKind": "example",
"ContextResourceId": "example"
}

OK

Media typeapplication/json
object
Data

Administration context for one concrete resource-family target.

object
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
ContextResourceId

Concrete target context identifier.

string
nullable
CatalogItems

Compatible discovered invariant descriptors.

Array<object>
nullable

One discovered Business Invariant descriptor returned by administration catalog search.

object
InvariantKey

Stable invariant key.

string
nullable
SourceKind

Stable source kind.

string
nullable
SourceId

Stable source identifier.

string
nullable
SourceVersion

Source artifact or product version.

string
nullable
DisplayName

Effective localized display name.

string
nullable
Description

Effective localized description.

string
nullable
DefaultMessage

Effective localized active-state message.

string
nullable
TargetKeys

Declared stable target keys.

Array<string>
nullable
IsSourceAvailable

Whether the descriptor source is currently available.

boolean
IsCompatible

Whether the descriptor is compatible with the current workspace.

boolean
Targets

Machine-readable target and parameter-schema descriptors.

Array<object>
nullable

One discovered target descriptor exposed by the administration catalog.

object
TargetKey
string
nullable
TargetModuleKey
string
nullable
TargetResourceKind
string
nullable
ContextResourceId
string
nullable
ParameterSchema

Versioned code-described target parameter schema.

object
Version
integer format: int32
ClrTypeName
string
nullable
Fields
Array<object>
nullable

One supported target parameter field.

object
Key
string
nullable
ClrTypeName
string
nullable
JsonType
string
nullable
IsRequired
boolean
IsArray
boolean
AllowedValues
Array<string>
nullable
ExactOperationKeys
Array<string>
nullable
AffectsMutations
boolean
OperationScopeExceptions
Array<string>
nullable
DenialMessages

Source-owned denial reasons and their localized messages.

Array<object>
nullable

Declared Business Invariant denial reason and its localized text.

object
ReasonCode

Stable invariant-owned reason code.

string
nullable
Message

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
Metadata

Existing target metadata.

Array<object>
nullable

Current persisted configuration for one discovered invariant target and concrete target context.

object
Id

Metadata identifier.

string
nullable
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable invariant target key.

string
nullable
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
ContextResourceId

Concrete target context identifier.

string
nullable
Parameters

Validated target parameters for administration editing. Integer and number values are returned as invariant-culture JSON strings so Int64 and Decimal values remain exact in browser clients.

DisplayName

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
Description

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
DefaultMessage

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
DenialMessages

Declared denial reasons and safe-message text.

Array<object>
nullable

Declared Business Invariant denial reason and its localized text.

object
ReasonCode

Stable invariant-owned reason code.

string
nullable
Message

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
ResolvedPotentialOperationKeys

Current exact scope resolved through the Object Operation Catalog.

Array<string>
nullable
IsEnabled

Whether live evaluation is enabled.

boolean
IsSourceAvailable

Whether the descriptor source is currently available.

boolean
IsCompatible

Whether the descriptor is compatible with the current workspace.

boolean
RowVersion

Optimistic concurrency token.

string format: uuid
Operations

Current applicable Object Operation Catalog entries.

Array<object>
nullable

Public machine-readable Object Operation Catalog entry.

object
OperationKey

Stable built-in key or exact function.{BusinessFunction.Key} projection.

string
nullable
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
TargetContextRules

Stable context-rule keys used to resolve applicability.

Array<string>
nullable
Effect

Static effect classification owned by the Object Operation Catalog.

integer format: int32
Allowed values: 0 1
DisplayName

Localized display name.

string
nullable
Description

Localized operation description.

string
nullable
BackendEnforcementOwner

Authoritative backend guard owner.

string
nullable
BackendEnforcement

Declares how an Object Operation Catalog entry is enforced by its backend owner.

integer format: int32
Allowed values: 0 1
BackendEnforcementSemantics

Safe documentation of the authoritative enforcement boundary.

string
nullable
Provider

Stable provenance and version metadata for one Object Operation Catalog provider.

object
ProviderKey

Stable provider key.

string
nullable
Origin

Product, module, package, or runtime origin.

string
nullable
Version

Positive provider contract version.

integer format: int32
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": {
"Operations": [
{
"Effect": 0,
"BackendEnforcement": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Administration context for one concrete resource-family target.

object
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
ContextResourceId

Concrete target context identifier.

string
nullable
CatalogItems

Compatible discovered invariant descriptors.

Array<object>
nullable

One discovered Business Invariant descriptor returned by administration catalog search.

object
InvariantKey

Stable invariant key.

string
nullable
SourceKind

Stable source kind.

string
nullable
SourceId

Stable source identifier.

string
nullable
SourceVersion

Source artifact or product version.

string
nullable
DisplayName

Effective localized display name.

string
nullable
Description

Effective localized description.

string
nullable
DefaultMessage

Effective localized active-state message.

string
nullable
TargetKeys

Declared stable target keys.

Array<string>
nullable
IsSourceAvailable

Whether the descriptor source is currently available.

boolean
IsCompatible

Whether the descriptor is compatible with the current workspace.

boolean
Targets

Machine-readable target and parameter-schema descriptors.

Array<object>
nullable

One discovered target descriptor exposed by the administration catalog.

object
TargetKey
string
nullable
TargetModuleKey
string
nullable
TargetResourceKind
string
nullable
ContextResourceId
string
nullable
ParameterSchema

Versioned code-described target parameter schema.

object
Version
integer format: int32
ClrTypeName
string
nullable
Fields
Array<object>
nullable

One supported target parameter field.

object
Key
string
nullable
ClrTypeName
string
nullable
JsonType
string
nullable
IsRequired
boolean
IsArray
boolean
AllowedValues
Array<string>
nullable
ExactOperationKeys
Array<string>
nullable
AffectsMutations
boolean
OperationScopeExceptions
Array<string>
nullable
DenialMessages

Source-owned denial reasons and their localized messages.

Array<object>
nullable

Declared Business Invariant denial reason and its localized text.

object
ReasonCode

Stable invariant-owned reason code.

string
nullable
Message

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
Metadata

Existing target metadata.

Array<object>
nullable

Current persisted configuration for one discovered invariant target and concrete target context.

object
Id

Metadata identifier.

string
nullable
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable invariant target key.

string
nullable
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
ContextResourceId

Concrete target context identifier.

string
nullable
Parameters

Validated target parameters for administration editing. Integer and number values are returned as invariant-culture JSON strings so Int64 and Decimal values remain exact in browser clients.

DisplayName

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
Description

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
DefaultMessage

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
DenialMessages

Declared denial reasons and safe-message text.

Array<object>
nullable

Declared Business Invariant denial reason and its localized text.

object
ReasonCode

Stable invariant-owned reason code.

string
nullable
Message

Source, workspace, and effective translations for one metadata text family.

object
SourceTranslations

Source-owned translations keyed by supported locale.

object
key
additional properties
string
WorkspaceTranslations

Optional workspace overrides keyed by supported locale.

object
key
additional properties
string
EffectiveTranslations

Resolved translations keyed by supported locale.

object
key
additional properties
string
ResolvedPotentialOperationKeys

Current exact scope resolved through the Object Operation Catalog.

Array<string>
nullable
IsEnabled

Whether live evaluation is enabled.

boolean
IsSourceAvailable

Whether the descriptor source is currently available.

boolean
IsCompatible

Whether the descriptor is compatible with the current workspace.

boolean
RowVersion

Optimistic concurrency token.

string format: uuid
Operations

Current applicable Object Operation Catalog entries.

Array<object>
nullable

Public machine-readable Object Operation Catalog entry.

object
OperationKey

Stable built-in key or exact function.{BusinessFunction.Key} projection.

string
nullable
TargetModuleKey

Resource Catalog module key.

string
nullable
TargetResourceKind

Resource Catalog resource kind.

string
nullable
TargetContextRules

Stable context-rule keys used to resolve applicability.

Array<string>
nullable
Effect

Static effect classification owned by the Object Operation Catalog.

integer format: int32
Allowed values: 0 1
DisplayName

Localized display name.

string
nullable
Description

Localized operation description.

string
nullable
BackendEnforcementOwner

Authoritative backend guard owner.

string
nullable
BackendEnforcement

Declares how an Object Operation Catalog entry is enforced by its backend owner.

integer format: int32
Allowed values: 0 1
BackendEnforcementSemantics

Safe documentation of the authoritative enforcement boundary.

string
nullable
Provider

Stable provenance and version metadata for one Object Operation Catalog provider.

object
ProviderKey

Stable provider key.

string
nullable
Origin

Product, module, package, or runtime origin.

string
nullable
Version

Positive provider contract version.

integer format: int32
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": {
"Operations": [
{
"Effect": 0,
"BackendEnforcement": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}