Skip to content

Disable one target-context metadata record.

POST
/api/workspace/admin/business-invariants/metadata/{id}/disable
curl --request POST \
--url https://example.com/api/workspace/admin/business-invariants/metadata/example/disable \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
id
required
string
access_token
string

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

Enables or disables one Business Invariant metadata record with optimistic concurrency.

object
RowVersion

Required current optimistic concurrency token.

string format: uuid
Examplegenerated
{
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

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

Bad Request

Media typeapplication/json
object
Data

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

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

Not Found

Media typeapplication/json
object
Data

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

Conflict

Media typeapplication/json
object
Data

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