Skip to content

List Object Operation Catalog entries applicable to one target context.

GET
/api/workspace/admin/business-invariants/operations
curl --request GET \
--url 'https://example.com/api/workspace/admin/business-invariants/operations?Mode=0' \
--header 'Authorization: Bearer <token>'
TargetModuleKey
string

Resource Catalog module key.

TargetResourceKind
string

Resource Catalog resource kind.

ContextResourceId
string

Concrete target context identifier.

SurfaceKey
string

Optional stable materialized-surface key.

Search
string

Optional safe text search over catalog documentation.

Mode

Selects whether the catalog returns currently applicable operations or the wider discoverable set used to validate a static invariant scope.

integer format: int32
Allowed values: 0 1

Applicable runtime query or descriptor scope-resolution query.

access_token
string

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

OK

Media typeapplication/json
object
Data
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": [
{
"Effect": 0,
"BackendEnforcement": 0
}
],
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data
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": [
{
"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"
}