API Training Videos

To help those who prefer learning at their own pace, we have created video materials that supplement our API training materials. These videos correlate directly to the materials covered in the slides for each module, and in most cases we have also provided videos that illustrate the solution to the exercises.

These videos refer to resource definitions and the API Cookbook:

•

Resource Definitions can be accessed through the API Portal.

•

The About the Cookbook is a set of example scripts intended to help you learn how to work with REST and EPP (automation) scripts.

Module 1: Overview of the API

This module outlines the course structure of the API Training Series of modules and provides a general strategy for being successful using the API.

Module 2: General Concepts of the API

This module explores the basic principles of interacting with the API. A browser plugin such as XHR for Chrome or Poster for Firefox is used and illustrates where specific LIMS data are accessible via the API. The PUT, POST, GET,and DELETE actions are explained as to how these operations are supported through the API.

Understanding the concept of a genealogy and how user defined fields are configured and used in the system is uncovered. Completing the exercises for this module is critical before proceeding to Module 3.

Module 2: Example Exercise 1

Module 2: Example Exercise 2

Module 2: Example Exercise 3

Module 3: Groovy

This module explores setting up Groovy and interacting with data in the Clarity LIMS database via the API. Common script examples from the Cookbook section are used to show how to use a scripting language to interact with the API. API example videos are also provided as part of module 3.

Module 3: Example Exercise 1

Module 3: Example Exercise 2

Module 4: Process Inputs and Outputs

This module focuses on how the data for processes that have been carried out in the LIMS are represented in XML format.

Module 4: Example Exercises

Module 5a: EPP in Operations Interface

This module focuses on how to configure a script to be run in the LIMS using the External Program Plugin tab of the Process configuration wizard in the Operations Interface (available in LIMS v4.x and earlier only).

Module 5a: Example Exercises

Module 5b: EPP/Automation in Lab Scientist Interface

This module covers enabling and invoking EPP / automation scripts from the Lab Scientist Interface. In particular, we focus on the possibilities available for both manual and automatic invocation.

Module 5b: Example Exercises