Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability.

The Project Insight REST API can be accessed within the Project Insight Web Application directly using JavaScript, with the current logged on user context, without needing to use an API token. You may also interact with the REST API remotely, but in those instances you must pass the API Token above in the header for each call, along with an authentication token retrieved from the Authentication REST service.

We have included Swagger representation and documentation for the REST API. It can be accessed through the API Settings page under Administration » Integration » API (REST).

Once loaded, you will be presented with all the classes and methods, so that you can test by invoking them through the Swagger interface. In this example, we can see Project and all the methods to perform 'GET', 'POST' and 'DELETE' calls.

If you click on the 'GET' method for '/project/active', you will be able to choose the Response Content Type and choose the ModelProperties you want to return from the object. In this specific method, there are no required parameters, but other methods may require various parameters such as:

  • Id
  • Name
  • ContainerId
  • ProjectId
  • JSON Object

In the Parameters section, you can set the Parameter, Value, Description, Parameter Type and the Data Type expected for the method.

Online 12/9/2016