Skip to main content

List metadata specifications

Lists all metadata specifications

Query Parameters
limit string

Possible values: 1 ≤ length

Limits the number of results returned per page

offset string

Possible values: 1 ≤ length

Specifies the offset for paginating through results

entity string

Possible values: [organization, account, namespace, application, build, asset, scope, release, deployment]

Parent entity that holds metadata information

metadata string

Possible values: 1 ≤ length

Entity metadata key, for example: coverage, frameworks, vulnerabilities

nrn NRN

Possible values: Value must match regular expression ^organization=(\d+|\*)+(?::account=(\d+|\*))?(?::namespace=(\d+|\*))?(?::application=(\d+|\*))?(?::(build|scope|release)=(\d+|\*))?$

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

NRN where the metadata specification was defined

Responses
2XX

Object representing pagination parameters for controlling the number and order of results

Schema OPTIONAL
paging object
limit integer

Possible values: 1 ≤ value

Limits the number of results returned

offset integer

Specifies the offset for paginated results

results object[]
id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

name string OPTIONAL

Possible values: 1 ≤ length

Metadata specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities

nrn NRN OPTIONAL

Possible values: Value must match regular expression ^organization=(\d+|\*)+(?::account=(\d+|\*))?(?::namespace=(\d+|\*))?(?::application=(\d+|\*))?(?::(build|scope|release)=(\d+|\*))?$

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

entity string OPTIONAL

Possible values: [organization, account, namespace, application, build, asset, scope, release, deployment]

Parent entity that holds metadata information

metadata string OPTIONAL

Possible values: 1 ≤ length

Entity metadata key, for example: coverage, frameworks, vulnerabilities

description string OPTIONAL

Possible values: 1 ≤ length

Metadata specification description

schema object OPTIONAL

Metadata specification schema. Must be a valid JSON Schema

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context