API ReferenceObject Actions

Create Objects

GA
Create objects within your organization's AmniSphere library.

Headers

x-api-keystringRequired
Your organization's active API Key.

Request

This endpoint expects a list of objects.
labelstringRequired
The name of the object you'd like to create within your organization's library.
organization_idstringRequiredformat: "uuid"
Your organization's unique identifier.
attributesmap from strings to stringsRequired
A map of attributes associated with the object to be created within your organization's library. At least one attribute is required to create an object.
detection_item_folder_idstringOptionalformat: "uuid"
The folder id of the folder you'd like your object to be created in within your organization's library. If this value is left empty, the object will be created in the "Unclassified" folder.
barcodesstringOptional

The UPC/barcode values associated with this object. Individual barcodes should be separated by a pipe character(|) to be parsed correctly.

collection_notestringOptional
A collection note to be shown to users when they begin collecting this object.
created_bystringOptional
The email of the user creating the folder. If this parameter is left empty, the value will default to 'API'.

Response

201 - Object creation successful

labelstring
The name of the object you've successfully created within your organization's library.
organization_idstringformat: "uuid"
Your organization's unique identifier.
attributesmap from strings to strings
A map of attributes associated with the newly created object. These attributes will match the attributes within the library for this object.
barcodesstring

The UPC/barcode values associated with this object. Individual barcodes should be separated by a pipe character(|) to be parsed correctly.

collection_notestring
A collection note to be shown to users when they begin collecting this object. This value will be null if a collection note was not entered during object creation.
detection_item_folder_idstring
The folder id of the folder your newly created object resides in within your organization's library. If you did not specify a folder during object creation, this value will be null.
created_bystring
The name of the object you'd like to create within your organization's library.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error