{ "opencollection": "1.0.0", "info": { "name": "Baserow API spec Admin Applications API", "version": "2.2.2" }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "list_all_applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/applications/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all the applications that the user has access to. The properties that belong to the application can differ per type. An application always belongs to a single workspace. All the applications of the workspaces that the user has access to are going to be listed here." }, { "info": { "name": "workspace_get_application", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/applications/:application_id/", "params": [ { "name": "application_id", "value": "", "type": "path", "description": "Returns the application related to the provided value." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the requested application if the authorized user is in the application's workspace. The properties that belong to the application can differ per type." }, { "info": { "name": "workspace_update_application", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/applications/:application_id/", "headers": [ { "name": "ClientSessionId", "value": "" }, { "name": "ClientUndoRedoActionGroupId", "value": "" } ], "params": [ { "name": "application_id", "value": "", "type": "path", "description": "Updates the application related to the provided value." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the existing application related to the provided `application_id` param if the authorized user is in the application's workspace. It is not possible to change the type, but properties like the name can be changed." }, { "info": { "name": "workspace_delete_application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/applications/:application_id/", "headers": [ { "name": "ClientSessionId", "value": "" }, { "name": "ClientUndoRedoActionGroupId", "value": "" } ], "params": [ { "name": "application_id", "value": "", "type": "path", "description": "Deletes the application related to the provided value." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes an application if the authorized user is in the application's workspace. All the related children are also going to be deleted. For example in case of a database application all the underlying tables, fields, views and rows are going to be deleted." }, { "info": { "name": "duplicate_application_async", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/applications/:application_id/duplicate/async/", "headers": [ { "name": "ClientSessionId", "value": "" }, { "name": "ClientUndoRedoActionGroupId", "value": "" } ], "params": [ { "name": "application_id", "value": "", "type": "path", "description": "The id of the application to duplicate." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Duplicate an application if the authorized user is in the application's workspace. All the related children are also going to be duplicated. For example in case of a database application all the underlying tables, fields, views and rows are going to be duplicated." }, { "info": { "name": "workspace_list_applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/applications/workspace/:workspace_id/", "params": [ { "name": "workspace_id", "value": "", "type": "path", "description": "Returns only applications that are in the workspace related to the provided value." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all the applications of the workspace related to the provided `workspace_id` parameter if the authorized user is in that workspace. If theworkspace is related to a template, then this endpoint will be publicly accessible. The properties that belong to the application can differ per type. An application always belongs to a single workspace." }, { "info": { "name": "workspace_create_application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/applications/workspace/:workspace_id/", "headers": [ { "name": "ClientSessionId", "value": "" }, { "name": "ClientUndoRedoActionGroupId", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path", "description": "Creates an application for the workspace related to the provided value." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new application based on the provided type. The newly created application is going to be added to the workspace related to the provided `workspace_id` parameter. If the authorized user does not belong to the workspace an error will be returned." }, { "info": { "name": "workspace_order_applications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/applications/workspace/:workspace_id/order/", "headers": [ { "name": "ClientSessionId", "value": "" }, { "name": "ClientUndoRedoActionGroupId", "value": "" } ], "params": [ { "name": "workspace_id", "value": "", "type": "path", "description": "Updates the order of the applications in the workspace related to the provided value." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the order of the provided application ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the not provided tables will be set to `0`." } ] } ], "bundled": true }