What Is Available When Using the Clarity REST API?

book

Article ID: 197785

calendar_today

Updated On:

Products

Clarity PPM On Premise Clarity PPM SaaS

Issue/Introduction

Is it possible to get instances of object 'X' using the REST API?

Is attribute 'Y' available when getting an instance?

Can I update/delete those instances?

...

 

In general: How can I check what is possible to do (and by extension, what is not) with the Clarity REST API?

Environment

Clarity 15.7 and higher (REST API is not available or not supported for end Customer use in earlier Clarity releases).

New in 15.7 - Clarity PPM Rest APIs Support

Resolution

All the REST API endpoints, along with examples and the possibility of running them, can be found in the API Documentation URL (Administration > General Settings > API Documentation URL).

This page will list all supported public REST APIs available for that specific release. Please note that if an API is not described in the API Documentation URL, it is not a supported API.