Create Locations in Bulk

curl --request POST \
  --url https://cloudlab.scispot.io/location/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    {
      "name": "Lab Room 1",
      "locationType": "ROOM",
      "children": [
        {
          "name": "Freezer A",
          "locationType": "FREEZER",
          "temperature": "-80",
          "temperatureUnit": "C",
          "children": [
            {
              "name": "Shelf 1",
              "locationType": "SHELF"
            }
          ]
        }
      ]
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    locations: [
      {
        name: 'Lab Room 1',
        locationType: 'ROOM',
        children: [
          {
            name: 'Freezer A',
            locationType: 'FREEZER',
            temperature: '-80',
            temperatureUnit: 'C',
            children: [{name: 'Shelf 1', locationType: 'SHELF'}]
          }
        ]
      }
    ]
  })
};

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

import requests

url = "https://cloudlab.scispot.io/location/create"

payload = { "locations": [
        {
            "name": "Lab Room 1",
            "locationType": "ROOM",
            "children": [
                {
                    "name": "Freezer A",
                    "locationType": "FREEZER",
                    "temperature": "-80",
                    "temperatureUnit": "C",
                    "children": [
                        {
                            "name": "Shelf 1",
                            "locationType": "SHELF"
                        }
                    ]
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "requestId": "<requestId>",
  "message": "Location creation queued"
}

{
  "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"
}

Locations API

Create Locations in Bulk

This API endpoint is used to create single locations or locations in bulk. This is an async process, so the return message will only return the request ID for the async ticket. In order to check the creation status of this endpoint, use the /location/create/status endpoint with the request ID as the parameter.

Location Types supported by this endpoint includes

Room
Shelf
Freezer
Custom locations

Location Types that are not currently supported via this API

Racks
Manifest (Use the “Assign Manifest To A Location” endpoint to assign manifest locations)

There is a heirarchy for these locations where some location types cannot be created as a child of another location type.

Root Locations: Rooms, Shelves, Freezers, Custom Locations

Within Rooms: Freezers, Shelves, Custom Locations

Within Freezers: Shelves, Custom Locations

Within Shelves: Custom Locations

Within Custom Locations: Shelves, Custom Locations

Creates up to 20 location nodes including children. Maximum nested depth is 3. RACK cannot be created through this endpoint. FREEZER requires temperature and temperatureUnit; CUSTOM requires customTypeName.

POST

https://cloudlab.scispot.io

location

create

Create Locations in Bulk

curl --request POST \
  --url https://cloudlab.scispot.io/location/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    {
      "name": "Lab Room 1",
      "locationType": "ROOM",
      "children": [
        {
          "name": "Freezer A",
          "locationType": "FREEZER",
          "temperature": "-80",
          "temperatureUnit": "C",
          "children": [
            {
              "name": "Shelf 1",
              "locationType": "SHELF"
            }
          ]
        }
      ]
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    locations: [
      {
        name: 'Lab Room 1',
        locationType: 'ROOM',
        children: [
          {
            name: 'Freezer A',
            locationType: 'FREEZER',
            temperature: '-80',
            temperatureUnit: 'C',
            children: [{name: 'Shelf 1', locationType: 'SHELF'}]
          }
        ]
      }
    ]
  })
};

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

import requests

url = "https://cloudlab.scispot.io/location/create"

payload = { "locations": [
        {
            "name": "Lab Room 1",
            "locationType": "ROOM",
            "children": [
                {
                    "name": "Freezer A",
                    "locationType": "FREEZER",
                    "temperature": "-80",
                    "temperatureUnit": "C",
                    "children": [
                        {
                            "name": "Shelf 1",
                            "locationType": "SHELF"
                        }
                    ]
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "requestId": "<requestId>",
  "message": "Location creation queued"
}

{
  "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

locations

object[]

required

The location nodes to create. Counts include nested children, up to a maximum of 20 nodes per request with a maximum nesting depth of 3.

Maximum array length: 20

Show child attributes

Response

success

boolean

requestId

string

message

string

Start here

API Reference

Create Locations in Bulk

Authorizations

Body

Response