Web Services API

Clarity is in the midst of a transition between Web Services APIs - the traditional Clarity Web Services API is SOAP-based, and is the most fully-developed. It is used internally by Clarity components to interact. The newer Web Services API is REST-based, and is just becoming available.

The newer REST Web Services enable a variety of operations, including:

Authorization - using a simplified oAuth model, or a userID-based model.

ArchiveProject - create archives of Clarity projects
Project - querying existing projects and creating new projects via API
BIM360Project - querying a list of BIM360 projects that Clarity is aware of.
TaskServer - querying existing task servers and performing basic operations on them.
Task - querying existing tasks in the queue, as well as launching new tasks
RevitWorkstation - reporting on workstation versions, builds and addin data
ModelTime - reporting on the modeling time spent on Revit models.
Users - creation, modification or deletion of Clarity Users
Groups - creation, modification or deletion of Clarity Groups
Logs - add log entries to the central host log facility
Metric Collection - post model health metrics to a specific project/model in Clarity

You can access the Swagger-style API Explorer at:

http://<yourserver>/CentralServerWebservices/api/docs/index

To try out the API, you'll need to first call the Authorization API - retrieve a token which you can then put into the API Explorer and interactively explore the results.

The traditional Clarity Web Services API is a SOAP-based interface that enables you to interact with Clarity remotely. This includes:

A Security Service for authentication
A Task Service for launching tasks
A Project Service for creating new Projects
A Health Service for keeping track of performance metrics
An Admin Service for managing users
A ChangeRequest Service for managing bi-directional Revit change requests

For more information on the Web Services API, contact IMAGINiT Support.