Fluid Topics Web Services - Fluid Topics - 3.4 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.4
Category
Reference Guides
Language
English
Target Audience
public

Fluid Topics exposes some of its features through JSON-based REST web services.

Fluid Topics web services are backward compatible.

It is possible to add fields to enrich the output format. If using an object mapper to decode the output, the mapper should be configured to ignore unknown fields.

The descriptions of web services in this chapter always give a path and not a complete URL. It is necessary to prefix the path with the Fluid Topics portal root URL to get the full URL to call.

It is necessary to define certain parameters in the HTTP header of each API call.

The web services are presented as follows:

Methods

Description

GET

Used to retrieve information.

POST

Used to upload data.

PUT

Used to modify data.

DELETE

Used to delete data.

Endpoint

The endpoint is used to call the specific API.

To apply the GET method, it can simply be added at the end of the URL, for example:

http://doc.antidot.net/api/users

Other methods (PUT, POST, DELETE) might necessitate a Rest API client.

Example of a call to a web service with CURL

$ curl http://doc.antidot.net/api/users -u root@fluidtopics.com:PASSWORD
[{"id":"f6799959-765e-4319-a156-c09ad3251366","displayName":"Fluid Topics Root User","emailAddress":"root@fluidtopics.com"}]

Where -u or --user, the CURL parameter for "HTTP Basic Authentication", can be used from Fluid Topics version 3.4.12.

For more information about web services, see Representational state transfer applied to web services.