Adding API objects

Created by Ekaterina Zayats, Modified on Mon, 19 Sep 2022 at 03:59 PM by Boyko Cholakov

API objects are used to set templates for lab  life-cycle actions.

An API object contains the details of an API call: the endpoint to use, parameters to transfer, and other auxiliary settings.

API objects are grouped into libraries. Before adding API objects, you need to create a library.

To add an object to an API library:

  1. Log in to your SIT Alemira Virtual Lab account.
  2. Click the profile icon in the right upper corner of the screen and select Settings.
  3. Click the library to which you need to add an object.
  4. Click Add objectand specify the following:

    • Name — the object name.

    • Description — a short description explaining what action the API call performs.

    • Body prefix — a prefix used to ease the search for parameters in an output (for example, when the output is voluminous and complex).

    • Method — the HTTP method to use for the call execution (GET, POST, PUT, or DELETE).

    • Path —the endpoint to use for calls.

    • Status — the status received on a successful call execution.

    • Templating — mapping between parameters received from an external system and internal parameter names (in the JSON format).

    • Fieldsfields are used to specify parameters that must be present in an output (API response) to meet the pass criteria of a step. 

    • Sample input — an example of API request sent to the external system.

    • Sample output — an example of API response received from the external system.

    • Query — an HTTP request query.

  5. Click Add.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article