Web API for Workspace Elements: Difference between revisions
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
==Methods== | ==Methods== | ||
<pre> | <pre> | ||
POST /api/uielements/setproject/{ | POST /api/uielements/setproject/{targetProjectId} | ||
Body: | Body: (for example) | ||
[ | [ | ||
{ "id": 1, "type": null }, | { "id": 1, "type": null }, | ||
| Line 15: | Line 15: | ||
] | ] | ||
</pre> | </pre> | ||
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. | 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. | ||
<pre> | <pre> | ||
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.