---
id: catalog-specification-read
title: "Read a catalog specification"
description: "Reads a catalog specification for an entity."
sidebar_label: "Read a catalog specification"
hide_title: true
hide_table_of_contents: true
api: eJztV21v2zYQ/ivEYR+SVXGSLilaAUWR9WVLsbpBXrYCSRacxbPNRiJVksrqOfrvw5GyLTlK2xXF9qWfLJO8t+ce3h3nYEqy6JXRhxJSyNBjbiZXrqRMjVUWdlJLKCEBjxMH6Tk8j4dE5xBcJiDJZVaV4W8Kx4TSCRRZ33ExNlagFqS98rMBJFCixYI8WbYxB5dNqUBI5+CVzwlSOAw+zEr+dt4qPYEExsYW6CGFqlK833XhTKsPFYnDF8Gcn1JjLxFKi7OzuF6gH0CdgGKJEv0UEtBYsJmg0tKHSlmSkHpb0edN9MY7gPoyAUdZZZWfhQhHhJbsQeWnkJ5f8rYlVxrtyHHYD9+945+utbej95R5Yam05DgWPfk0wkJXeV7m6DnQJnpIIDPak/ZsAMsyb0S23zu20gf+G/Io0eNJJ+fLfJjgF2fRMqG8ijEo+V8mMCZtfsdEofRvpCeM8+66gV4uC9aUBJP0EYsyp1T8XKlciufmhixOKBEHK9jEK2buX8Zeu6Q593uVa7I4UrliLKJ7VrfRGB4Pe+Ao0Xvig/CnsRPU6u9g4unGxYV8cHtx8ePmg41naYpZZirtW8ubz3idHXclZnRnp5XmO3sbI3b61mWmpFtLOaGjW3SO/K2kMjezgrTf7Ij9cCdVwzbRjsmZymYkhliQ2BgeDzfXSTtVZNFmU5VhLpTk9bEiG1DvkNY2uiKKDYV70tx15wgtad/QRfgpejE1uXSiaJgslI7cCbeTFVcFV7c27JBAg3RTEwK2vLpCExII8PEqQwYJBCBD5QhQBt8WMEIClSMLl3UCC1f6omEIcMRMiVXnUyR+GYNcRnZNszX2ZkvejltcvelhaUfzt7hLrTPBQKu2rNUOSWOsci5K637cozqqGog3lfNiRALFDeZKitcnb4fiJG5CfUfZtyqiDbqLQge7P+3t7+3hoy3cefxka++nEW49kfsPt/ZHj+gR7Y3xsdxd9Zbhgk4i9NV1Jw+kDBsCHedz6wbzikTESngjlmyM/nDBbUpMh8FPd2F1ZzoUXpEPGgfuz0y3qhezq8iHq2a99zp6nETuMtFnV7oqRmT7JOJOO/87jTTLZZXzprjyOLkKwEVt0bM+bff7rMl5kp/wua6ZK6t2f94X6WUCKKVibDE/atkYY+6orqOSvb7m/SqUm0CpDvfIWmOdkBVbEgdHh0JpTxYzlnNf061fssbPdmfn0VfuuZHUn42277+enh6JKCAyI0koLYMfehLbcrBYs6+ytwn39vUgFfVFVMZkSWckUEu+kDQxdlGKufYHI59VfjI11idiWhWot3h25Tra2GJJwTaj8lngEzmHky/w+gV5VDnJRlcjJ0prbpQMVWTJDBFy9tH3lJ+vpkGbma3cLXBZBXIZSbj/nYTfSfj/kjAOOVPD7XESZqPwwEphe9F+lh/dN+f2XMmaexLZm8WTsLI5pDD1vnTp9jaWatDuy4PMFJ1HVhgAIsnaT60lvqxo0fX4fzzE41z4eLV4mLz+4zQAyPNim9/NTAIJsIcR1p3B7mCH01ka5wsMN6Pp9/wcvm/MWE/yfHXb/u0zugmO075d5qgCZwNy8wb781XrX00BV+v+pEpyr5sa51lkPh+hozOb1zUvf6jI8iv2MoEbtCoOqudzkMrxt2za4SfC2jhuiLQpvvgJfU90zSJqHsrCnAQpQALXNItv+JqH7SmhJBu8jBsHWUalb4ncKWvMpiV9f3l5yiN+l0NrnAnae92Zz+OJU3NNuq6X3nn+zw7W9T8/JCid
sidebar_class_name: "get api-method"
info_path: docs/api/catalog
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read a catalog specification"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/metadata/metadata_specification/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Reads a catalog specification for an entity.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique ID for the entity, in UUID format."},"in":"path","name":"id","required":true,"description":"Unique ID for the catalog specification."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a catalog specification for a nullplatform entity","content":{"application/json":{"schema":{"title":"MetadataSpecification","type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique ID for the entity, in UUID format."},"name":{"type":"string","minLength":1,"description":"Catalog specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities."},"nrn":{"title":"NRN","type":"string","pattern":"^organization=(\\d+|\\*)+(?::account=(\\d+|\\*))?(?::namespace=(\\d+|\\*))?(?::application=(\\d+|\\*))?(?::(build|scope|release|asset|deployment)=(\\d+|\\*))?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources."},"entity":{"type":"string","description":"Parent entity that holds metadata information.","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"metadata":{"type":"string","nullable":true,"minLength":1,"description":"Entity metadata key, for example: coverage, frameworks, vulnerabilities."},"description":{"type":"string","minLength":1,"description":"Catalog specification description."},"schema":{"type":"object","default":{},"description":"Catalog specification schema. Must be a valid JSON Schema."}},"description":"Object representing a catalog specification for a nullplatform entity","example":{"id":"134544a6-a089-43ba-9d52-5b6e6e4fa8d1","name":"Namespace tags","description":"Add tags as key-value object to namespace entities","nrn":"organization=1","entity":"namespace","metadata":"tags","schema":{"type":"object","properties":{"my_string_property":{"type":"string","tag":true},"my_number_property":{"type":"number","default":0,"tag":"my_custom_tag_name"},"my_object_property":{"type":"object","properties":{"my_nested_property":{"type":"string"}}}},"required":["my_string_property"],"additionalProperties":false}}}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>