Versions Compared

Key

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

Syndeia Cloud's REST API is published using Swagger which provides a platform for interactive documentation - learn about the REST endpoints  and also try them out directly in the documentation. 

Table of Contents
outlinetrue

Accessing REST API documentation

...

The Swagger REST API Documentation page should open as shown below. The REST endpoints are organized based on the simple conceptual presented conceptual model presented in the previous section (see here).

...

2.  Click the Try it out button on the right-hand side (RHS). The "User info for signIn" fields should show up.   

...

10.  Now you should be able to use any of the other API endpoints on the page and have your token automatically submitted with your requests.
    Example Java client for Syndeia Cloud

Syndeia Cloud also comes with an example Java project (Eclipse and IntelliJ) that demonstrates how to use the REST API. This example project is available for download in the following ways.

  • Available with the Syndeia Cloud download. Check with your admin.
  • Available with the tutorials in all three Syndeia clients - MagicDraw plugin, Rhapsody plugin, and Syndeia Standalone.