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:
- Log in to your SIT Alemira Virtual Lab account.
- Click the profile icon in the right upper corner of the screen and select Settings.
- Click the library to which you need to add an object.
- Click Add object and 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).
- Fields — fields 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.
- Click Add.