Web API for Workspace Elements: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Workspace Elements API (a.k.a. UI element API) is used by the Workspace | Workspace Elements API (a.k.a. UI element API) is used by the Workspace to | ||
* move multiple different types of items to another project | * move multiple different types of items to another project | ||
* delete multiple different types | * delete items (multiple different types can be deleted at the same time) | ||
==Methods== | ==Methods== | ||
| Line 7: | Line 7: | ||
POST /api/uielements/setproject/{projectid} | POST /api/uielements/setproject/{projectid} | ||
</pre> | </pre> | ||
Used to move projects, dashboards, models and | Used to move projects, dashboards, models, datatables and scripts to another project. Takes as a body an array of objects, with ''id'' and ''type'' properties. The method is useful when multiple objects are moved between projects. | ||
Supports also the [[Web_API_for_Models|moveLinkedDatatables]] query parameter which is applied when moving models. | Supports also the [[Web_API_for_Models|moveLinkedDatatables]] query parameter which is applied when moving models. | ||
| Line 14: | Line 14: | ||
DELETE /qprpa/api/uielements | DELETE /qprpa/api/uielements | ||
</pre> | </pre> | ||
Used to delete projects, dashboards, models and | Used to delete projects, dashboards, models, datatables and scripts. Takes as a body an array of objects, with ''id'' and ''type'' properties. The method is useful when multiple objects are deleted. | ||
Support also the [[Web_API_for_Models|deletePermanently]] query parameter which is applied when deleting models. | Support also the [[Web_API_for_Models|deletePermanently]] query parameter which is applied when deleting models. | ||
[[Category: QPR ProcessAnalyzer]] | [[Category: QPR ProcessAnalyzer]] | ||
Revision as of 12:06, 9 March 2021
Workspace Elements API (a.k.a. UI element API) is used by the Workspace to
- move multiple different types of items to another project
- delete items (multiple different types can be deleted at the same time)
Methods
POST /api/uielements/setproject/{projectid}
Used to move projects, dashboards, models, datatables and scripts to another project. Takes as a body an array of objects, with id and type properties. The method is useful when multiple objects are moved between projects.
Supports also the moveLinkedDatatables query parameter which is applied when moving models.
DELETE /qprpa/api/uielements
Used to delete projects, dashboards, models, datatables and scripts. Takes as a body an array of objects, with id and type properties. The method is useful when multiple objects are deleted.
Support also the deletePermanently query parameter which is applied when deleting models.