Web API for Workspace Elements: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Workspace Elements API (a.k.a. UI element API) is used by the Workspace in the Web UI to
Workspace Elements API (a.k.a. UI elements API) is used by the [[QPR_ProcessAnalyzer_Project_Workspace|Workspace]] to
* move multiple different types of items to another project, and
* move multiple items of different types to other project
* delete multiple different types of items
* delete items (multiple different types can be deleted at the same time)


==Methods==
==Methods==
<pre>
<pre>
POST /api/uielements/setproject/{projectid}
POST /api/uielements/setproject/{targetProjectId}
Body: (for example)
[
  { "id": 1, "type": null },
  { "id": 2, "type": "View" },
  { "id": 3, "type": "Model" },
  { "id": 4, "type": "Datatable" },
  { "id": 5, "type": "Script" }
]
</pre>
</pre>
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.
Moves projects (type is ''null''), dashboards (type is ''View''), models (type is ''Model''), datatables (type is ''Datatable'') and scripts (type is ''Script'') to another project. Takes as a body an array of objects to be moved, 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]].


<pre>
<pre>
DELETE /qprpa/api/uielements
DELETE /qprpa/api/uielements
</pre>
</pre>
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.
Deletes projects (type is ''null''), dashboards (type is ''View''), models (type is ''Model''), datatables (type is ''Datatable'') and scripts (type is ''Script''). 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 the [[Web_API_for_Models|deletePermanently]] query parameter which is applied when deleting models.


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

Latest revision as of 09:26, 29 April 2022

Workspace Elements API (a.k.a. UI elements API) is used by the Workspace to

  • move multiple items of different types to other project
  • delete items (multiple different types can be deleted at the same time)

Methods

POST /api/uielements/setproject/{targetProjectId}
Body: (for example)
[
  { "id": 1, "type": null },
  { "id": 2, "type": "View" },
  { "id": 3, "type": "Model" },
  { "id": 4, "type": "Datatable" },
  { "id": 5, "type": "Script" }
]

Moves projects (type is null), dashboards (type is View), models (type is Model), datatables (type is Datatable) and scripts (type is Script) to another project. Takes as a body an array of objects to be moved, with id and type properties. The method is useful when multiple objects are moved between projects. 

DELETE /qprpa/api/uielements

Deletes projects (type is null), dashboards (type is View), models (type is Model), datatables (type is Datatable) and scripts (type is Script). Takes as a body an array of objects, with id and type properties. The method is useful when multiple objects are deleted.

Support the deletePermanently query parameter which is applied when deleting models.

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