Web API for Workspace Elements: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
Workspace Elements API (a.k.a. UI | Workspace Elements API (a.k.a. UI elements API) is used by the [[QPR_ProcessAnalyzer_Project_Workspace|Workspace]] to | ||
* move multiple different types | * move multiple items of different types to other project | ||
* delete items (multiple different types can be deleted at the same time) | * delete items (multiple different types can be deleted at the same time) | ||
| Line 15: | Line 15: | ||
] | ] | ||
</pre> | </pre> | ||
Moves projects, dashboards, models, datatables and scripts to another project. Takes as a body an array of objects, with ''id'' and ''type'' properties | 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, 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. | ||
Revision as of 09:12, 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/{projectId}
Body:
[
{ "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, 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
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 models.