Update A Manifest

curl --request POST \
  --url https://cloudlab.scispot.io/manifest/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hrid": "PLT000001",
  "plate": {
    "wells": [
      {
        "position": "A1",
        "tags": [
          "PASSED_QC"
        ],
        "label": "SAMPLE",
        "sample": {
          "id": "SMPL000001",
          "labsheet": "Sample Manager"
        }
      }
    ],
    "removeFromWells": [
      {
        "position": "A2",
        "fields": [
          "SAMPLE"
        ]
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hrid: 'PLT000001',
    plate: {
      wells: [
        {
          position: 'A1',
          tags: ['PASSED_QC'],
          label: 'SAMPLE',
          sample: {id: 'SMPL000001', labsheet: 'Sample Manager'}
        }
      ],
      removeFromWells: [{position: 'A2', fields: ['SAMPLE']}]
    }
  })
};

fetch('https://cloudlab.scispot.io/manifest/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloudlab.scispot.io/manifest/update"

payload = {
    "hrid": "PLT000001",
    "plate": {
        "wells": [
            {
                "position": "A1",
                "tags": ["PASSED_QC"],
                "label": "SAMPLE",
                "sample": {
                    "id": "SMPL000001",
                    "labsheet": "Sample Manager"
                }
            }
        ],
        "removeFromWells": [
            {
                "position": "A2",
                "fields": ["SAMPLE"]
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "message": "Manifest updated successfully",
  "data": {
    "hrid": "PLT000001"
  }
}

{
  "success": false,
  "message": "Bad request"
}

{
  "success": false,
  "message": "Invalid Authentication Token"
}

{
  "success": false,
  "message": "Missing Authentication Token"
}

{
  "success": false,
  "message": "Validation error"
}

{
  "success": false,
  "message": "Operation failed"
}

Manifests (Plates, Boxes, Racks) API

Update A Manifest

This endpoint allows users to update an existing manifest, these can include sample assignments, labeling modifications, and tag management across multiple well positions within a single manifest.

Update Operations

This endpoint supports several types of operations that users can perform on manifest wells. Each operation requires specific input parameters depending on the intended action.

Assign Operations must be included under the wells array within the plate object. These operations add or update sample assignments, labels, and tags to specific well positions.

Remove Operations must be included under the removeFromWells array within the plate object. These operations clear existing sample assignments, labels, or tags from specific well positions.

Assignment

Assign operations allow users to add or update well assignments including samples, labels, and tags. Multiple assignment types can be combined in a single well object.

{
  "position": "A1",
  "sample" : {
   "id": "SM000001",
   "labsheet": "Sample Manager"
  },
  "tags": ["PASSED_QC"],
  "label": "SAMPLE"
}

position (string, required): The specified well position

sample (object, required): A dictionary object containing the id of the sample to be assigned and the corresponding origin labsheet.

tags (array, required): An array of string values representing custom metadata tags to associate with the well position.

label (string, required): When assigning a label, valid options include one of “SAMPLE”, “POS_CONTROL”, “NEG_CONTROL”, “BLANK”, “STANDARD” or left as an empty "" if no label should be assigned.

Removal

Remove operations allow users to clear existing assignments from well positions. Users can selectively remove samples, labels, or tags from specific wells by specifying which fields to clear.

"removeFromWells" : [
 {
   "position" : "B1",
   "fields" : ["LABEL"]
 },
 {
   "position" : "A4",
   "fields" : ["SAMPLE"]
 }
]

position (string, required): The specified well position.

fields (array, required): An array of strings specifying which types of assignments to remove from the well position. Valid options include “SAMPLE”, “LABEL”, “TAGS”.

Provide one of hrid or uuid. plate must contain wells and/or removeFromWells. Position format must match the manifest plate/box layout.

POST

https://cloudlab.scispot.io

manifest

update

Update A Manifest

curl --request POST \
  --url https://cloudlab.scispot.io/manifest/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hrid": "PLT000001",
  "plate": {
    "wells": [
      {
        "position": "A1",
        "tags": [
          "PASSED_QC"
        ],
        "label": "SAMPLE",
        "sample": {
          "id": "SMPL000001",
          "labsheet": "Sample Manager"
        }
      }
    ],
    "removeFromWells": [
      {
        "position": "A2",
        "fields": [
          "SAMPLE"
        ]
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hrid: 'PLT000001',
    plate: {
      wells: [
        {
          position: 'A1',
          tags: ['PASSED_QC'],
          label: 'SAMPLE',
          sample: {id: 'SMPL000001', labsheet: 'Sample Manager'}
        }
      ],
      removeFromWells: [{position: 'A2', fields: ['SAMPLE']}]
    }
  })
};

fetch('https://cloudlab.scispot.io/manifest/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloudlab.scispot.io/manifest/update"

payload = {
    "hrid": "PLT000001",
    "plate": {
        "wells": [
            {
                "position": "A1",
                "tags": ["PASSED_QC"],
                "label": "SAMPLE",
                "sample": {
                    "id": "SMPL000001",
                    "labsheet": "Sample Manager"
                }
            }
        ],
        "removeFromWells": [
            {
                "position": "A2",
                "fields": ["SAMPLE"]
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "message": "Manifest updated successfully",
  "data": {
    "hrid": "PLT000001"
  }
}

{
  "success": false,
  "message": "Bad request"
}

{
  "success": false,
  "message": "Invalid Authentication Token"
}

{
  "success": false,
  "message": "Missing Authentication Token"
}

{
  "success": false,
  "message": "Validation error"
}

{
  "success": false,
  "message": "Operation failed"
}

Authorizations

Authorization

string

header

required

Personal access token from Scispot Account → Personal Tokens

Body

application/json

plate

object

required

The plate operations to apply. Must contain wells (assign operations) and/or removeFromWells (remove operations), with at least one entry.

Show child attributes

hrid

string

The human-readable ID of the manifest to update. Provide either hrid or uuid.

uuid

string

The UUID of the manifest to update. Provide either hrid or uuid.

Response

success

boolean

message

string

data

object

updatedManifest

object

Start here

API Reference

Update A Manifest

Update Operations

Assignment

Removal

Authorizations

Body

Response