Jump to Content
Guides
Recipes
API Reference
SDK Reference
v1.0
Support
Log In
API Reference
Support
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guides
Recipes
API Reference
SDK Reference
Get an available addon by ID for internal use
Search
JUMP TO
eLabNext REST API
Add-on licenses
Retrieve all add-on licenses
get
Retrieve all expired add-on licenses
get
Purchase license for add-on with given rootVar
post
Start a trial for add-on with given rootVar
post
Retrieve license for add-on with given rootVar
get
Retrieve all license types
get
Retrieve license type for add-on with given rootVar
get
Update license type for add-on with given rootVar
put
Create license type for add-on with given rootVar
post
Delete link between license type and rootVar
delete
Add-on OAuth
Retrieve OAuth configuration by sdkPluginID
get
Create new oAuthConfiguration
post
Retrieve authentication URI by sdkPluginID
get
Retrieve access token by sdkPluginID
get
Request access and refresh token by temporary code
post
Refresh access and refresh token
post
Add-ons
Get a list of registered sources
get
Create a new registered source
post
Get a specific source
get
Update a source
put
Remove a registered source
delete
List all target groups for specified addon
get
Add new target group
post
Remove group target from addon
delete
Get groups for addons that have the add-on installed but do not fall within the specified target
get
List all target users for specified addon
get
Add new target user
post
Remove user target from addon
delete
/api/v1/addons/{sdkPluginID}/target/validateTarget/user
get
List all target organisations for specified addon
get
Add new target organisation
post
Remove organisation target from addon
delete
Get targets for addons (users, organisations and/or groups
get
Update targets for addons (users, organisations and/or groups
put
Create targets for addons (users, organisations and/or groups
post
/api/v1/addons/permissions
get
/api/v1/addons/sampleTypeMeta
get
/api/v1/addons/bundles/install
post
/api/v1/addons/bundles
get
/api/v1/addons/bundles
post
/api/v1/addons/bundles/{BundleID}
put
/api/v1/addons/bundles/{BundleID}
delete
/api/v1/addons/categories
get
/api/v1/addons/categories
post
/api/v1/addons/categories/{categoryID}
put
/api/v1/addons/categories/{categoryID}
delete
Synchronise the local addons with ones located in the remote sources
get
Update all other installed versions of this addon to this version
post
Uninstall the specified add-on for a given scope.
post
Install the specified add-on for a given scope.
post
Enable the specified add-on for the given scope.
put
Get an available addon by ID for internal use
get
Delete the specified installed add-on.
delete
Retrieve list of addons for use in marketplace.
get
Disable the specified add-on for the given scope.
put
List installed add-ons
get
Get the specified installed add-on.
get
Get all available addons grouped by rootVar and included lower versioned add-ons.
get
Get the configuration details for the specified add-on.
get
Set the configuration for the specified add-on.
put
Update existing add-on contents.
put
Publish a new add-on.
post
Approve an addon for installation by end users.
put
Add media to the specified add-on.
post
Delete given media for the specified add-on.
delete
Get a list of users which have the specified add-on installed
get
Get a list of groups which have the specified add-on installed
get
Get a list of institutes which have the specified add-on installed
get
Get the amount of available addon upgrades
get
AI
Answer a question using AI.
post
Answer a question using AI, based on previous conversation. The history of the conversion must be provided.
post
Authentication
Obtain an API token for a user, based on a request token generated while using the Add-On authentication flow for 3rd party systems.
post
Get authentication details that you're currently using
get
Authenticate and obtain an API token for a user.
post
/api/v1/auth/checkAppVersion
get
Barcode
Get the object type of a barcode and its associated id
get
Currency
Get the list of currencies available in elab
get
Get the list of currencie symbols available in elab
get
Experiment
Get the signature workflow for an experiment
get
Get experiments
get
Create a new experiment
post
Get an experiment by id
get
Get an experiment's change logs.
get
Retrieve collaborators for given experimentID
get
Setup a new request to sign an experiment using SAML authentication
post
Sign an experiment using SAML authentication
post
Sign an experiment
post
Assign a witness for an experiment signature
post
Setup a new request to pre sign an experiment using SAML authentication
post
Assign a witness for an experiment signature using SAML authentication
post
Decline an experiment of a user which requested a witness.
post
Retrieve pending witness signatures
get
Retrieve declined witness signatures
get
Update the witness for an experiment
post
Get experiment template groups
get
Get experiment templates by templateCategoryID
get
Get experiment templates
get
Experiment Links
Get all experiments linked to specified experiment.
get
Link an experiment to the specified experiment.
post
Unlink an experiment to the specified experiment.
delete
Experiment Sections
Get equipment list with bookings from an EQUIPMENT section
get
Remove equipment from an EQUIPMENT section
delete
Get log list from an EQUIPMENT section
get
Create equipment links
post
Links equipment to a section and creates a booking
post
Link equipment to a section and associate existing bookings
post
Create a new booking for an existing equipment link
post
Add existing bookings to an existing equipment link
post
Remove equipment bookings from an EQUIPMENT section
delete
Get experiment sections
get
Create a new, empty section in an experiment
post
Gets an experiment section
get
Archives an experiment section
delete
Updates an experiment section's general properties
patch
Restores an archived experiment section
post
Changes the position of the section within the experiment
put
Copies experiment section
post
Check if a text section has been locked
get
Try to lock a text section
put
Try to unlock a text section
delete
Get the content from a text section
get
Update the content of a text section
put
Get a full HTML page from a section
get
Update a text section's HTML content
put
Get file list of a FILE or CUSTOM section
get
Upload a file to a FILE or CUSTOM section
post
Remove multiple files from a FILE or CUSTOM section
delete
Download a file from a FILE or CUSTOM section
get
Remove a file from a FILE or CUSTOM section
delete
Get the custom section information of a CUSTOM section
get
Create a blank OOS file of a given type
post
Check if the file is empty
get
Get latest oos file id
post
Generate an access token for use in oos integration
post
Restore OOS section to selected file and retake screenshot
put
Download the preview image from an OOS section
get
Get the URL to the OOS server
get
Download the excel file from an EXCEL section
get
Upload an Excel file to an EXCEL section
put
Download the preview image from an EXCEL section
get
Get the URL to the OOS server for editing an EXCEL section
get
Download the canvas image from a CANVAS section
get
Upload an image to a CANVAS section
put
Get image list of an IMAGE or CUSTOM section
get
Upload an image file to an IMAGE or CUSTOM section
post
Remove multiple images from an IMAGE or CUSTOM section
delete
Download an image from an IMAGE or CUSTOM section
get
Remove an image from an IMAGE or CUSTOM section
delete
Updates the description of an image in an IMAGE or CUSTOM section
put
Updates the position of an image in an IMAGE or CUSTOM section
put
Download the image of a MARVINJS section
get
Get the image of a MARVINJS section as a data URL
get
Get the marvin js reaction from an experiment section ID
get
Post the marvin js reaction to an experiment section ID
post
Get the marvin js structure data from an experiment section ID
get
Get the content from a DATATABLE section
get
Update the content of a DATATABLE section
put
Get sample list from a SAMPLESIN or SAMPLESOUT section
get
Add samples to a SAMPLESIN or SAMPLESOUT section
put
Remove samples from a SAMPLESIN or SAMPLESOUT section
delete
Get all meta data in a section
get
Create or update meta data in a section
put
Create or update meta data in a section
post
Get meta data from a section by name
get
Experiment Sections (Deprecated Calls)
Get the content from a text section
get
Get a full HTML page from a section
get
Get file list of a FILE section
get
Download a file from a FILES section
get
Download the excel file from an EXCEL section
get
Download the preview image from an EXCEL section
get
Download the canvas image from a CANVAS section
get
Get image list of an IMAGE section
get
Download an image from an IMAGE section
get
Download a marvinJS image
get
Download a marvinJS image in Base64 format
get
Get sample list from a SAMPLESIN or SAMPLESOUT section
get
Features
/api/v1/features
get
/api/v1/features/{name}/isEnabled
get
/api/v1/features/{name}/enable
post
/api/v1/features/{name}/disable
post
/api/v1/features/{name}/enableForGroups
post
File and Meta File Storage
Get a file by group and file id
get
Get a file by file id from your current group
get
Delete a file by id from your current group
delete
Get a file by file id from your current group
get
Get a meta file by group and file id
get
Get a meta file by file id from your current group
get
Upload metafiles to the server
post
Get a tiff file by file id from your current group, and converts it to a png data string
get
List files
get
Upload files to the server
post
Upload files to a staging area
post
Group
Get a group setting
get
Get group settings
get
Create a group setting
post
Get all settings for the currently active group.
get
Create an active group setting
post
Get an active group setting
get
Update an active group setting
put
Delete an active group setting
delete
Update a group setting
put
Delete a group setting
delete
Get all groups for which you are a member
get
Get all subgroups for which you are a member
get
Get members of the group of which you are a member. You need to have View User permission to use this call. If no role is specified, the user is blocked and has no permissions within the group.
get
Get your currently active group
get
Change your currently active group
put
Search groups by searchterms
get
Hybrid Storage
/api/v1/institutes/{instituteID}/localStorage/export
get
/api/v1/institute/localStorage/export
get
Journal Notes and Dashboard Images
Gets your notes
get
Create a new note
post
Deletes several notes
delete
Get a digest of all your notes
get
Gets a note by id
get
Deletes a note
delete
Updates a note's properties
patch
Get a digest of your note images
get
Upload a note image
post
Deletes several note images
delete
Download a note image by id
get
Deletes a note image
delete
Marketplace
Get image by media ID.
get
Get icon by media ID.
get
Get all available addons.
get
Get an available addon by ID.
get
Get the script code of the specified available addon.
get
Check whether the required dependencies of the given addon are published.
get
Check to see if current logged in user has addon with rootVar X enabled. If scope specified only installation for that scope will be checked, otherwise installation for any scope will be checked.
get
Measurement Unit
Get all measurement units defined by eLab
get
MessageQueue
Deliver a new message
post
Retrieve a new message from the queue
get
Notification
Get digest information for all notifications
get
Send a notification
post
Get notifications by a list of IDs
get
Set the read flag for a number of notifications
post
Set the read flag for all notifications
post
Set the deleted flag for a number of notifications
post
Office Online
Lookup version of office online server
get
Get the OOS locale for the current user
get
Organisations
Find organisation by name
get
Get an institute setting
get
Delete an institute setting
delete
Get institute settings
get
Create a institute setting
post
Get active institute settings
get
Create an active institute setting
post
Get an active institute setting
get
Update an institute setting
put
Update an active institute setting
put
Delete an active institute setting
delete
Permissions
Change the default role for a new user
post
Get the default role for a new user
get
Disable a permission for a role
post
Enable a permission for a role
post
Get the log records for permissions
get
Get the roles for a subgroup
get
Clone a role
post
Project
Get projects
get
Create a new project
post
ProjectGroup
Get projectgroup for the specified user ID
get
Set/Unset the specified user as project group manager
put
Protocols
Get log records for a protocol
get
Get protocols
get
Get a protocol by id
get
Get a protocol by its version id
get
Get available protocol categories
get
Add protocol category
post
Archive protocol category
delete
Get protocol digest
get
Get protocol file
get
Change the subgroup for a protocol
post
Import protocol based on plain or HTML marked up text
post
Retrieve list of possible sign witnesses for this protocol
get
Sign a protocol
post
Reassign a witness
post
Decline a protocol sign request
post
Witness sign a protocol
post
Retrieve declined witness signatures
get
Retrieve pending witness signatures
get
Sign a protocol using SAML authentication
post
Witness sign a protocol using SAML authentication
post
Quantity
Get quantity types
get
Get quantity types by id
get
Sample
Get samples
get
Create a new sample
post
Perform a similarity, substructure or exact search on chemical sample data
get
Create multiple new samples with metas
post
Archive multiple samples
delete
Create a new sample by using HL7 2.x.x standards
post
Get a sample by id
get
Archive a sample
delete
Update a sample's properties
patch
Get a list of samples for multiple ids
get
Get a list of samples for multiple barcodes
get
Get a list of samples for multiple names
get
Get a sample's full parent ancestry
get
Get a sample's direct children
get
Get all experiment sections where the sample is used
get
Archive multiple samples.
post
Get single samples and sample series in an aggregated list
get
Move a sample to another storage layer
post
Move samples to another storage layer
post
Move samples to another storage layer
post
Change the locations of multiple samples in a box compartment
post
Change the locations of multiple samples
post
Creates one or more clones of a sample
post
Creates a series out of one or more clones of the specified sample
post
Clone sample into an existing series
post
Recover multiple archived samples
post
Get a sample's change logs
get
Get a sample's quantity settings
get
Add or replace a sample's quantity settings
put
Delete a sample's quantity settings
delete
Update a sample's quantity settings
patch
Add or replace quantity settings for all samples in a series
put
Add to quantity amount for all samples in a series
post
Subtract from quantity amount for all samples in a series
post
Add an amount to a sample's quantity
post
Subtract an amount from a sample's quantity
post
Clear a sample's amount
post
Clear amount of all samples in a series
post
Get all of a sample's meta fields
get
Create or update a sample's meta field
put
Create a new sample's meta field
post
Create or update multiple sample's meta fields
put
Get a sample's meta field by id
get
Delete a sample's meta field
delete
Update a sample's meta field properties
patch
Create or update a sample's meta field properties in bulk, based on its sampleTypeMetaID
put
Check out a sample
post
Check in a previously checked out sample
post
Check out multiple samples
post
Check in multiple samples
post
Remove the location from multiples samples
post
Change the owner of a sample
post
Change the owner of a sample
post
Change the owner of a sample
post
Get sample series
get
Create a new sample series
post
Create a new sample series, together with samples, sample meta fields and sample quantity settings.
post
Add multiple samples to an existing sample series.
post
Update a sampleseries properties
patch
Add a sample to a series
post
Update all samples in a sample series
patch
Get a sample series by id
get
Archive all samples in a series and remove the series
delete
Add existing samples to a series
post
Merge source sample series into target sample series
post
Remove samples from a series
post
Move all samples in a series to another storage layer
post
Copy a sample series to the given location
post
Get a sample series' change logs
get
Get the available columns for the sample list table
get
SampleType
Get sample types
get
Create a new sample type
post
Get a list of sample types for multiple names
get
Get a sample type by id
get
Delete a sample type
delete
Update a sample type's properties
patch
Restore the given sampleType from archive
post
Get all meta fields from all sample types
get
Get all of a sample type's meta fields
get
Create or update a sample type's meta field
put
Create a new sample type's meta field
post
Get a sample type's meta field by id
get
Delete a sample type's meta field
delete
Update a sample type meta field's properties
patch
Get a sample type meta field's default options
get
Update, Remove and Create a sample type meta field's default options
put
Signature Workflows
Get all signature workflows
get
Create a new signature workflow
post
Get a signature workflow by id
get
Archive signature workflow
delete
Publish a signature workflow (set draft state to false)
post
Create a new signature workflow step
post
Change the name of a signature workflow
post
Change the description of a signature workflow
post
Delete a signature workflow step
delete
Get candidates with sign permission
get
Get candidates with witness sign permission
get
Get project candidates
get
Get role candidates with sign permission
get
Get role candidates with witness sign permission
get
Add one or more projects to a workflow
post
Remove a project from a signature workflow
delete
Update the assignee for a workflow step
post
Get pending signatures for a signature workflow
get
Cancel all pending signatures of a signature workflow
post
Storage and Equipment
Get all storage unit/equipment types
get
Create a new equipment type
post
Get a storage unit/equipment type by id
get
Delete a storage unit type/equipment type
delete
Get storage units/equipment
get
Create a new storage unit/equipment based on the specified type
post
Get a storage unit/equipment by id
get
Update properties of a storage unit or equipment
patch
Update properties of multiple storage devices or instruments
patch
Update icons of multiple instruments
patch
Get statistics for a storage unit
get
Get a storage unit's samples
get
Find a free sample location within a storage unit
get
Get a storage unit's full logs
get
Get full log of an equipment
get
Export a full log of an equipment
post
Find an empty compartment in a storage layer
get
Get an equipment reservations report
get
Get a storage unit's sample logs
get
Get all compartment definitions for a storage unit.
get
Create a new compartment definition for a storage unit. This is a template for creating one or more compartments.
post
Get a compartment definition by id.
get
Get the storage compartment ancestry of a compartment
get
Get storage unit/equipment compartments
get
Get a storage unit/equipment compartment by id
get
Delete a storageLayer by storageLayerID
delete
Update a storage compartment's properties
patch
Get a storage unit/equipment compartment by its barcode
get
Get a storage compartment's logs
get
Get the storage compartments of a compartment
get
Create a new compartment within an existing compartment
post
Create multiple new compartments within an existing compartment
post
Get the storage compartments of several parent compartments
get
Move a storage compartment into another compartment
post
Move multiple storage compartments into another compartment
post
Get a storage layer's samples
get
Find a free sample location in or below a storage layer
get
Delete multiple storageLayers by storageLayerID
delete
Get all of a equipment or storage unit meta fields
get
Create a new equipment or storage unit meta field
post
Create multiple new equipment or storage unit meta fields
post
Delete multiple equipment or storage units meta fields
delete
Update multiple equipment or storage units meta fields
patch
Get an equipment or storage unit meta field by id
get
Delete an equipment meta field
delete
Update an equipment or storage unit meta field properties
patch
Get all of a storage unit or equipment managers
get
Add a userID as manager to a storage unit/equipment
put
Add multiple managers by userID to a storage unit/equipment
put
Remove multiple managers from a storage unit/equipment by userID
delete
Add multiple managers by user IDs to the existing managers for multiple equipment
post
Replace all managers by the provided user IDs to multiple equipment
post
Remove a manager from a storage unit/equipment by userID
delete
Remove multiple managers by user IDs from multiple equipment
delete
Get all of an equipment's validations
get
Create a new storage unit or equipment validation
post
Create new equipment validations
post
Get an equipment validation by id
get
Delete an equipment validation
delete
Update an equipment validation properties
patch
Get all reservations of a storage/equipment compartment
get
Create a new storage/equipment compartment reservation
post
Get a storage/equipment compartment reservation by id
get
Delete a storage/equipment compartment reservation
delete
Update a storage/equipment compartment reservation
patch
Get equipment bookings.
get
Create an equipment booking.
post
Update an equipment booking.
put
Delete an equipment booking.
delete
Get active assignment of a compartment.
get
Create compartment assignment.
post
Create compartment assignments.
post
Delete multiple compartment assignments.
delete
Update a compartment assignment.
put
Delete a compartment assignment.
delete
Study
Get studies
get
Create a study
post
Request to sign a study using SAML authentication
post
Supplies
Get a list of orders
get
Create new order
post
Update order
put
Get a list of catalog items
get
System
Get all capabilities
get
Get system timezones
get
Is this installation a custom deployment
get
Get the current Elab version
get
Task Management
List all tasks for current logged in user
get
Create a task
post
Get single task
get
Delete a task
delete
Update a task
patch
Setup a sample link
post
Get the linked samples of a task
get
Setup an experiment link
post
Get the linked experiments of a task
get
Setup a protocol link
post
Get the linked protocols of a task
get
Setup an equipment link
post
Get the linked equipment of a task
get
Delete multiple tasks
delete
Update multiple task statuses
patch
User
Get the current user Info
get
Get the profile of a user
get
Update user information
patch
Get the current user setting
get
Set the current user setting
post
Get the current user plugin setting
get
Set the current user plugin setting
post
Find users by email address
get
Get the information of a user
get
Get a current user setting
get
Get a current user settings
get
Create a current user setting
post
Update a current user setting
put
Delete a user setting for the logged in user
delete
Get an user setting by user id
get
Update an user setting by user id
put
Delete an user setting by user id
delete
Get user settings by user id
get
Create user setting by user id
post
Reset MFA settings by user id
post
View
/api/v1/views
get
/api/v1/views
post
/api/v1/views/{viewID}
get
/api/v1/views/{viewID}
put
/api/v1/views/{viewID}
delete
Get an available addon by ID for internal use
get
https://{targetURL}/api/v1/addons/
{sdkPluginID}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Log in to use your API keys
URL
Base URL
https://
sandbox.elabjournal.com
/api/v1/addons/{sdkPluginID}
RESPONSE
Click
Try It!
to start a request and see the response here!
