Web API for Workspace Elements: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
Used to move projects, dashboards, models and datatables 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.
Used to move projects, dashboards, models and datatables 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 [[Web_API_for_Models|models]].
Supports also the [[Web_API_for_Models|moveLinkedDatatables]] query parameter which is applied when moving models.


<pre>
<pre>
Line 16: Line 16:
Used to delete projects, dashboards, models and  datatables. Takes as a body an array of objects, with ''id'' and ''type'' properties. The method is useful when multiple objects are deleted.
Used to delete projects, dashboards, models and  datatables. 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 [[Web_API_for_Models|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 16:44, 1 November 2020

Workspace Elements API (a.k.a. UI element API) is used by the Workspace in the Web UI to

  • move multiple different types of items to another project, and
  • delete multiple different types of items

Methods

POST /api/uielements/setproject/{projectid}

Used to move projects, dashboards, models and datatables 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 and datatables. 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.