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.

...

12/ Click the Save button. You should see a green-colored message dialog stating Request created successfully. The Request should show in the table under the Requests tab of the Collections and Requests panel.

...

13/ Click on the X button on the top RHS of the Collections and Requests panel, as shown in the figure above.

...

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.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

The response is shown with the following details.

  • The square bracket [ ] icon indicates that the response is an array

  • The text Response from [GET ‘rockets’] indicates that this is the response from the GET Request sent to the rockets endpoint. See the URL for the Request in Step 11 above.

  • The number (4) next to the response indicates the number of members in that response (4 rockets in this case).

...

16/ Expand Response from [GET ‘rockets’] (4). You will see data for each of the 4 rockets.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Curly brace icon { } indicates that the data is a JSON object (key-value pairs). The number (23) indicates that the object includes 23 key-value pairs, or 23 fields with values.

...

17/ Expand the data for the first rocket. You will see all the 23 key-value pairs. The name of this rocket is Falcon 1 (rocket_name) and the id of this rocket is falcon1 (rocket_id).

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Responses are shown with the following icons that match standard JSON syntax

  • Square brackets [ ] indicate arrays of JSON objects

  • Curly braces { } indicate a single JSON object with key-value pairs

  • “ “ indicate primitive data, e.g. Strings, Integers, Booleans, Float/Double, etc.

...

18/ Now, let’s add another request to get all the SpaceX payloads. To do this, launch the Collections and Requests panel by right-clicking the SpaceX Data repository (or the default Collection or the Get all Rockets Request) in the Tree View (Hint: See Step 7) and click on the Requests tab.

...

19/ The Request to get all payloads is similar to the one to get all rockets.

...

So, we will clone the Get all Rockets Request and modify it. Click on the Clone icon shown under the Actions columns of the Get all Rockets row.

...