Hit enter to search.
We are happy to announce our MyRapidi REST API.
The MyRapidi REST API can be used to automate many different tasks related to working with the MyRapidi configuration. In this blog post, we will focus on one specific scenario in order to learn how to use the REST API.
We have chosen a scenario where we will update a specific Schedule to run now and also check the status of that schedule.
Again, in order to learn how to use the REST API, we will use a plugin to chrome called RESTlet. When actually implementing this scenario in your environment, you will most likely use another tool, depending on your environment.
In order to use the MyRapidi REST API, you will need a login (and password) for an active MyRapidi account with an active Service (you will need the service Id that can be found in the URL when you log in to MyRapidi).
Note: In the below examples you need to substitute the login and password with your own login and password and also substitute the Service Id (80) with your own Service Id.
To create the project, schedule, and requests you see above, simply use the button to create the project, then the Scenario, and finally the four requests inside the Scenario.
To create a request using the syntax used in our MyRapidi REST API, we use RESTlet's Request Constructor.
Here's the correspondence between how the example curl requests in our REST API documentation are written, and how it looks in the Request Constructor:
in our documentation for the Authentication Token request:
in RESTlet's Request Constructor (Notice the absence of the \ symbols and the biggest "" pair from the body content, as compared to the curl command):
Re-using the result of previous queries:
Expressions are a feature of RESTlet that allows us to easily use parts of preceding requests, including their results, in future requests.
If you need any help please contact support.
This post was contributed by Peter Bock who is in his last year in Bordeaux Bioinformatics Master of Science, combining his passion for computers and technology with his interest in biology. He has been testing the MyRapidi API and while working with it in an editor resulted in this blog post. Peter's Linkedin Profile
Michael Bock, Founder & CEO
[Webinar Replay] An Introduction to MyRapidi - March 2024
[Webinar Replay] MyRapidi Product Update Webinar March 2024
Walkthrough of MyRapidi Configuration Interface
Carrer de la Font del Colom, 6,
L'Aldosa,
AD400 La Massana, Andorra
Copyright © 2024 Rapidi.
All Rights Reserved
Terms & Conditions |
Privacy Policy