Skip to main content

List specifications

List specifications

Query Parameters
id
nrn NRN

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

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

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

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

Name of the entity. Must be a non-empty string and not equal to null

slug string OPTIONAL

Possible values: 1 ≤ length

Slug of the specification. Automatically generated from "name"

created_at date OPTIONAL
updated_at date OPTIONAL
visible_to NRN[] OPTIONAL

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

Array representing visibility settings for the entity. Specifies what/who can see this entity

unique boolean OPTIONAL

Indicates whether the service can be linked only once by an instance of this link specification

specification_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

dimensions object OPTIONAL

Object representing dimensions with key-value pairs

attributes object OPTIONAL

Object representing an attribute with a schema and associated values

schema object

Specification of the attribute schema. Must be a valid JSON Schema

values object

Values associated with the attribute. Must validate against provided schema

selectors object OPTIONAL

Key-value object representing instance selectors

imported boolean OPTIONAL
provider string OPTIONAL

Possible values: 1 ≤ length

category string OPTIONAL

Possible values: 1 ≤ length

sub_category string OPTIONAL

Possible values: 1 ≤ length

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