Documentation Powered by Redocly

StackWave Affinity™ REST API (v1)

Download OpenAPI specification:Download

StackWave Affinity™ REST API

Authenticate with the server.

Authentication will return a bearer token that must be included in the Authorization header on all subsequent requests.

Request Body schema:

The Login and Password information.

Login
string
Password
string

Responses

Request samples

Content type
{
  • "Login": "string",
  • "Password": "string"
}

Response samples

Content type
{
  • "Schema": {
    },
  • "Results": [
    ],
  • "NextUrl": "string"
}

Fetch all sequences of the specified alphabet, optionally matching provided patterns.

Default sequence alphabets are DNA, RNA, and Protein. Patterns should be provided in the query string as a series of values named "pattern," e.g. "pattern=STACK&pattern=WAVE."

path Parameters
alphabet
required
string

The type of sequences to retrieve.

query Parameters
pattern
required
Array of strings

The set of patterns with which to filter the sequences.

Responses

Response samples

Content type
{
  • "Schema": {
    },
  • "Results": [
    ],
  • "NextUrl": "string"
}

Fetch results for the specified {assayType}.

path Parameters
assayType
required
string

The type of assay for which results are retrieved.

Responses

Response samples

Content type
{
  • "Assay": "string",
  • "Schema": {
    },
  • "NextUrl": "string",
  • "Results": [
    ]
}

Creates a set of assay results of the specified {assayType}.

Results must be provided in multipart MIME format and can include one or more files. The results themselves should be provided as a JSON-formatted array named "results" and the ID to assign to the result set should be named "id."

path Parameters
assayType
required
string

The type of assay for which results are retrieved.

Responses

Response samples

Content type
{
  • "Assay": "string",
  • "Schema": {
    },
  • "NextUrl": "string",
  • "Results": [
    ]
}

Fetch assay results in the result set with the specified {id}.

path Parameters
assayType
required
string

The type of assay for which results are retrieved.

id
required
string

The unique ID of the result set.

Responses

Response samples

Content type
{
  • "Assay": "string",
  • "Schema": {
    },
  • "NextUrl": "string",
  • "Results": [
    ]
}

Fetch available locations in the lab.

Responses

Response samples

Content type
{
  • "Locations": [
    ],
  • "NextUrl": "string"
}

Fetch the location with the specified {id}.

path Parameters
id
required
string

The unique ID of the location.

Responses

Response samples

Content type
{
  • "Id": "string",
  • "Location": "string",
  • "RegisteredOn": "2019-08-24T14:15:22Z",
  • "RegisteredBy": "string"
}

Add or update a location with the specified {id}.

path Parameters
id
required
string

The unique ID of the location.

Request Body schema:

Information to use in creating or updating the location.

Location
string

The ID of the location in which the container will now be located.

Type
string
Enum: "Unknown" "Plate" "TubeRack" "Box" "Drawer" "StorageRack" "Shelf" "AmbientStorage" "ColdStorage" "Area"

The type of location. If the location has already been created and this value does not match the existing value, an error is returned.

Array of objects (ContainerValues)

Containers that will now be placed within this location. If any of the containers do not exist, they are created.

Responses

Request samples

Content type
{
  • "Location": "string",
  • "Type": "Unknown",
  • "Containers": [
    ]
}

Response samples

Content type
{
  • "Id": "string",
  • "Location": "string",
  • "RegisteredOn": "2019-08-24T14:15:22Z",
  • "RegisteredBy": "string"
}

Fetch available containers.

Responses

Response samples

Content type
{
  • "Containers": [
    ],
  • "NextUrl": "string"
}

Fetch the container with the specified {id}.

path Parameters
id
required
string

The unique ID of the container.

Responses

Response samples

Content type
{
  • "Id": "string",
  • "Material": "string",
  • "Sample": "string",
  • "Location": "string",
  • "Well": "string",
  • "Volume": 0,
  • "VolumeUnit": "string",
  • "Concentration": 0,
  • "ConcentrationUnit": "string",
  • "RegisteredOn": "2019-08-24T14:15:22Z",
  • "RegisteredBy": "string"
}

Add or update a container with the specified {id}.

path Parameters
id
required
string

The unique ID of the container.

Request Body schema:
Id
string

The container's unique ID. When updating an individual container's values using the API, this value is ignored and the ID specified in the URL is used.

Material
string

The ID of the material in the container.

Type
string
Enum: "Well" "Tube" "Vial"

The type of container. If the container has already been created and this value does not match the existing value, an error is returned.

Location
string

For a tube or vial, the ID of the location in which the container will now be located. When updating containers in a location using the API, this value is ignored and the ID specified in the URL is used.

Well
string

For a plate well, the location within the plate.

Volume
number <double>

The volume of solution in the container if it is known.

VolumeUnit
string

The volume unit of measure.

Concentration
number <double>

The concentration of sample in solution if it is known.

ConcentrationUnit
string

The concentration unit of measure.

Responses

Request samples

Content type
{
  • "Id": "string",
  • "Material": "string",
  • "Type": "Well",
  • "Location": "string",
  • "Well": "string",
  • "Volume": 0,
  • "VolumeUnit": "string",
  • "Concentration": 0,
  • "ConcentrationUnit": "string"
}

Response samples

Content type
{
  • "Id": "string",
  • "Material": "string",
  • "Sample": "string",
  • "Location": "string",
  • "Well": "string",
  • "Volume": 0,
  • "VolumeUnit": "string",
  • "Concentration": 0,
  • "ConcentrationUnit": "string",
  • "RegisteredOn": "2019-08-24T14:15:22Z",
  • "RegisteredBy": "string"
}

Fetch records for the specified {entityType}.

path Parameters
entityType
required
string

The type of entity to retrieve.

Responses

Response samples

Content type
{
  • "Schema": {
    },
  • "Results": [
    ],
  • "NextUrl": "string"
}

Fetch containers that hold samples of the specified entity.

path Parameters
entityType
required
string

The type of entity to retrieve.

id
required
string

The entity's unique ID.

Responses

Response samples

Content type
{
  • "Containers": [
    ],
  • "NextUrl": "string"
}

Fetch assay results for the specified entity.

path Parameters
entityType
required
string

The type of entity to retrieve.

id
required
string

The entity's unique ID.

Responses

Response samples

Content type
[
  • {
    }
]

Fetch the entity of type {entityType} with the specified {id}.

path Parameters
entityType
required
string

The type of entity to retrieve.

id
required
string

The entity's unique ID.

Responses

Response samples

Content type
{
  • "Schema": {
    },
  • "Results": [
    ],
  • "NextUrl": "string"
}