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 1: Line 1:
API for Workspace Elements (a.k.a. UI element API) is used by the Workspace in the Web UI to
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
* move multiple different types of items to another project, and
* delete multiple different types of items
* delete multiple different types of items


==UI Elements API==
==Methods==
<pre>
<pre>
POST /api/uielements/setproject/{projectid}
POST /api/uielements/setproject/{projectid}
</pre>
</pre>
Supports also models, and the ''moveLinkedDatatables'' query parameter (see PUT api/models/{id}).
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 for moving [[Web_API_for_Models|models]].


<pre>
<pre>
DELETE /qprpa/api/uielements
DELETE /qprpa/api/uielements
</pre>
</pre>
Support also models, and the ''deletePermanently'' query parameter (see DELETE api/models/{id}).
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 for deleting [[Web_API_for_Models|models]].


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Revision as of 16:29, 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 for 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 for deleting models.

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=Web_API_for_Workspace_Elements&oldid=17129"