Lab Catalog Group

Description

A container for a collection of related products within the lab catalog.

Properties

Property Description
description nullable

Display text shown to the user in order to give them information concerning the group and the type of products which it may contain.

displayOrder

The order in which the group should be displayed in a list of groups for a lab catalog.

id

The identifier for the lab catalog group.

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.

name

The name of the lab catalog group.

type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A container for a collection of related products within the lab catalog.",
  "properties": {
    "description": {
      "description": "Display text shown to the user in order to give them information\nconcerning the group and the type of products which it may contain.",
      "nullable": true,
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the group should be displayed in a list of groups\nfor a lab catalog.",
      "type": "integer"
    },
    "id": {
      "description": "The identifier for the lab catalog group.",
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the lab catalog group.",
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "enum": [
            "lab-catalog-group"
          ]
        },
        {
          "$ref": "#/components/schemas/Type"
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder"
  ],
  "title": "Lab Catalog Group",
  "type": "object"
}