Web API for Workspace Elements: Difference between revisions
No edit summary |
|||
Line 6: | Line 6: | ||
<pre> | <pre> | ||
POST /api/uielements/setproject/{projectId} | 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" } | |||
] | |||
</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 (type is one of the following: Project, View, Model, DataTable, Script). The method is useful when multiple objects are moved between projects. | Moves projects, dashboards, models, datatables and scripts to another project. Takes as a body an array of objects, with ''id'' and ''type'' properties (type is one of the following: Project, View, Model, DataTable, Script). The method is useful when multiple objects are moved between projects. |
Revision as of 09:07, 29 April 2022
Workspace Elements API (a.k.a. UI element API) is used by the Workspace to
- move multiple different types of items to another 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, dashboards, models, datatables and scripts to another project. Takes as a body an array of objects, with id and type properties (type is one of the following: Project, View, Model, DataTable, Script). 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, dashboards, models, datatables and scripts. Takes as a body an array of objects, with id and type properties (type is one of the following: Project, View, Model, DataTable, Script). The method is useful when multiple objects are deleted.
Support also the deletePermanently query parameter which is applied when deleting models.