RESTful Engine Client Reference

RESTful Engine Clients – Version 2#

note

This page is for the RESTful client API version 2 (v2). This is first available in the RESTful engine 20.1. Previous versions only support API version 1 (v1).

The RESTful engine 20.1 and later supports both v1 and v2. It is strongly recommended that you use the v2 API, which is fully asynchronous.

These are the latest versions of the different clients:

  • .NET Standard Client version 22.2.0.4
  • Java Client version 22.1.0.0
  • JavaScript Client version 22.0.35
  • Python Client 21.0.0.11

Requests#

The engine can have calls to request three things: generate a document, get a template’s metrics, and get a template’s tag tree (there’s also a getVersion call).

For all three requests they break down into the following steps:

  1. Submit the request.
  2. Get the status to see if it is complete (you can also send a callback in the initial request).
  3. Get the generated document/metrics/tag tree. Or if there was an error, get the error.
  4. Delete the generated document/metrics/tag tree from the server.

Windward Supported Clients#

Windward supports the following clients. These clients are supported by our support team and we will fix any bugs discovered in them. We strongly recommend you use these clients.

.Net Standard 2.0 Client#

The .Net client works with C#, VB.Net, and any other .Net language. It is .Net Standard 2.0; therefore, it works on .Net Framework 4.6.1 and later, as well as .Net Core 3.1 and later.

It uses the .Net async/await constructs on everything. So, all calls in the API are asynchronous.

We provide the following resources:

Java 1.8 Client#

The Java client works with Java 1.8 and later.

Because there are no asynchronous web client classes, the individual calls in the Java client are synchronous. But the REST server is still asynchronous, so you still have the individual calls over the course of a request.

We provide the following resources:

JavaScript Client#

The JavaScript client uses the async node-fetch library to make requests. So all calls in the API are asynchronous.

We provide the following resources:

Python Client#

The python client uses a Requests library which processes all API call asynchronously. While the requests are being handled async on the backend, all client method calls will be synchronous in nature.

We provide the following resources:

note

Windward does not support any clients created using Swagger. But we do support our Swagger yaml file and will fix any issues in that and answer questions about it.