Skip to main content

LabTestPackageCreateRequest

namestring

Package name

Possible values: <= 255 characters

typestring

Package type

Possible values: <= 255 characters

Example: Sample Type
descriptionstring

Package description

Possible values: <= 5000 characters

revisionstring

Package revision

Possible values: <= 80 characters

enabledboolean

Package enabled status

Default value: true
labTestTypesstring[]

Lab test types

Possible values: <= 80 characters

labTestPropertiesstring[]

Lab test properties

Possible values: <= 100 characters

productLinesstring[]

Product lines

Possible values: <= 128 characters

materialTypesstring[]

Material types

Possible values: <= 128 characters

viewingPermissionsstring

Viewing permissions

Possible values: [all_orgs, selected_orgs]

Default value: all_orgs
selectedOrgsstring[]

Selected organization custom IDs. Required (non-empty) when viewingPermissions is selected_orgs; ignored otherwise.

Possible values: <= 255 characters

Example: ["Org-Custom-ID-1"]
tagsstring[]

Package tags. Leading and trailing whitespace is trimmed and repeated whitespace between words is reduced to a single space ("heavy metal" is saved as "heavy metal"; words are never joined). Each tag must be lowercase, not blank, unique within the list and at most 255 characters. A tag that breaks a rule is not fixed silently; the request is rejected with 400 and nothing is saved. The list sent replaces the package's existing tags, and [] removes them all. When omitted on create, no tags are stored; omit the field on update to leave them unchanged. null is rejected.

Possible values: <= 255 characters

Example: ["fiber:wool","16-cfr-1610"]
idstring

Package ID

Possible values: <= 50 characters

Example: PKG-001
LabTestPackageCreateRequest
{
  "name": "string",
  "type": "Sample Type",
  "description": "string",
  "revision": "string",
  "enabled": true,
  "labTestTypes": [
    "string"
  ],
  "labTestProperties": [
    "string"
  ],
  "productLines": [
    "string"
  ],
  "materialTypes": [
    "string"
  ],
  "viewingPermissions": "all_orgs",
  "selectedOrgs": [
    "Org-Custom-ID-1"
  ],
  "tags": [
    "fiber:wool",
    "16-cfr-1610"
  ],
  "id": "PKG-001"
}