Search the currently discovered Business Invariant catalog.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/business-invariants/catalog/search"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Search\": \"example\", \"SourceKind\": \"example\", \"Page\": 1, \"PageSize\": 1 }") { 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/catalog/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Search":"example","SourceKind":"example","Page":1,"PageSize":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/business-invariants/catalog/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Search": "example", "SourceKind": "example", "Page": 1, "PageSize": 1 }'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”Search request for the discovered Business Invariant catalog.
object
Optional text search over safe catalog metadata.
Optional stable source-kind filter.
One-based page number.
Bounded page size.
Examplegenerated
{ "Search": "example", "SourceKind": "example", "Page": 1, "PageSize": 1}Search request for the discovered Business Invariant catalog.
object
Optional text search over safe catalog metadata.
Optional stable source-kind filter.
One-based page number.
Bounded page size.
Examplegenerated
{ "Search": "example", "SourceKind": "example", "Page": 1, "PageSize": 1}Search request for the discovered Business Invariant catalog.
object
Optional text search over safe catalog metadata.
Optional stable source-kind filter.
One-based page number.
Bounded page size.
Examplegenerated
{ "Search": "example", "SourceKind": "example", "Page": 1, "PageSize": 1}Responses
Section titled “Responses”OK
object
Paged Business Invariant administration catalog result.
object
Catalog items in deterministic order.
One discovered Business Invariant descriptor returned by administration catalog search.
object
Stable invariant key.
Stable source kind.
Stable source identifier.
Source artifact or product version.
Effective localized display name.
Effective localized description.
Effective localized active-state message.
Declared stable target keys.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Machine-readable target and parameter-schema descriptors.
One discovered target descriptor exposed by the administration catalog.
object
Versioned code-described target parameter schema.
object
One supported target parameter field.
object
Source-owned denial reasons and their localized messages.
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
Total matching descriptor count.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Paged Business Invariant administration catalog result.
object
Catalog items in deterministic order.
One discovered Business Invariant descriptor returned by administration catalog search.
object
Stable invariant key.
Stable source kind.
Stable source identifier.
Source artifact or product version.
Effective localized display name.
Effective localized description.
Effective localized active-state message.
Declared stable target keys.
Whether the descriptor source is currently available.
Whether the descriptor is compatible with the current workspace.
Machine-readable target and parameter-schema descriptors.
One discovered target descriptor exposed by the administration catalog.
object
Versioned code-described target parameter schema.
object
One supported target parameter field.
object
Source-owned denial reasons and their localized messages.
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
Total matching descriptor count.
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"}