A collection of lab catalogs.
Property | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||
links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||||||||
meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A collection of lab catalogs.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"description": "A lab catalog.",
"properties": {
"boundsDisplaySort": {
"description": "Returns a slug that denotes whether width precedes height (or vice versa)\nwhen displaying bounds (e.g. 8\" x 10\" vs 10\" x 8\").",
"enum": [
"width-height",
"height-width"
],
"type": "string"
},
"currencyCode": {
"description": "The type of currency used for this lab catalog, or `null` if this\ncatalog has no currency code set.",
"nullable": true,
"type": "string"
},
"currencySymbol": {
"description": "The currency symbol for the type of currency used for this lab\ncatalog.",
"nullable": true,
"type": "string"
},
"description": {
"deprecated": true,
"description": "Derived in the lab catalog transformer. Deprecated due to lack of translation.",
"type": "string"
},
"id": {
"description": "The identifier for this lab catalog, or `null` if this is the\n\"empty\" lab catalog.",
"nullable": true,
"type": "integer"
},
"isLabFulfilled": {
"description": "Whether this represents a catalog of lab-fulfilled items.",
"type": "boolean"
},
"lab": {
"allOf": [
{
"description": "The lab to which this lab catalog belongs, or `null` if this is the\n\"empty\" lab catalog.",
"nullable": true
},
{
"$ref": "#/components/schemas/Lab"
}
]
},
"links": {
"$ref": "#/components/schemas/Links"
},
"type": {
"allOf": [
{
"enum": [
"lab-catalog"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"title": "Lab Catalog",
"type": "object"
},
"title": "Lab Catalog",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"description": "Metadata describing the current result set.",
"properties": {
"currentPage": {
"description": "The current page of results returned.",
"type": "integer"
},
"rows": {
"description": "The number of rows returned per page for the current result set.",
"type": "integer"
},
"totalItems": {
"description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
"type": "integer"
},
"totalPages": {
"description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
"type": "integer"
}
},
"readOnly": true,
"type": "object"
},
"type": {
"description": "The type of resource represented.",
"enum": [
"lab-catalog-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Lab Catalog Collection",
"type": "object"
}