Return catalog hierarchy designer metadata.
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/hierarchy-definition"), 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/hierarchy-definition';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/hierarchy-definition \ --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
Catalog hierarchy designer metadata.
object
Catalog definition identifier.
Catalog definition concurrency token.
Configured node types.
One configured node type in a catalog hierarchy definition.
object
Node type identifier.
Catalog definition identifier.
Stable node type key.
Node type display name.
Entity definition used by entity-backed node types.
Technical entity definition name.
Singular display name for the entity definition.
Plural display name for the entity definition.
Whether nodes of this type can be created at catalog root.
Primary field used for node title.
Optional field used for node subtitle.
Optional field used for node icon/type source.
Optional fixed type label.
Display order in the designer.
Concurrency token.
Configured containment rules.
One configured parent-child node type rule in a catalog hierarchy definition.
object
Containment rule identifier.
Catalog definition identifier.
Parent node type identifier.
Parent node type stable key.
Child node type identifier.
Child node type stable key.
Whether create is allowed for this containment pair.
Whether move is allowed for this containment pair.
Display order in the designer.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "SecurityMode": 0, "NodeTypes": [ { "BackingKind": 0, "UsageType": 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
Catalog hierarchy designer metadata.
object
Catalog definition identifier.
Catalog definition concurrency token.
Configured node types.
One configured node type in a catalog hierarchy definition.
object
Node type identifier.
Catalog definition identifier.
Stable node type key.
Node type display name.
Entity definition used by entity-backed node types.
Technical entity definition name.
Singular display name for the entity definition.
Plural display name for the entity definition.
Whether nodes of this type can be created at catalog root.
Primary field used for node title.
Optional field used for node subtitle.
Optional field used for node icon/type source.
Optional fixed type label.
Display order in the designer.
Concurrency token.
Configured containment rules.
One configured parent-child node type rule in a catalog hierarchy definition.
object
Containment rule identifier.
Catalog definition identifier.
Parent node type identifier.
Parent node type stable key.
Child node type identifier.
Child node type stable key.
Whether create is allowed for this containment pair.
Whether move is allowed for this containment pair.
Display order in the designer.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "SecurityMode": 0, "NodeTypes": [ { "BackingKind": 0, "UsageType": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}