Scispot API - 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/location/create

Request

  • Base URL: https://cloudlab.scispot.io
  • URL: https://cloudlab.scispot.io/location/create
  • Auth: HTTP bearer

Request body

Response

OK

successboolean
requestIdstring
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.