Skip to main content

GetSampleResponse

result objectrequired
sampleIdSampleId (string)

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

Example: CG_012345678901235
parentIdParentId (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.

categorystring

A user-defined category for the sample.

creatorIdstring

The user id of the sample creator

ownerIdstring

The user id of the creator

creationDateinteger<int64>
lastModifiedinteger<int64>
meta objectrequired
httpStatushttp status (string)required
requestIdAn identifier of the incoming request. (string)required
noticeAn informational string about the request. (string)
GetSampleResponse
{
"result": {
"sampleId": "CG_012345678901235",
"parentId": "CG_012345678901235",
"name": "string",
"category": "string",
"creatorId": "string",
"ownerId": "string",
"creationDate": 0,
"lastModified": 0
},
"meta": {
"httpStatus": "string",
"requestId": "string",
"notice": "string"
}
}