{ "openapi": "3.0.3", "info": { "title": "tables", "version": "0.0.1", "description": "Manage data the way you need it.", "license": { "name": "agpl" } }, "components": { "securitySchemes": { "basic_auth": { "type": "http", "scheme": "basic" }, "bearer_auth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Capabilities": { "type": "object", "required": [ "tables" ], "properties": { "tables": { "type": "object", "required": [ "enabled", "version", "apiVersions", "features", "isCirclesEnabled", "column_types" ], "properties": { "enabled": { "type": "boolean" }, "version": { "type": "string" }, "apiVersions": { "type": "array", "items": { "type": "string" } }, "features": { "type": "array", "items": { "type": "string" } }, "isCirclesEnabled": { "type": "boolean" }, "column_types": { "type": "array", "items": { "type": "string" } } } } } }, "Column": { "type": "object", "required": [ "id", "title", "tableId", "createdBy", "createdAt", "lastEditBy", "lastEditAt", "type", "subtype", "mandatory", "description", "orderWeight", "numberDefault", "numberMin", "numberMax", "numberDecimals", "numberPrefix", "numberSuffix", "textDefault", "textAllowedPattern", "textMaxLength", "textUnique", "selectionOptions", "selectionDefault", "datetimeDefault", "usergroupDefault", "usergroupMultipleItems", "usergroupSelectUsers", "usergroupSelectGroups", "usergroupSelectTeams", "showUserStatus", "viewColumnInformation", "customSettings" ], "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string" }, "tableId": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "lastEditBy": { "type": "string" }, "lastEditAt": { "type": "string" }, "type": { "type": "string" }, "subtype": { "type": "string" }, "mandatory": { "type": "boolean" }, "description": { "type": "string" }, "orderWeight": { "type": "integer", "format": "int64" }, "numberDefault": { "type": "number", "format": "double" }, "numberMin": { "type": "number", "format": "double" }, "numberMax": { "type": "number", "format": "double" }, "numberDecimals": { "type": "integer", "format": "int64" }, "numberPrefix": { "type": "string" }, "numberSuffix": { "type": "string" }, "textDefault": { "type": "string" }, "textAllowedPattern": { "type": "string" }, "textMaxLength": { "type": "integer", "format": "int64" }, "textUnique": { "type": "boolean" }, "selectionOptions": { "type": "string" }, "selectionDefault": { "type": "string" }, "datetimeDefault": { "type": "string" }, "usergroupDefault": { "type": "string" }, "usergroupMultipleItems": { "type": "boolean" }, "usergroupSelectUsers": { "type": "boolean" }, "usergroupSelectGroups": { "type": "boolean" }, "usergroupSelectTeams": { "type": "boolean" }, "showUserStatus": { "type": "boolean" }, "viewColumnInformation": { "type": "object", "nullable": true, "required": [ "columnId", "order", "readonly", "mandatory" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "order": { "type": "integer", "format": "int64" }, "readonly": { "type": "boolean" }, "mandatory": { "type": "boolean" } } }, "customSettings": { "type": "object", "nullable": true, "required": [ "width" ], "properties": { "width": { "type": "integer", "format": "int64" } } } } }, "Context": { "type": "object", "required": [ "id", "name", "iconName", "description", "owner", "ownerType" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "iconName": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "string" }, "ownerType": { "type": "integer", "format": "int64" } } }, "ContextNavigation": { "type": "object", "required": [ "id", "shareId", "displayMode", "userId" ], "properties": { "id": { "type": "integer", "format": "int64" }, "shareId": { "type": "integer", "format": "int64" }, "displayMode": { "type": "integer", "format": "int64" }, "userId": { "type": "string" } } }, "ImportState": { "type": "object", "required": [ "found_columns_count", "matching_columns_count", "created_columns_count", "inserted_rows_count", "updated_rows_count", "errors_parsing_count", "errors_count" ], "properties": { "found_columns_count": { "type": "integer", "format": "int64" }, "matching_columns_count": { "type": "integer", "format": "int64" }, "created_columns_count": { "type": "integer", "format": "int64" }, "inserted_rows_count": { "type": "integer", "format": "int64" }, "updated_rows_count": { "type": "integer", "format": "int64" }, "errors_parsing_count": { "type": "integer", "format": "int64" }, "errors_count": { "type": "integer", "format": "int64" } } }, "Index": { "type": "object", "required": [ "tables", "views" ], "properties": { "tables": { "type": "array", "items": { "$ref": "#/components/schemas/Table" } }, "views": { "type": "array", "items": { "$ref": "#/components/schemas/View" } } } }, "OCSMeta": { "type": "object", "required": [ "status", "statuscode" ], "properties": { "status": { "type": "string" }, "statuscode": { "type": "integer" }, "message": { "type": "string" }, "totalitems": { "type": "string" }, "itemsperpage": { "type": "string" } } }, "Row": { "type": "object", "required": [ "id", "tableId", "createdBy", "createdAt", "lastEditBy", "lastEditAt", "data" ], "properties": { "id": { "type": "integer", "format": "int64" }, "tableId": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "lastEditBy": { "type": "string" }, "lastEditAt": { "type": "string" }, "data": { "type": "object", "nullable": true, "required": [ "columnId", "value" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "value": { "type": "object" } } } } }, "Share": { "type": "object", "required": [ "id", "sender", "receiver", "receiverDisplayName", "receiverType", "nodeId", "nodeType", "permissionRead", "permissionCreate", "permissionUpdate", "permissionDelete", "permissionManage", "createdAt", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int64" }, "sender": { "type": "string" }, "receiver": { "type": "string" }, "receiverDisplayName": { "type": "string" }, "receiverType": { "type": "string" }, "nodeId": { "type": "integer", "format": "int64" }, "nodeType": { "type": "string" }, "permissionRead": { "type": "boolean" }, "permissionCreate": { "type": "boolean" }, "permissionUpdate": { "type": "boolean" }, "permissionDelete": { "type": "boolean" }, "permissionManage": { "type": "boolean" }, "createdAt": { "type": "string" }, "createdBy": { "type": "string" } } }, "Table": { "type": "object", "required": [ "id", "title", "emoji", "ownership", "ownerDisplayName", "createdBy", "createdAt", "lastEditBy", "lastEditAt", "archived", "favorite", "isShared", "onSharePermissions", "hasShares", "rowsCount", "views", "columnsCount" ], "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string" }, "emoji": { "type": "string", "nullable": true }, "ownership": { "type": "string" }, "ownerDisplayName": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "lastEditBy": { "type": "string" }, "lastEditAt": { "type": "string" }, "archived": { "type": "boolean" }, "favorite": { "type": "boolean" }, "isShared": { "type": "boolean" }, "onSharePermissions": { "type": "object", "nullable": true, "required": [ "read", "create", "update", "delete", "manage" ], "properties": { "read": { "type": "boolean" }, "create": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" }, "manage": { "type": "boolean" } } }, "hasShares": { "type": "boolean" }, "rowsCount": { "type": "integer", "format": "int64" }, "views": { "type": "array", "items": { "$ref": "#/components/schemas/View" } }, "columnsCount": { "type": "integer", "format": "int64" } } }, "View": { "type": "object", "required": [ "id", "title", "emoji", "tableId", "ownership", "ownerDisplayName", "createdBy", "createdAt", "lastEditBy", "lastEditAt", "description", "columns", "columnSettings", "sort", "filter", "isShared", "favorite", "onSharePermissions", "hasShares", "rowsCount" ], "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string" }, "emoji": { "type": "string", "nullable": true }, "tableId": { "type": "integer", "format": "int64" }, "ownership": { "type": "string" }, "ownerDisplayName": { "type": "string", "nullable": true }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "lastEditBy": { "type": "string" }, "lastEditAt": { "type": "string" }, "description": { "type": "string", "nullable": true }, "columns": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "columnSettings": { "type": "array", "items": { "type": "object", "required": [ "columnId", "order", "readonly" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "order": { "type": "integer", "format": "int64" }, "readonly": { "type": "boolean" } } } }, "sort": { "type": "array", "items": { "type": "object", "required": [ "columnId", "mode" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "mode": { "type": "string", "enum": [ "ASC", "DESC" ] } } } }, "filter": { "type": "array", "items": { "type": "array", "items": { "type": "object", "required": [ "columnId", "operator", "value" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "operator": { "type": "string", "enum": [ "begins-with", "ends-with", "contains", "does-not-contain", "is-equal", "is-not-equal", "is-greater-than", "is-greater-than-or-equal", "is-lower-than", "is-lower-than-or-equal", "is-empty" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer", "format": "int64" }, { "type": "number", "format": "double" } ] } } } } }, "isShared": { "type": "boolean" }, "favorite": { "type": "boolean" }, "onSharePermissions": { "type": "object", "nullable": true, "required": [ "read", "create", "update", "delete", "manage" ], "properties": { "read": { "type": "boolean" }, "create": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" }, "manage": { "type": "boolean" } } }, "hasShares": { "type": "boolean" }, "rowsCount": { "type": "integer", "format": "int64" } } } } }, "paths": { "/index.php/apps/tables/api/1/tables": { "get": { "operationId": "api1-index", "summary": "Returns all Tables", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Table" } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-table", "summary": "Create a new table and return it", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the table" }, "emoji": { "type": "string", "nullable": true, "description": "Emoji for the table" }, "template": { "type": "string", "default": "custom", "description": "Template to use if wanted" } } } } } }, "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Table" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}": { "put": { "operationId": "api1-update-table", "summary": "Update tables properties", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "default": null, "description": "New table title" }, "emoji": { "type": "string", "nullable": true, "default": null, "description": "New table emoji" }, "archived": { "type": "boolean", "default": false, "description": "Whether the table is archived" } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Table" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "get": { "operationId": "api1-get-table", "summary": "Get a table object", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Table returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Table" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "api1-delete-table", "summary": "Delete a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Deleted table returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Table" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/scheme": { "get": { "operationId": "api1-show-scheme", "summary": "returns table scheme", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Scheme returned", "headers": { "Content-Disposition": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Table" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/views": { "get": { "operationId": "api1-index-views", "summary": "Get all views for a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Views returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/View" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-view", "summary": "Create a new view for a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title for the view" }, "emoji": { "type": "string", "nullable": true, "description": "Emoji for the view" } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID that will hold the view", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/views/{viewId}": { "get": { "operationId": "api1-get-view", "summary": "Get a view object", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "put": { "operationId": "api1-update-view", "summary": "Update a view via key-value sets", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "description": "fields of the view with their new values", "properties": { "title": { "type": "string" }, "emoji": { "type": "string" }, "description": { "type": "string" }, "columns": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "columnSettings": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "integer", "format": "int64" }, "order": { "type": "integer", "format": "int64" }, "readonly": { "type": "boolean" }, "mandatory": { "type": "boolean" } } } }, "sort": { "type": "array", "items": { "type": "object", "required": [ "columnId", "mode" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "mode": { "type": "string", "enum": [ "ASC", "DESC" ] } } } }, "filter": { "type": "array", "items": { "type": "array", "items": { "type": "object", "required": [ "columnId", "operator", "value" ], "properties": { "columnId": { "type": "integer", "format": "int64" }, "operator": { "type": "string", "enum": [ "begins-with", "ends-with", "contains", "does-not-contain", "is-equal", "is-not-equal", "is-greater-than", "is-greater-than-or-equal", "is-lower-than", "is-lower-than-or-equal", "is-empty" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer", "format": "int64" }, { "type": "number", "format": "double" } ] } } } } } } } } } } } }, "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Invalid data", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "api1-delete-view", "summary": "Delete a view", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/shares/{shareId}": { "get": { "operationId": "api1-get-share", "summary": "Get a share object", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "shareId", "in": "path", "description": "Share ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Share returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found/No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "api1-delete-share", "summary": "Delete a share", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "shareId", "in": "path", "description": "Share ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "put": { "operationId": "api1-update-share-permissions", "summary": "Update a share permission", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "permissionType", "permissionValue" ], "properties": { "permissionType": { "type": "string", "description": "Permission type that should be changed" }, "permissionValue": { "type": "boolean", "description": "New permission value" } } } } } }, "parameters": [ { "name": "shareId", "in": "path", "description": "Share ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/views/{viewId}/shares": { "get": { "operationId": "api1-index-view-shares", "summary": "Get all shares for a view Will be empty if view does not exist", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Shares returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Share" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/shares": { "get": { "operationId": "api1-index-table-shares", "summary": "Get all shares for a table Will be empty if table does not exist", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Shares returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Share" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-table-share", "summary": "Create a share for a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "receiver", "receiverType", "permissionRead", "permissionCreate", "permissionUpdate", "permissionDelete", "permissionManage" ], "properties": { "receiver": { "type": "string", "description": "Receiver ID" }, "receiverType": { "type": "string", "enum": [ "user", "group" ], "description": "Receiver type" }, "permissionRead": { "type": "boolean", "description": "Permission if receiver can read data" }, "permissionCreate": { "type": "boolean", "description": "Permission if receiver can create data" }, "permissionUpdate": { "type": "boolean", "description": "Permission if receiver can update data" }, "permissionDelete": { "type": "boolean", "description": "Permission if receiver can delete data" }, "permissionManage": { "type": "boolean", "description": "Permission if receiver can manage table" } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/shares": { "post": { "operationId": "api1-create-share", "summary": "Create a new share", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nodeId", "nodeType", "receiver", "receiverType" ], "properties": { "nodeId": { "type": "integer", "format": "int64", "description": "Node ID" }, "nodeType": { "type": "string", "enum": [ "table", "view", "context" ], "description": "Node type" }, "receiver": { "type": "string", "description": "Receiver ID" }, "receiverType": { "type": "string", "enum": [ "user", "group" ], "description": "Receiver type" }, "permissionRead": { "type": "boolean", "default": false, "description": "Permission if receiver can read data" }, "permissionCreate": { "type": "boolean", "default": false, "description": "Permission if receiver can create data" }, "permissionUpdate": { "type": "boolean", "default": false, "description": "Permission if receiver can update data" }, "permissionDelete": { "type": "boolean", "default": false, "description": "Permission if receiver can delete data" }, "permissionManage": { "type": "boolean", "default": false, "description": "Permission if receiver can manage node" }, "displayMode": { "type": "integer", "format": "int64", "default": 2, "description": "context shares only, whether it should appear in nav bar. 0: no, 1: recipients, 2: all (default). Cf. Application::NAV_ENTRY_MODE_*.", "minimum": 0, "maximum": 2 } } } } } }, "responses": { "200": { "description": "Share returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/shares/{shareId}/display-mode": { "put": { "operationId": "api1-update-share-display-mode", "summary": "Updates the display mode of a context share", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "displayMode" ], "properties": { "displayMode": { "type": "integer", "format": "int64", "description": "The new value for the display mode of the nav bar icon. 0: hidden, 1: visible for recipients, 2: visible for all", "minimum": 0, "maximum": 2 }, "target": { "type": "string", "default": "default", "enum": [ "default", "self" ], "description": "\"default\" to set the default, \"self\" to set an override for the authenticated user" } } } } } }, "parameters": [ { "name": "shareId", "in": "path", "description": "Share ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Display mode updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextNavigation" } } } }, "400": { "description": "Invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Share not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/columns": { "get": { "operationId": "api1-index-table-columns", "summary": "Get all columns for a table or a underlying view Return an empty array if no columns were found", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "viewId", "in": "query", "description": "View ID", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Column" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-table-column", "summary": "Create a new column for a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "type", "mandatory" ], "properties": { "title": { "type": "string", "description": "Title" }, "type": { "type": "string", "enum": [ "text", "number", "datetime", "select", "usergroup" ], "description": "Column main type" }, "subtype": { "type": "string", "nullable": true, "description": "Column sub type" }, "mandatory": { "type": "boolean", "description": "Is the column mandatory" }, "description": { "type": "string", "nullable": true, "description": "Description" }, "numberPrefix": { "type": "string", "nullable": true, "description": "Prefix if the column is a number field" }, "numberSuffix": { "type": "string", "nullable": true, "description": "Suffix if the column is a number field" }, "numberDefault": { "type": "number", "format": "double", "nullable": true, "description": "Default number, if column is a number" }, "numberMin": { "type": "number", "format": "double", "nullable": true, "description": "Min value, if column is a number" }, "numberMax": { "type": "number", "format": "double", "nullable": true, "description": "Max number, if column is a number" }, "numberDecimals": { "type": "integer", "format": "int64", "nullable": true, "description": "Number of decimals, if column is a number" }, "textDefault": { "type": "string", "nullable": true, "description": "Default text, if column is a text" }, "textAllowedPattern": { "type": "string", "nullable": true, "description": "Allowed pattern (regex) for text columns (not yet implemented)" }, "textMaxLength": { "type": "integer", "format": "int64", "nullable": true, "description": "Max length, if column is a text" }, "textUnique": { "type": "boolean", "nullable": true, "description": "Whether the text value must be unique, if column is a text" }, "selectionOptions": { "type": "string", "nullable": true, "default": "", "description": "Options for a selection (json array{id: int, label: string})" }, "selectionDefault": { "type": "string", "nullable": true, "default": "", "description": "Default option IDs for a selection (json list)" }, "datetimeDefault": { "type": "string", "nullable": true, "default": "", "description": "Default value, if column is datetime" }, "usergroupDefault": { "type": "string", "nullable": true, "default": "", "description": "Default value, if column is usergroup" }, "usergroupMultipleItems": { "type": "boolean", "nullable": true, "default": null, "description": "Can select multiple users or/and groups, if column is usergroup" }, "usergroupSelectUsers": { "type": "boolean", "nullable": true, "default": null, "description": "Can select users, if column type is usergroup" }, "usergroupSelectGroups": { "type": "boolean", "nullable": true, "default": null, "description": "Can select groups, if column type is usergroup" }, "usergroupSelectTeams": { "type": "boolean", "nullable": true, "default": null, "description": "Can select teams, if column type is usergroup" }, "usergroupShowUserStatus": { "type": "boolean", "nullable": true, "default": null, "description": "Whether to show the user's status, if column type is usergroup" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this column should be added to be presented", "items": { "type": "integer", "format": "int64" } }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Column" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/views/{viewId}/columns": { "get": { "operationId": "api1-index-view-columns", "summary": "Get all columns for a view Return an empty array if no columns were found", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Column" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/columns": { "post": { "operationId": "api1-create-column", "summary": "Create a column", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "type", "mandatory" ], "properties": { "tableId": { "type": "integer", "format": "int64", "nullable": true, "description": "Table ID" }, "viewId": { "type": "integer", "format": "int64", "nullable": true, "description": "View ID" }, "title": { "type": "string", "description": "Title" }, "type": { "type": "string", "enum": [ "text", "number", "datetime", "select", "usergroup" ], "description": "Column main type" }, "subtype": { "type": "string", "nullable": true, "description": "Column sub type" }, "mandatory": { "type": "boolean", "description": "Is the column mandatory" }, "description": { "type": "string", "nullable": true, "description": "Description" }, "numberPrefix": { "type": "string", "nullable": true, "description": "Prefix if the column is a number field" }, "numberSuffix": { "type": "string", "nullable": true, "description": "Suffix if the column is a number field" }, "numberDefault": { "type": "number", "format": "double", "nullable": true, "description": "Default number, if column is a number" }, "numberMin": { "type": "number", "format": "double", "nullable": true, "description": "Min value, if column is a number" }, "numberMax": { "type": "number", "format": "double", "nullable": true, "description": "Max number, if column is a number" }, "numberDecimals": { "type": "integer", "format": "int64", "nullable": true, "description": "Number of decimals, if column is a number" }, "textDefault": { "type": "string", "nullable": true, "description": "Default text, if column is a text" }, "textAllowedPattern": { "type": "string", "nullable": true, "description": "Allowed pattern (regex) for text columns (not yet implemented)" }, "textMaxLength": { "type": "integer", "format": "int64", "nullable": true, "description": "Max length, if column is a text" }, "textUnique": { "type": "boolean", "nullable": true, "default": false, "description": "Whether the text value must be unique, if column is a text" }, "selectionOptions": { "type": "string", "nullable": true, "default": "", "description": "Options for a selection (json array{id: int, label: string})" }, "selectionDefault": { "type": "string", "nullable": true, "default": "", "description": "Default option IDs for a selection (json list)" }, "datetimeDefault": { "type": "string", "nullable": true, "default": "", "description": "Default value, if column is datetime" }, "usergroupDefault": { "type": "string", "nullable": true, "default": "", "description": "Default value, if column is usergroup (json array{id: string, type: int})" }, "usergroupMultipleItems": { "type": "boolean", "nullable": true, "default": null, "description": "Can select multiple users or/and groups, if column is usergroup" }, "usergroupSelectUsers": { "type": "boolean", "nullable": true, "default": null, "description": "Can select users, if column type is usergroup" }, "usergroupSelectGroups": { "type": "boolean", "nullable": true, "default": null, "description": "Can select groups, if column type is usergroup" }, "usergroupSelectTeams": { "type": "boolean", "nullable": true, "default": null, "description": "Can select teams, if column type is usergroup" }, "usergroupShowUserStatus": { "type": "boolean", "nullable": true, "default": null, "description": "Whether to show the user's status, if column type is usergroup" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this column should be added to be presented", "items": { "type": "integer", "format": "int64" } }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Column" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/columns/{columnId}": { "put": { "operationId": "api1-update-column", "summary": "Update a column", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "mandatory" ], "properties": { "title": { "type": "string", "nullable": true, "description": "Title" }, "subtype": { "type": "string", "nullable": true, "description": "Column sub type" }, "mandatory": { "type": "boolean", "description": "Is the column mandatory" }, "description": { "type": "string", "nullable": true, "description": "Description" }, "numberPrefix": { "type": "string", "nullable": true, "description": "Prefix if the column is a number field" }, "numberSuffix": { "type": "string", "nullable": true, "description": "Suffix if the column is a number field" }, "numberDefault": { "type": "number", "format": "double", "nullable": true, "description": "Default number, if column is a number" }, "numberMin": { "type": "number", "format": "double", "nullable": true, "description": "Min value, if column is a number" }, "numberMax": { "type": "number", "format": "double", "nullable": true, "description": "Max number, if column is a number" }, "numberDecimals": { "type": "integer", "format": "int64", "nullable": true, "description": "Number of decimals, if column is a number" }, "textDefault": { "type": "string", "nullable": true, "description": "Default text, if column is a text" }, "textAllowedPattern": { "type": "string", "nullable": true, "description": "Allowed pattern (regex) for text columns (not yet implemented)" }, "textMaxLength": { "type": "integer", "format": "int64", "nullable": true, "description": "Max length, if column is a text" }, "textUnique": { "type": "boolean", "nullable": true, "description": "Whether the text value must be unique, if column is a text" }, "selectionOptions": { "type": "string", "nullable": true, "description": "Options for a selection (json array{id: int, label: string})" }, "selectionDefault": { "type": "string", "nullable": true, "description": "Default option IDs for a selection (json list)" }, "datetimeDefault": { "type": "string", "nullable": true, "description": "Default value, if column is datetime" }, "usergroupDefault": { "type": "string", "nullable": true, "description": "Default value, if column is usergroup" }, "usergroupMultipleItems": { "type": "boolean", "nullable": true, "description": "Can select multiple users or/and groups, if column is usergroup" }, "usergroupSelectUsers": { "type": "boolean", "nullable": true, "description": "Can select users, if column type is usergroup" }, "usergroupSelectGroups": { "type": "boolean", "nullable": true, "description": "Can select groups, if column type is usergroup" }, "usergroupSelectTeams": { "type": "boolean", "nullable": true, "description": "Can select teams, if column type is usergroup" }, "usergroupShowUserStatus": { "type": "boolean", "nullable": true, "description": "Whether to show the user's status, if column type is usergroup" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "columnId", "in": "path", "description": "Column ID that will be updated", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Updated column", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Column" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "get": { "operationId": "api1-get-column", "summary": "Returns a column object", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "columnId", "in": "path", "description": "Wanted Column ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Column returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Column" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "api1-delete-column", "summary": "Delete a column", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "columnId", "in": "path", "description": "Wanted Column ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Deleted column returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Column" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/rows/simple": { "get": { "operationId": "api1-index-table-rows-simple", "summary": "List all rows values for a table, first row are the column titles", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Limit", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "offset", "in": "query", "description": "Offset", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Row values returned", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/tables/{tableId}/rows": { "get": { "operationId": "api1-index-table-rows", "summary": "List all rows for a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Limit", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "offset", "in": "query", "description": "Offset", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Rows returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Row" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-row-in-table", "summary": "Create a row within a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "description": "Data as key - value store", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": { "type": "object" } } ] } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/views/{viewId}/rows": { "get": { "operationId": "api1-index-view-rows", "summary": "List all rows for a view", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Limit", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "offset", "in": "query", "description": "Offset", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Rows returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Row" } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "api1-create-row-in-view", "summary": "Create a row within a view", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "description": "Data as key - value store", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": { "type": "object" } } ] } } } } } }, "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/rows/{rowId}": { "get": { "operationId": "api1-get-row", "summary": "Get a row", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "rowId", "in": "path", "description": "Row ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "put": { "operationId": "api1-update-row", "summary": "Update a row", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "viewId": { "type": "integer", "format": "int64", "nullable": true, "description": "View ID" }, "data": { "description": "Data as key - value store", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": { "type": "object" } } ] } } } } } }, "parameters": [ { "name": "rowId", "in": "path", "description": "Row ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Updated row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "api1-delete-row", "summary": "Delete a row", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "rowId", "in": "path", "description": "Row ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Deleted row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/views/{viewId}/rows/{rowId}": { "delete": { "operationId": "api1-delete-row-by-view", "summary": "Delete a row within a view", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "rowId", "in": "path", "description": "Row ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Deleted row returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Row" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/import/table/{tableId}": { "post": { "operationId": "api1-import-in-table", "summary": "Import from file in to a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "description": "Path to file" }, "createMissingColumns": { "type": "boolean", "default": true, "description": "Create missing columns" } } } } } }, "parameters": [ { "name": "tableId", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Import status returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportState" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/tables/api/1/import/views/{viewId}": { "post": { "operationId": "api1-import-in-view", "summary": "Import from file in to a table", "description": "This endpoint allows CORS requests", "tags": [ "api1" ], "security": [ { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "description": "Path to file" }, "createMissingColumns": { "type": "boolean", "default": true, "description": "Create missing columns" } } } } } }, "parameters": [ { "name": "viewId", "in": "path", "description": "View ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Import status returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportState" } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/init": { "get": { "operationId": "api_general-index", "summary": "[api v2] Returns all main resources", "description": "Tables and views incl. shares", "tags": [ "api_general" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Index returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Index" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/tables": { "get": { "operationId": "api_tables-index", "summary": "[api v2] Returns all Tables", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Table" } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "post": { "operationId": "api_tables-create", "summary": "[api v2] Create a new table and return it", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the table" }, "emoji": { "type": "string", "nullable": true, "description": "Emoji for the table" }, "description": { "type": "string", "nullable": true, "description": "Description for the table" }, "template": { "type": "string", "default": "custom", "description": "Template to use if wanted" } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/tables/{id}": { "get": { "operationId": "api_tables-show", "summary": "[api v2] Get a table object", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Table returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "put": { "operationId": "api_tables-update", "summary": "[api v2] Update tables properties", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "default": null, "description": "New table title" }, "emoji": { "type": "string", "nullable": true, "default": null, "description": "New table emoji" }, "description": { "type": "string", "default": null, "description": "the tables description" }, "archived": { "type": "boolean", "default": null, "description": "whether the table is archived" } } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "api_tables-destroy", "summary": "[api v2] Delete a table", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Deleted table returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/tables/scheme/{id}": { "get": { "operationId": "api_tables-show-scheme", "summary": "[api v2] Get a table Scheme", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Scheme returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/tables/scheme": { "post": { "operationId": "api_tables-create-from-scheme", "summary": "creates table from scheme", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "emoji", "description", "columns", "views" ], "properties": { "title": { "type": "string", "description": "title of new table" }, "emoji": { "type": "string", "description": "emoji" }, "description": { "type": "string", "description": "description" }, "columns": { "type": "array", "description": "columns", "items": { "$ref": "#/components/schemas/Column" } }, "views": { "type": "array", "description": "views", "items": { "$ref": "#/components/schemas/View" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/tables/{id}/transfer": { "put": { "operationId": "api_tables-transfer", "summary": "[api v2] Transfer table", "description": "Transfer table from one user to another", "tags": [ "api_tables" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "newOwnerUserId" ], "properties": { "newOwnerUserId": { "type": "string", "description": "New user ID" } } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "Table ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Ownership changed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Table" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/{nodeType}/{nodeId}": { "get": { "operationId": "api_columns-index", "summary": "[api v2] Get all columns for a table or a view", "description": "Return an empty array if no columns were found", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "nodeType", "in": "path", "description": "Node type", "required": true, "schema": { "type": "string", "enum": [ "table", "view" ] } }, { "name": "nodeId", "in": "path", "description": "Node ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "View deleted", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Column" } } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/{id}": { "get": { "operationId": "api_columns-show", "summary": "[api v2] Get a column object", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Column ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/number": { "post": { "operationId": "api_columns-create-number-column", "summary": "[api v2] Create new numbered column", "description": "Specify a subtype to use any special numbered column", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "baseNodeId", "title" ], "properties": { "baseNodeId": { "type": "integer", "format": "int64", "description": "Context of the column creation" }, "title": { "type": "string", "description": "Title" }, "numberDefault": { "type": "number", "format": "double", "nullable": true, "description": "Default value for new rows" }, "numberDecimals": { "type": "integer", "format": "int64", "nullable": true, "description": "Decimals" }, "numberPrefix": { "type": "string", "nullable": true, "description": "Prefix" }, "numberSuffix": { "type": "string", "nullable": true, "description": "Suffix" }, "numberMin": { "type": "number", "format": "double", "nullable": true, "description": "Min" }, "numberMax": { "type": "number", "format": "double", "nullable": true, "description": "Max" }, "subtype": { "type": "string", "nullable": true, "default": null, "enum": [ "progress", "stars" ], "description": "Subtype for the new column" }, "description": { "type": "string", "nullable": true, "default": null, "description": "Description" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this columns should be added", "items": { "type": "integer", "format": "int64" } }, "mandatory": { "type": "boolean", "default": false, "description": "Is mandatory" }, "baseNodeType": { "type": "string", "default": "table", "enum": [ "table", "view" ], "description": "Context type of the column creation" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permission", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/text": { "post": { "operationId": "api_columns-create-text-column", "summary": "[api v2] Create new text column", "description": "Specify a subtype to use any special text column", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "baseNodeId", "title" ], "properties": { "baseNodeId": { "type": "integer", "format": "int64", "description": "Context of the column creation" }, "title": { "type": "string", "description": "Title" }, "textDefault": { "type": "string", "nullable": true, "description": "Default" }, "textAllowedPattern": { "type": "string", "nullable": true, "description": "Allowed regex pattern" }, "textMaxLength": { "type": "integer", "format": "int64", "nullable": true, "description": "Max raw text length" }, "textUnique": { "type": "boolean", "nullable": true, "default": false, "description": "Whether the text value must be unique, if column is a text" }, "subtype": { "type": "string", "nullable": true, "default": null, "enum": [ "progress", "stars" ], "description": "Subtype for the new column" }, "description": { "type": "string", "nullable": true, "default": null, "description": "Description" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this columns should be added", "items": { "type": "integer", "format": "int64" } }, "mandatory": { "type": "boolean", "default": false, "description": "Is mandatory" }, "baseNodeType": { "type": "string", "default": "table", "enum": [ "table", "view" ], "description": "Context type of the column creation" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permission", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/selection": { "post": { "operationId": "api_columns-create-selection-column", "summary": "[api v2] Create new selection column", "description": "Specify a subtype to use any special selection column", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "baseNodeId", "title", "selectionOptions" ], "properties": { "baseNodeId": { "type": "integer", "format": "int64", "description": "Context of the column creation" }, "title": { "type": "string", "description": "Title" }, "selectionOptions": { "type": "string", "description": "Json array{id: int, label: string} with options that can be selected, eg [{\"id\": 1, \"label\": \"first\"},{\"id\": 2, \"label\": \"second\"}]" }, "selectionDefault": { "type": "string", "nullable": true, "description": "Json int|list for default selected option(s), eg 5 or [\"1\", \"8\"]" }, "subtype": { "type": "string", "nullable": true, "default": null, "enum": [ "progress", "stars" ], "description": "Subtype for the new column" }, "description": { "type": "string", "nullable": true, "default": null, "description": "Description" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this columns should be added", "items": { "type": "integer", "format": "int64" } }, "mandatory": { "type": "boolean", "default": false, "description": "Is mandatory" }, "baseNodeType": { "type": "string", "default": "table", "enum": [ "table", "view" ], "description": "Context type of the column creation" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permission", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/datetime": { "post": { "operationId": "api_columns-create-datetime-column", "summary": "[api v2] Create new datetime column", "description": "Specify a subtype to use any special datetime column", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "baseNodeId", "title" ], "properties": { "baseNodeId": { "type": "integer", "format": "int64", "description": "Context of the column creation" }, "title": { "type": "string", "description": "Title" }, "datetimeDefault": { "type": "string", "nullable": true, "enum": [ "today", "now" ], "description": "For a subtype 'date' you can set 'today'. For a main type or subtype 'time' you can set to 'now'." }, "subtype": { "type": "string", "nullable": true, "default": null, "enum": [ "progress", "stars" ], "description": "Subtype for the new column" }, "description": { "type": "string", "nullable": true, "default": null, "description": "Description" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this columns should be added", "items": { "type": "integer", "format": "int64" } }, "mandatory": { "type": "boolean", "default": false, "description": "Is mandatory" }, "baseNodeType": { "type": "string", "default": "table", "enum": [ "table", "view" ], "description": "Context type of the column creation" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permission", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/columns/usergroup": { "post": { "operationId": "api_columns-create-usergroup-column", "summary": "[api v2] Create new usergroup column", "tags": [ "api_columns" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "baseNodeId", "title" ], "properties": { "baseNodeId": { "type": "integer", "format": "int64", "description": "Context of the column creation" }, "title": { "type": "string", "description": "Title" }, "usergroupDefault": { "type": "string", "nullable": true, "description": "Json array{id: string, type: int}, eg [{\"id\": \"admin\", \"type\": 0}, {\"id\": \"user1\", \"type\": 0}]" }, "usergroupMultipleItems": { "type": "boolean", "default": null, "description": "Whether you can select multiple users or/and groups" }, "usergroupSelectUsers": { "type": "boolean", "default": null, "description": "Whether you can select users" }, "usergroupSelectGroups": { "type": "boolean", "default": null, "description": "Whether you can select groups" }, "usergroupSelectTeams": { "type": "boolean", "default": null, "description": "Whether you can select teams" }, "showUserStatus": { "type": "boolean", "default": null, "description": "Whether to show the user's status" }, "description": { "type": "string", "nullable": true, "default": null, "description": "Description" }, "selectedViewIds": { "type": "array", "nullable": true, "default": [], "description": "View IDs where this columns should be added", "items": { "type": "integer", "format": "int64" } }, "mandatory": { "type": "boolean", "default": false, "description": "Is mandatory" }, "baseNodeType": { "type": "string", "default": "table", "enum": [ "table", "view" ], "description": "Context type of the column creation" }, "customSettings": { "type": "object", "default": {}, "description": "Custom settings for the column", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Column created", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Column" } } } } } } } }, "403": { "description": "No permission", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/favorites/{nodeType}/{nodeId}": { "post": { "operationId": "api_favorite-create", "summary": "[api v2] Add a node (table or view) to user favorites", "tags": [ "api_favorite" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "nodeType", "in": "path", "description": "any Application::NODE_TYPE_* constant", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "nodeId", "in": "path", "description": "identifier of the node", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Tables returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "api_favorite-destroy", "summary": "[api v2] Remove a node (table or view) to from favorites", "tags": [ "api_favorite" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "nodeType", "in": "path", "description": "any Application::NODE_TYPE_* constant", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "nodeId", "in": "path", "description": "identifier of the node", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Deleted table returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/contexts": { "get": { "operationId": "context-index", "summary": "[api v2] Get all contexts available to the requesting person", "description": "Return an empty array if no contexts were found", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "reporting in available contexts", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Context" } } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "post": { "operationId": "context-create", "summary": "[api v2] Create a new context and return it", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "iconName" ], "properties": { "name": { "type": "string", "description": "Name of the context" }, "iconName": { "type": "string", "description": "Material design icon name of the context" }, "description": { "type": "string", "default": "", "description": "Descriptive text of the context" }, "nodes": { "type": "array", "default": [], "description": "optional nodes to be connected to this context", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "integer", "format": "int64" }, "permissions": { "type": "integer", "format": "int64" } } } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "returning the full context information", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "invalid parameters were supplied", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "403": { "description": "lacking permissions on a resource", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/contexts/{contextId}": { "get": { "operationId": "context-show", "summary": "[api v2] Get information about the requests context", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "contextId", "in": "path", "description": "ID of the context", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "returning the full context information", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "context not found or not available anymore", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "put": { "operationId": "context-update", "summary": "[api v2] Update an existing context and return it", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "provide this parameter to set a new name" }, "iconName": { "type": "string", "nullable": true, "description": "provide this parameter to set a new icon" }, "description": { "type": "string", "nullable": true, "description": "provide this parameter to set a new description" }, "nodes": { "type": "object", "nullable": true, "description": "provide this parameter to set a new list of nodes.", "required": [ "id", "type", "permissions", "order" ], "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "integer", "format": "int64" }, "permissions": { "type": "integer", "format": "int64" }, "order": { "type": "integer", "format": "int64" } } } } } } } }, "parameters": [ { "name": "contextId", "in": "path", "description": "ID of the context", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "returning the full context information", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "bad request", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "context-destroy", "summary": "[api v2] Delete an existing context and return it", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "contextId", "in": "path", "description": "ID of the context", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "returning the full context information", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/contexts/{contextId}/transfer": { "put": { "operationId": "context-transfer", "summary": "[api v2] Transfer the ownership of a context and return it", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "newOwnerId" ], "properties": { "newOwnerId": { "type": "string", "description": "ID of the new owner" }, "newOwnerType": { "type": "integer", "format": "int64", "default": 0, "description": "any Application::OWNER_TYPE_* constant", "minimum": 0, "maximum": 0 } } } } } }, "parameters": [ { "name": "contextId", "in": "path", "description": "ID of the context", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Ownership transferred", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/contexts/{contextId}/pages/{pageId}": { "put": { "operationId": "context-update-content-order", "summary": "[api v2] Update the order on a page of a context", "tags": [ "context" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "content" ], "properties": { "content": { "type": "object", "description": "content items with it and order values", "required": [ "id", "order" ], "properties": { "id": { "type": "integer", "format": "int64" }, "order": { "type": "integer", "format": "int64" } } } } } } } }, "parameters": [ { "name": "contextId", "in": "path", "description": "ID of the context", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageId", "in": "path", "description": "ID of the page", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "content updated successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Context" } } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/tables/api/2/{nodeCollection}/{nodeId}/rows": { "post": { "operationId": "rowocs-create-row", "summary": "[api v2] Create a new row in a table or a view", "tags": [ "rowocs" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "description": "An array containing the column identifiers and their values", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": { "type": "object" } } ] } } } } } }, "parameters": [ { "name": "nodeCollection", "in": "path", "description": "Indicates whether to create a row on a table or view", "required": true, "schema": { "type": "string", "enum": [ "tables", "views" ], "pattern": "^(tables|views)$" } }, { "name": "nodeId", "in": "path", "description": "The identifier of the targeted table or view", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Row returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Row" } } } } } } } }, "403": { "description": "No permissions", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } } }, "tags": [ { "name": "navigation", "description": "This is a workaround until https://github.com/nextcloud/server/pull/49904 is settled in all covered NC versions; expected >= 31." } ] }