Rest APIs
The REST API is the first one that will be officially supported. It is the base level API that communicates with the Tandem data server and manages create/read/write/delete of property data for assets. These asset properties are also called “parameters” in the Tandem client app, and those names are interchangeable in this documentation.
The REST API is a thin layer over the underlying Tandem database. It is designed to be very efficient and powerful, but with that comes some slightly cryptic payloads and some calls that could cause unwanted changes to the facility data if not constructed properly. We advise that you avoid calling endpoints that we mark with WARNINGs, and we advise that you do comprehensive testing on datasets that you can afford to recreate before deploying on critical datasets.
In general, the recommendation is to use the Tandem client application to setup Facilities and create Parameters. Then once a Facility is setup, use the REST API to read/write asset properties or assign classifications to assets.
A Postman collection is provided to allow interactive testing of the REST APIs. It also has sample payloads that explain the various options. Details on how to use the Postman collection can be found here: Tandem Postman Collection. The Postman collection also includes basic documentation for each REST endpoint.
Additional notes about calling the most commonly used endpoints for read/write of asset properties, and for assigning classifications to assets can be found here:
- Read/Query properties (/scan): Read
- Write properties (/mutate): Write
- Classification and Parameter assignment: Classification
- Qualified Property Names (/attrs): QualifiedProperties
- Documents: Documents
A sample project using the REST API can be found here: REST Sample