RESTful API Modeling Language (RAML) is a YAML based language that describes the RESTful APIs. RAML also provides facilities to extensively document a RESTful API, enable documentation generator tools to extract the user documentation, and then translate it to visual formats such as PDF, HTML, and so on.
RAML specification version 0.8 is supported.
Use this action to access the APIs and make API calls to the service for which the APIs are built using RAML.
Using the RAML Action
To use this action in your workflow, connect it to ThingWorx Flow. To connect to the flow, do the following:
1. Click and drag the RAML action listed under the API Design utility on the canvas, place the pointer on the action, and then click or double-click the action. The RAML action window opens.
2. Edit the label name, if needed. By default, the label name is same as the action name.
3. In the Root file URL field, enter the URL to fetch the zip file containing the root RAML file and its dependencies.
4. In the Root file name field, enter the name of RAML root file to fetch.
5. Click Fetch to configure the underlying API.
6. Click Done.
Output Schema
The RAML action returns an output schema as shown in the figure that follows: