Create or update target-context metadata. New metadata is always disabled.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://example.com/api/workspace/admin/business-invariants/metadata"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Id\": \"example\", \"InvariantKey\": \"example\", \"TargetKey\": \"example\", \"TargetModuleKey\": \"example\", \"TargetResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"Parameters\": \"example\", \"DisplayNameTranslations\": { \"additionalProperty\": \"example\" }, \"DescriptionTranslations\": { \"additionalProperty\": \"example\" }, \"DefaultMessageTranslations\": { \"additionalProperty\": \"example\" }, \"DenialMessageTranslations\": { \"additionalProperty\": { \"additionalProperty\": \"example\" } }, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }") { 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/business-invariants/metadata';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Id":"example","InvariantKey":"example","TargetKey":"example","TargetModuleKey":"example","TargetResourceKind":"example","ContextResourceId":"example","Parameters":"example","DisplayNameTranslations":{"additionalProperty":"example"},"DescriptionTranslations":{"additionalProperty":"example"},"DefaultMessageTranslations":{"additionalProperty":"example"},"DenialMessageTranslations":{"additionalProperty":{"additionalProperty":"example"}},"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/workspace/admin/business-invariants/metadata \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Id": "example", "InvariantKey": "example", "TargetKey": "example", "TargetModuleKey": "example", "TargetResourceKind": "example", "ContextResourceId": "example", "Parameters": "example", "DisplayNameTranslations": { "additionalProperty": "example" }, "DescriptionTranslations": { "additionalProperty": "example" }, "DefaultMessageTranslations": { "additionalProperty": "example" }, "DenialMessageTranslations": { "additionalProperty": { "additionalProperty": "example" } }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Creates or updates metadata for one discovered invariant target and concrete target context.
object
Existing metadata identifier, or null when creating metadata.
Stable discovered invariant key.
Stable discovered target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
Parameters validated against the discovered target schema. Integer and number values use invariant-culture JSON strings in this administration contract so Int64 and Decimal values remain exact across browser transport.
Optional workspace display-name overrides keyed by locale.
object
Optional workspace description overrides keyed by locale.
object
Optional workspace active-state message overrides keyed by locale.
object
Optional denial-message overrides keyed first by reason code and then locale.
object
object
Required current optimistic concurrency token when updating.
Examplegenerated
{ "Id": "example", "InvariantKey": "example", "TargetKey": "example", "TargetModuleKey": "example", "TargetResourceKind": "example", "ContextResourceId": "example", "Parameters": "example", "DisplayNameTranslations": { "additionalProperty": "example" }, "DescriptionTranslations": { "additionalProperty": "example" }, "DefaultMessageTranslations": { "additionalProperty": "example" }, "DenialMessageTranslations": { "additionalProperty": { "additionalProperty": "example" } }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Creates or updates metadata for one discovered invariant target and concrete target context.
object
Existing metadata identifier, or null when creating metadata.
Stable discovered invariant key.
Stable discovered target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
Parameters validated against the discovered target schema. Integer and number values use invariant-culture JSON strings in this administration contract so Int64 and Decimal values remain exact across browser transport.
Optional workspace display-name overrides keyed by locale.
object
Optional workspace description overrides keyed by locale.
object
Optional workspace active-state message overrides keyed by locale.
object
Optional denial-message overrides keyed first by reason code and then locale.
object
object
Required current optimistic concurrency token when updating.
Examplegenerated
{ "Id": "example", "InvariantKey": "example", "TargetKey": "example", "TargetModuleKey": "example", "TargetResourceKind": "example", "ContextResourceId": "example", "Parameters": "example", "DisplayNameTranslations": { "additionalProperty": "example" }, "DescriptionTranslations": { "additionalProperty": "example" }, "DefaultMessageTranslations": { "additionalProperty": "example" }, "DenialMessageTranslations": { "additionalProperty": { "additionalProperty": "example" } }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Creates or updates metadata for one discovered invariant target and concrete target context.
object
Existing metadata identifier, or null when creating metadata.
Stable discovered invariant key.
Stable discovered target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
Parameters validated against the discovered target schema. Integer and number values use invariant-culture JSON strings in this administration contract so Int64 and Decimal values remain exact across browser transport.
Optional workspace display-name overrides keyed by locale.
object
Optional workspace description overrides keyed by locale.
object
Optional workspace active-state message overrides keyed by locale.
object
Optional denial-message overrides keyed first by reason code and then locale.
object
object
Required current optimistic concurrency token when updating.
Examplegenerated
{ "Id": "example", "InvariantKey": "example", "TargetKey": "example", "TargetModuleKey": "example", "TargetResourceKind": "example", "ContextResourceId": "example", "Parameters": "example", "DisplayNameTranslations": { "additionalProperty": "example" }, "DescriptionTranslations": { "additionalProperty": "example" }, "DefaultMessageTranslations": { "additionalProperty": "example" }, "DenialMessageTranslations": { "additionalProperty": { "additionalProperty": "example" } }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “Responses”OK
object
Current persisted configuration for one discovered invariant target and concrete target context.
object
Metadata identifier.
Stable invariant key.
Stable invariant target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
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.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Declared denial reasons and safe-message text.
Declared Business Invariant denial reason and its localized text.
object
Stable invariant-owned reason code.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Current exact scope resolved through the Object Operation Catalog.
Whether live evaluation is enabled.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Current persisted configuration for one discovered invariant target and concrete target context.
object
Metadata identifier.
Stable invariant key.
Stable invariant target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
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.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Declared denial reasons and safe-message text.
Declared Business Invariant denial reason and its localized text.
object
Stable invariant-owned reason code.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Current exact scope resolved through the Object Operation Catalog.
Whether live evaluation is enabled.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Current persisted configuration for one discovered invariant target and concrete target context.
object
Metadata identifier.
Stable invariant key.
Stable invariant target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
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.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Declared denial reasons and safe-message text.
Declared Business Invariant denial reason and its localized text.
object
Stable invariant-owned reason code.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Current exact scope resolved through the Object Operation Catalog.
Whether live evaluation is enabled.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Current persisted configuration for one discovered invariant target and concrete target context.
object
Metadata identifier.
Stable invariant key.
Stable invariant target key.
Resource Catalog module key.
Resource Catalog resource kind.
Concrete target context identifier.
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.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Declared denial reasons and safe-message text.
Declared Business Invariant denial reason and its localized text.
object
Stable invariant-owned reason code.
Source, workspace, and effective translations for one metadata text family.
object
Source-owned translations keyed by supported locale.
object
Optional workspace overrides keyed by supported locale.
object
Resolved translations keyed by supported locale.
object
Current exact scope resolved through the Object Operation Catalog.
Whether live evaluation is enabled.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}