Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is the first hands-on exercise to learn about the Syndeia RESTful Integration capability introduced in Syndeia 3.5.

...

The learning objectives of this exercise are as follows:

  1. Add a new RESTful repository in the Syndeia Web Dashboard

  2. Add a new Request to fetch data from the RESTful repository

  3. View and browse the Response to the Request

Preparation

This exercise assumes that the student has done the following preparations.

  1. Reviewed the content presented in Introduction to REST APIs and Syndeia RESTful Integration

  2. Able to access Syndeia Cloud 3.5 with a valid user account

  3. User account in Syndeia Cloud 3.5 has RESTFUL WRITE permission (contact Syndeia Cloud admin to verify)

Exercise

1/ Login to the Syndeia Cloud Web Dashboard and select the Repositories menu on the menu bar.

...

  • Repository type = RESTful (already selected)

  • URL = https://api.spacexdata.com/v3

  • Name = SpaceX Data

  • Description = SpaceX Data RESTful repository.

  • Authentication Type = None

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

It is helpful to give meaningful names and descriptions to your repositories so that you can easily identify them later. You can

...

set the name and description fields in the form above to other values.

...

4/ Click on the Create button.

...

14/ Expand the Default RESTful Request Collection. The new request Get all Rockets was added to the default collection since we did not specify a collection when creating the request. This request is a GET request and hence it is shown with a G icon.

...

15/ Expand the Get all Rockets request (G icon). Syndeia will send the request to the RESTful repository and if successful, the response will be shown under the request. In the figure shown below, the Request was successful and the resulting response includes data for 4 rockets.

...