Documentation
The full REST API documentation is available in the "Developer Guide" section
In the Developer Guide, select the entity you need. The additional panel on the right shows the full list of attributes and their characteristics, REST API request examples, sample response data, the object model, and examples of PHP scripts for automation.
For each artifact you can quickly get a REST API link on the artifact edit form (Additional tab) or in the module where the artifact is displayed.
AI Features
AI features require a configured integration with AI services (Administration — Settings — Application).
To retrieve project artifacts that are similar in meaning, use a special endpoint:
/pm/my/api/latest/rag?entites=...&like=...
| Parameter | Parameter description |
|---|---|
| entities | A comma-separated list of entity class names to search for similar items, for example: Issue, Requirement, Increment |
| like | The phrase used to find artifacts that are similar in meaning. |
| distance | The similarity level controls the quality of the results. |
| standard parameters | You can learn the other standard parameters, such as fields, limit, and so on, in the Developer Guide. |