Return one catalog definition.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/catalogs/example"), Headers = { { "Authorization", "Bearer <token>" }, },};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/catalogs/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/catalogs/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Full catalog definition detail for admin editing.
object
Catalog definition identifier.
Stable catalog key.
Catalog display name.
Optional free-form description.
Roles allowed to read and administer the catalog tree at runtime.
One role allowed to administer root catalog folders at runtime.
object
Role identifier.
Role display name.
Roles allowed to read the catalog at runtime.
One role allowed to read a catalog at runtime.
object
Role identifier.
Role display name.
Number of entity definitions admitted into the catalog.
Entity definitions admitted into the catalog.
One entity definition admitted into a catalog definition.
object
Catalog target identifier.
Catalog definition identifier.
Entity definition identifier.
Entity definition technical name.
Entity definition singular display name.
Entity definition plural display name.
Configured compact list projection fields.
One configured compact list projection field for a catalog target.
object
Catalog target list field identifier.
Provider or entity field key.
Default display name.
Optional target-specific display name.
Display order.
Concurrency token.
Display order in the catalog definition.
Concurrency token.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "SecurityMode": 0, "Targets": [ { "UsageType": 0, "ListFields": [ { "SourceKind": 0, "ValueType": 0 } ] } ] }, "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
Full catalog definition detail for admin editing.
object
Catalog definition identifier.
Stable catalog key.
Catalog display name.
Optional free-form description.
Roles allowed to read and administer the catalog tree at runtime.
One role allowed to administer root catalog folders at runtime.
object
Role identifier.
Role display name.
Roles allowed to read the catalog at runtime.
One role allowed to read a catalog at runtime.
object
Role identifier.
Role display name.
Number of entity definitions admitted into the catalog.
Entity definitions admitted into the catalog.
One entity definition admitted into a catalog definition.
object
Catalog target identifier.
Catalog definition identifier.
Entity definition identifier.
Entity definition technical name.
Entity definition singular display name.
Entity definition plural display name.
Configured compact list projection fields.
One configured compact list projection field for a catalog target.
object
Catalog target list field identifier.
Provider or entity field key.
Default display name.
Optional target-specific display name.
Display order.
Concurrency token.
Display order in the catalog definition.
Concurrency token.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "SecurityMode": 0, "Targets": [ { "UsageType": 0, "ListFields": [ { "SourceKind": 0, "ValueType": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}