Return the error catalog of this installation.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/error-catalog"), 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/error-catalog';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/error-catalog \ --header 'Authorization: Bearer <token>'Any active workspace user may read it, including a Service user with a valid API key; no administrative role is
needed. The catalog is curated and partial: an answer can carry a code it does not list, and the fallbacks of
each covered surface say how to treat one. It holds product definitions only, is the same in every workspace
locale and has English descriptions. When comparing installations, compare Revision,
ProductVersion and BuildId together with the API base URL that answered.
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.
Responses
Section titled “Responses”OK
object
Machine-readable description of the errors this installation answers on the covered API surfaces: what each code means there, its HTTP status and Field, and the safe client reaction. The catalog is curated and partial: an answer can carry a code it does not list, and Moltaro.ErrorCatalog.Models.ErrorCatalogSurfaceCoverageModel.Fallbacks says how to treat one.
object
Version of this catalog format; it changes only with an incompatible change. New members and new enum values keep the version: ignore members you do not recognize, and read each enum’s description for values you do not recognize.
Opaque, deterministic identifier of the catalog content (schema version, coverage and entries); equal content has an equal revision on every installation and build. Compare it for equality only.
Product release of the answering API runtime, as in the agent integration manifest. Null for a source build without package identity.
Opaque package build identity of the answering API runtime. Null for a source build without package identity.
What the catalog covers.
object
English statement of the covered scope and its limits.
Covered surfaces with their operations, HTTP status rules and fallbacks.
One covered surface.
object
API surface whose answers a catalog entry describes. Later catalogs can add surfaces: skip the entries and the coverage of a surface you do not recognize.
English description of the surface.
Covered operations of the surface.
HTTP statuses in precedence order: an answer with several errors has the first of these statuses that one of its codes has.
HTTP status of an error answer none of whose codes has a status in Moltaro.ErrorCatalog.Models.ErrorCatalogSurfaceCoverageModel.StatusPrecedence.
Reactions to answers of the surface that no entry describes, one per answer kind.
The reaction to one kind of answer that no entry describes.
object
Kind of answer a catalog fallback applies to. Later catalogs can add kinds: ignore a fallback whose kind you do not recognize, and treat an answer that fits none of the kinds you recognize as UnlistedAnswer (0).
English description of the answers of this kind.
Safe client reaction to an answer.
object
What an answer establishes about the operation the request asked for. Later catalogs can add outcomes: treat one you do not recognize like Unknown (0).
Recommended client reaction. Later catalogs can add actions: treat one you do not recognize like SettleOutcome (0).
Whether a client may repeat the request without a new decision. Later catalogs can add values: treat one you do not recognize like None (0).
English conditions that apply to the reaction, each one checkable by the client.
English explanation of the reaction.
Entries ordered by surface, code and first operation. A code can have several entries on one surface when it means something different for some operations; look an entry up by code, surface and operation, which match at most one entry.
One error code as a surface answers it.
object
Exact error code, compared ordinally.
API surface whose answers a catalog entry describes. Later catalogs can add surfaces: skip the entries and the coverage of a surface you do not recognize.
Operations of the surface that can answer with this code.
HTTP status of an answer whose only error has this code; Moltaro.ErrorCatalog.Models.ErrorCatalogSurfaceCoverageModel.StatusPrecedence decides between several errors.
English description of the cause.
Rule for the Field of an error.
object
What the error’s Field contains. Later catalogs can add kinds: for a kind you do not recognize, show Field
but do not rely on its value.
Every request member path Field can name for Moltaro.ErrorCatalog.Models.ErrorCatalogFieldKindEnum.RequestMember and Moltaro.ErrorCatalog.Models.ErrorCatalogFieldKindEnum.RequestMemberOrNone; empty for the other kinds.
Metadata keys the error can carry; empty when it carries none. Values are strings.
One metadata key an error can carry.
object
Exact metadata key.
English meaning and format of the value.
Safe client reaction to an answer.
object
What an answer establishes about the operation the request asked for. Later catalogs can add outcomes: treat one you do not recognize like Unknown (0).
Recommended client reaction. Later catalogs can add actions: treat one you do not recognize like SettleOutcome (0).
Whether a client may repeat the request without a new decision. Later catalogs can add values: treat one you do not recognize like None (0).
English conditions that apply to the reaction, each one checkable by the client.
English explanation of the reaction.
object
object
object
object
Example
{ "Data": { "Coverage": { "Surfaces": [ { "Surface": 0, "Operations": [ 0 ], "Fallbacks": [ { "Answer": 0, "Reaction": { "Outcome": 0, "Action": 0, "AutomaticRetry": 0 } } ] } ] }, "Entries": [ { "Surface": 0, "Operations": [ 0 ], "Field": { "Kind": 0 }, "Reaction": { "Outcome": 0, "Action": 0, "AutomaticRetry": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Unauthorized
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}