Sample

sampleIdSampleId (string)

The ID of the sample for which you want to get metadata.

Example: CG_012345678901235

parentGroupIdParentId (string)

Either a mailing list ID or a batch ID. The sampleId returned will be of the same type.

Possible values: non-empty

Example: CG_012345678901235

namestring

The name of the sample.

descriptionstring

A description of the sample.

categorystring

A user-defined category for the sample.

creatorIdstring

ownerIdstring

contactCountinteger<int32>

Possible values: >= 0

Default value: 0

hiddenboolean

frozenboolean

creationLogicobject

Sample

{
  "sampleId": "CG_012345678901235",
  "parentGroupId": "CG_012345678901235",
  "name": "string",
  "description": "string",
  "category": "string",
  "creatorId": "string",
  "ownerId": "string",
  "contactCount": 0,
  "hidden": true,
  "frozen": true,
  "creationLogic": {}
}