{ "baseUrl": "https://demo.fusio-project.org", "security": { "type": "oauth2", "tokenUrl": "https://demo.fusio-project.org/authorization/token", "authorizationUrl": "https://demo.fusio-project.org/authorization/authorize", "scopes": [ "backend", "backend.account", "backend.action", "backend.agent", "backend.app", "backend.audit", "backend.backup", "backend.bundle", "backend.category", "backend.config", "backend.connection", "backend.cronjob", "backend.dashboard", "backend.event", "backend.firewall", "backend.form", "backend.generator", "backend.identity", "backend.log", "backend.marketplace", "backend.operation", "backend.page", "backend.plan", "backend.rate", "backend.role", "backend.schema", "backend.scope", "backend.sdk", "backend.specification", "backend.statistic", "backend.taxonomy", "backend.tenant", "backend.test", "backend.token", "backend.transaction", "backend.trash", "backend.trigger", "backend.user", "backend.webhook" ] }, "operations": { "backend.account.changePassword": { "path": "/backend/account/change_password", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_AccountChangePassword" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Changes the password of the authenticated user", "stability": 2, "security": [ "backend.account" ], "authorization": true, "tags": [ "account" ] }, "backend.account.get": { "path": "/backend/account", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_User" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns user data of the authenticated user", "stability": 2, "security": [ "backend.account" ], "authorization": true, "tags": [ "account" ] }, "backend.account.update": { "path": "/backend/account", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_UserUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates user data of the authenticated user", "stability": 2, "security": [ "backend.account" ], "authorization": true, "tags": [ "account" ] }, "backend.action.create": { "path": "/backend/action", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ActionCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new action", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.delete": { "path": "/backend/action/$action_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "action_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing action", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.execute": { "path": "/backend/action/execute/:action_id", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ActionExecuteResponse" } }, "arguments": { "action_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ActionExecuteRequest" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Executes a specific action. This method should be used to test an action configuration", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.get": { "path": "/backend/action/$action_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Action" } }, "arguments": { "action_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific action", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.getAll": { "path": "/backend/action", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ActionCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of actions", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.getClasses": { "path": "/backend/action/list", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ActionIndex" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available action classes", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.getCommits": { "path": "/backend/action/$action_id<[0-9]+|^~>/commit", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ActionCommitCollection" } }, "arguments": { "action_id": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of action commits", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.getForm": { "path": "/backend/action/form", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_FormContainer" } }, "arguments": { "class": { "in": "query", "schema": { "description": "The target action class", "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the action config form", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.action.update": { "path": "/backend/action/$action_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "action_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ActionUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing action", "stability": 2, "security": [ "backend.action" ], "authorization": true, "tags": [ "action" ] }, "backend.agent.create": { "path": "/backend/agent", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_AgentCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new agent", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.delete": { "path": "/backend/agent/$agent_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "agent_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing agent", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.get": { "path": "/backend/agent/$agent_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Agent" } }, "arguments": { "agent_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific agent", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.getAll": { "path": "/backend/agent", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_AgentCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of agents", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.getTools": { "path": "/backend/agent/tools", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_AgentTools" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns available tools for an agent", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.message.getAll": { "path": "/backend/agent/$agent_id<[0-9]+|^~>/message", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_AgentMessageCollection" } }, "arguments": { "agent_id": { "in": "path", "schema": { "type": "string" } }, "chat_id": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of agent messages", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.message.submit": { "path": "/backend/agent/$agent_id<[0-9]+|^~>/message", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Agent_Output" } }, "arguments": { "agent_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Agent_Input" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Submits a new agent message", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.agent.update": { "path": "/backend/agent/$agent_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "agent_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_AgentUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing agent", "stability": 2, "security": [ "backend.agent" ], "authorization": true, "tags": [ "agent" ] }, "backend.app.create": { "path": "/backend/app", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_AppCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new app", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.app.delete": { "path": "/backend/app/$app_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "app_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing app", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.app.deleteToken": { "path": "/backend/app/$app_id<[0-9]+>/token/:token_id", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "app_id": { "in": "path", "schema": { "type": "string" } }, "token_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing token from an app", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.app.get": { "path": "/backend/app/$app_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_App" } }, "arguments": { "app_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific app", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.app.getAll": { "path": "/backend/app", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_AppCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of apps", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.app.update": { "path": "/backend/app/$app_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "app_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_AppUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing app", "stability": 2, "security": [ "backend.app" ], "authorization": true, "tags": [ "app" ] }, "backend.audit.get": { "path": "/backend/audit/$audit_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Audit" } }, "arguments": { "audit_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific audit", "stability": 2, "security": [ "backend.audit" ], "authorization": true, "tags": [ "audit" ] }, "backend.audit.getAll": { "path": "/backend/audit", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_AuditCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "event": { "in": "query", "schema": { "type": "string" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "message": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of audits", "stability": 2, "security": [ "backend.audit" ], "authorization": true, "tags": [ "audit" ] }, "backend.backup.export": { "path": "/backend/backup/export", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_BackupExport" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Generates an backup of the current system", "stability": 2, "security": [ "backend.backup" ], "authorization": true, "tags": [ "backup" ] }, "backend.backup.import": { "path": "/backend/backup/import", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_BackupImportResult" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_BackupImport" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Imports an backup to the current system", "stability": 2, "security": [ "backend.backup" ], "authorization": true, "tags": [ "backup" ] }, "backend.bundle.create": { "path": "/backend/bundle", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_BundleCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new bundle", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.bundle.delete": { "path": "/backend/bundle/$bundle_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "bundle_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing bundle", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.bundle.get": { "path": "/backend/bundle/$bundle_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Bundle" } }, "arguments": { "bundle_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific bundle", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.bundle.getAll": { "path": "/backend/bundle", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_BundleCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of bundles", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.bundle.publish": { "path": "/backend/bundle/$bundle_id<[0-9]+|^~>/publish", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "bundle_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Publish an existing bundle to the marketplace", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.bundle.update": { "path": "/backend/bundle/$bundle_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "bundle_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_BundleUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing bundle", "stability": 2, "security": [ "backend.bundle" ], "authorization": true, "tags": [ "bundle" ] }, "backend.category.create": { "path": "/backend/category", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_CategoryCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new category", "stability": 2, "security": [ "backend.category" ], "authorization": true, "tags": [ "category" ] }, "backend.category.delete": { "path": "/backend/category/$category_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "category_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing category", "stability": 2, "security": [ "backend.category" ], "authorization": true, "tags": [ "category" ] }, "backend.category.get": { "path": "/backend/category/$category_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Category" } }, "arguments": { "category_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific category", "stability": 2, "security": [ "backend.category" ], "authorization": true, "tags": [ "category" ] }, "backend.category.getAll": { "path": "/backend/category", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_CategoryCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of categories", "stability": 2, "security": [ "backend.category" ], "authorization": true, "tags": [ "category" ] }, "backend.category.update": { "path": "/backend/category/$category_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "category_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_CategoryUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing category", "stability": 2, "security": [ "backend.category" ], "authorization": true, "tags": [ "category" ] }, "backend.config.get": { "path": "/backend/config/$config_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Config" } }, "arguments": { "config_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific config", "stability": 2, "security": [ "backend.config" ], "authorization": true, "tags": [ "config" ] }, "backend.config.getAll": { "path": "/backend/config", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ConfigCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of configuration values", "stability": 2, "security": [ "backend.config" ], "authorization": true, "tags": [ "config" ] }, "backend.config.update": { "path": "/backend/config/$config_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "config_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ConfigUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing config value", "stability": 2, "security": [ "backend.config" ], "authorization": true, "tags": [ "config" ] }, "backend.connection.agent.send": { "path": "/backend/connection/:connection_id/agent", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Agent_Output" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Agent_Input" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Sends a message to an agent", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.create": { "path": "/backend/connection", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ConnectionCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.createRow": { "path": "/backend/connection/:connection_id/database/:table_name/rows", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_DatabaseRow" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new row at a table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.createTable": { "path": "/backend/connection/:connection_id/database", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_DatabaseTable" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.deleteRow": { "path": "/backend/connection/:connection_id/database/:table_name/rows/:id", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing row at a table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.deleteTable": { "path": "/backend/connection/:connection_id/database/:table_name", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.getRow": { "path": "/backend/connection/:connection_id/database/:table_name/rows/:id", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_DatabaseRow" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific row at a table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.getRows": { "path": "/backend/connection/:connection_id/database/:table_name/rows", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_DatabaseRowCollection" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "filterBy": { "in": "query", "schema": { "type": "string" } }, "filterOp": { "in": "query", "schema": { "type": "string" } }, "filterValue": { "in": "query", "schema": { "type": "string" } }, "sortBy": { "in": "query", "schema": { "type": "string" } }, "sortOrder": { "in": "query", "schema": { "type": "string" } }, "columns": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns paginated rows at a table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.getTable": { "path": "/backend/connection/:connection_id/database/:table_name", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_DatabaseTable" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the schema of a specific table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.getTables": { "path": "/backend/connection/:connection_id/database", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_DatabaseTableCollection" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available tables on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.updateRow": { "path": "/backend/connection/:connection_id/database/:table_name/rows/:id", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_DatabaseRow" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing row at a table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.database.updateTable": { "path": "/backend/connection/:connection_id/database/:table_name", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "table_name": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_DatabaseTable" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing table on a database", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.delete": { "path": "/backend/connection/$connection_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.filesystem.create": { "path": "/backend/connection/:connection_id/filesystem", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "contentType": "multipart/form-data" } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Uploads one or more files on the filesystem connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.filesystem.delete": { "path": "/backend/connection/:connection_id/filesystem/:file_id", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "file_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing file on the filesystem connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.filesystem.get": { "path": "/backend/connection/:connection_id/filesystem/:file_id", "method": "GET", "return": { "code": 200, "contentType": "application/octet-stream" }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "file_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the content of the provided file id on the filesystem connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.filesystem.getAll": { "path": "/backend/connection/:connection_id/filesystem", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_FileCollection" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available files on the filesystem connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.filesystem.update": { "path": "/backend/connection/:connection_id/filesystem/:file_id", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "file_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "contentType": "multipart/form-data" } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing file on the filesystem connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.get": { "path": "/backend/connection/$connection_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Connection" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.getAll": { "path": "/backend/connection", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ConnectionCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "class": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of connections", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.getClasses": { "path": "/backend/connection/list", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ConnectionIndex" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available connection classes", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.getForm": { "path": "/backend/connection/form", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_FormContainer" } }, "arguments": { "class": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the connection config form", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.getRedirect": { "path": "/backend/connection/:connection_id/redirect", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ConnectionRedirectResponse" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a redirect url to start the OAuth2 authorization flow for the given connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.http.execute": { "path": "/backend/connection/:connection_id/http", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_HttpResponse" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_HttpRequest" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Sends an arbitrary HTTP request to the connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.sdk.get": { "path": "/backend/connection/:connection_id/sdk", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Passthru" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the SDK specification", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.connection.update": { "path": "/backend/connection/$connection_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "connection_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ConnectionUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing connection", "stability": 2, "security": [ "backend.connection" ], "authorization": true, "tags": [ "connection" ] }, "backend.cronjob.create": { "path": "/backend/cronjob", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_CronjobCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new cronjob", "stability": 2, "security": [ "backend.cronjob" ], "authorization": true, "tags": [ "cronjob" ] }, "backend.cronjob.delete": { "path": "/backend/cronjob/$cronjob_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "cronjob_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing cronjob", "stability": 2, "security": [ "backend.cronjob" ], "authorization": true, "tags": [ "cronjob" ] }, "backend.cronjob.get": { "path": "/backend/cronjob/$cronjob_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Cronjob" } }, "arguments": { "cronjob_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific cronjob", "stability": 2, "security": [ "backend.cronjob" ], "authorization": true, "tags": [ "cronjob" ] }, "backend.cronjob.getAll": { "path": "/backend/cronjob", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_CronjobCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of cronjobs", "stability": 2, "security": [ "backend.cronjob" ], "authorization": true, "tags": [ "cronjob" ] }, "backend.cronjob.update": { "path": "/backend/cronjob/$cronjob_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "cronjob_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_CronjobUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing cronjob", "stability": 2, "security": [ "backend.cronjob" ], "authorization": true, "tags": [ "cronjob" ] }, "backend.dashboard.getAll": { "path": "/backend/dashboard", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Dashboard" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available dashboard widgets", "stability": 2, "security": [ "backend.dashboard" ], "authorization": true, "tags": [ "dashboard" ] }, "backend.event.create": { "path": "/backend/event", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_EventCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new event", "stability": 2, "security": [ "backend.event" ], "authorization": true, "tags": [ "event" ] }, "backend.event.delete": { "path": "/backend/event/$event_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "event_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing event", "stability": 2, "security": [ "backend.event" ], "authorization": true, "tags": [ "event" ] }, "backend.event.get": { "path": "/backend/event/$event_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Event" } }, "arguments": { "event_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific event", "stability": 2, "security": [ "backend.event" ], "authorization": true, "tags": [ "event" ] }, "backend.event.getAll": { "path": "/backend/event", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_EventCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of events", "stability": 2, "security": [ "backend.event" ], "authorization": true, "tags": [ "event" ] }, "backend.event.update": { "path": "/backend/event/$event_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "event_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_EventUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing event", "stability": 2, "security": [ "backend.event" ], "authorization": true, "tags": [ "event" ] }, "backend.firewall.create": { "path": "/backend/firewall", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_FirewallCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new firewall rule", "stability": 2, "security": [ "backend.firewall" ], "authorization": true, "tags": [ "firewall" ] }, "backend.firewall.delete": { "path": "/backend/firewall/$firewall_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "firewall_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing firewall rule", "stability": 2, "security": [ "backend.firewall" ], "authorization": true, "tags": [ "firewall" ] }, "backend.firewall.get": { "path": "/backend/firewall/$firewall_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Firewall" } }, "arguments": { "firewall_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific firewall rule", "stability": 2, "security": [ "backend.firewall" ], "authorization": true, "tags": [ "firewall" ] }, "backend.firewall.getAll": { "path": "/backend/firewall", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_FirewallCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of firewall rules", "stability": 2, "security": [ "backend.firewall" ], "authorization": true, "tags": [ "firewall" ] }, "backend.firewall.update": { "path": "/backend/firewall/$firewall_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "firewall_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_FirewallUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing firewall rule", "stability": 2, "security": [ "backend.firewall" ], "authorization": true, "tags": [ "firewall" ] }, "backend.form.create": { "path": "/backend/form", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_FormCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new form", "stability": 2, "security": [ "backend.form" ], "authorization": true, "tags": [ "form" ] }, "backend.form.delete": { "path": "/backend/form/$form_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "form_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing form", "stability": 2, "security": [ "backend.form" ], "authorization": true, "tags": [ "form" ] }, "backend.form.get": { "path": "/backend/form/$form_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Form" } }, "arguments": { "form_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific form", "stability": 2, "security": [ "backend.form" ], "authorization": true, "tags": [ "form" ] }, "backend.form.getAll": { "path": "/backend/form", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_FormCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of forms", "stability": 2, "security": [ "backend.form" ], "authorization": true, "tags": [ "form" ] }, "backend.form.update": { "path": "/backend/form/$form_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "form_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_FormUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing form", "stability": 2, "security": [ "backend.form" ], "authorization": true, "tags": [ "form" ] }, "backend.generator.executeProvider": { "path": "/backend/generator/:provider", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "provider": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_GeneratorProvider" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Executes a generator with the provided config", "stability": 2, "security": [ "backend.generator" ], "authorization": true, "tags": [ "generator" ] }, "backend.generator.getChangelog": { "path": "/backend/generator/:provider", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_GeneratorProviderChangelog" } }, "arguments": { "provider": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_GeneratorProviderConfig" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Generates a changelog of all potential changes if you execute this generator with the provided config", "stability": 2, "security": [ "backend.generator" ], "authorization": true, "tags": [ "generator" ] }, "backend.generator.getClasses": { "path": "/backend/generator", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_GeneratorIndexProviders" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available generator classes", "stability": 2, "security": [ "backend.generator" ], "authorization": true, "tags": [ "generator" ] }, "backend.generator.getForm": { "path": "/backend/generator/:provider", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_FormContainer" } }, "arguments": { "provider": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the generator config form", "stability": 2, "security": [ "backend.generator" ], "authorization": true, "tags": [ "generator" ] }, "backend.identity.create": { "path": "/backend/identity", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_IdentityCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new identity", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.delete": { "path": "/backend/identity/$identity_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "identity_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing identity", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.get": { "path": "/backend/identity/$identity_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Identity" } }, "arguments": { "identity_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific identity", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.getAll": { "path": "/backend/identity", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_IdentityCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of identities", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.getClasses": { "path": "/backend/identity/list", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_IdentityIndex" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available identity classes", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.getForm": { "path": "/backend/identity/form", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_FormContainer" } }, "arguments": { "class": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the identity config form", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.identity.update": { "path": "/backend/identity/$identity_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "identity_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_IdentityUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing identity", "stability": 2, "security": [ "backend.identity" ], "authorization": true, "tags": [ "identity" ] }, "backend.log.get": { "path": "/backend/log/$log_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Log" } }, "arguments": { "log_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific log", "stability": 2, "security": [ "backend.log" ], "authorization": true, "tags": [ "log" ] }, "backend.log.getAll": { "path": "/backend/log", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_LogCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of logs", "stability": 2, "security": [ "backend.log" ], "authorization": true, "tags": [ "log" ] }, "backend.log.getAllErrors": { "path": "/backend/log/error", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_LogErrorCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of log errors", "stability": 2, "security": [ "backend.log" ], "authorization": true, "tags": [ "log" ] }, "backend.log.getError": { "path": "/backend/log/error/$error_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_LogError" } }, "arguments": { "error_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific error", "stability": 2, "security": [ "backend.log" ], "authorization": true, "tags": [ "log" ] }, "backend.marketplace.action.get": { "path": "/backend/marketplace/action/:user/:name", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceAction" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific marketplace action", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.action.getAll": { "path": "/backend/marketplace/action", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceActionCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "query": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of marketplace actions", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.action.install": { "path": "/backend/marketplace/action", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "MarketplaceMessage" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "MarketplaceInstall" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Installs an action from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.action.upgrade": { "path": "/backend/marketplace/action/:user/:name", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Upgrades an action from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.app.get": { "path": "/backend/marketplace/app/:user/:name", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceApp" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific marketplace app", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.app.getAll": { "path": "/backend/marketplace/app", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceAppCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "query": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of marketplace apps", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.app.install": { "path": "/backend/marketplace/app", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "MarketplaceMessage" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "MarketplaceInstall" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Installs an app from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.app.upgrade": { "path": "/backend/marketplace/app/:user/:name", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceMessage" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Upgrades an app from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.bundle.get": { "path": "/backend/marketplace/bundle/:user/:name", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceBundle" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific marketplace bundle", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.bundle.getAll": { "path": "/backend/marketplace/bundle", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceBundleCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "query": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of marketplace bundles", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.bundle.install": { "path": "/backend/marketplace/bundle", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "MarketplaceMessage" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "MarketplaceInstall" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Installs an bundle from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.marketplace.bundle.upgrade": { "path": "/backend/marketplace/bundle/:user/:name", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "MarketplaceMessage" } }, "arguments": { "user": { "in": "path", "schema": { "type": "string" } }, "name": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Upgrades an bundle from the marketplace", "stability": 2, "security": [ "backend.marketplace" ], "authorization": true, "tags": [ "marketplace" ] }, "backend.operation.create": { "path": "/backend/operation", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_OperationCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new operation", "stability": 2, "security": [ "backend.operation" ], "authorization": true, "tags": [ "operation" ] }, "backend.operation.delete": { "path": "/backend/operation/$operation_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "operation_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing operation", "stability": 2, "security": [ "backend.operation" ], "authorization": true, "tags": [ "operation" ] }, "backend.operation.get": { "path": "/backend/operation/$operation_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Operation" } }, "arguments": { "operation_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific operation", "stability": 2, "security": [ "backend.operation" ], "authorization": true, "tags": [ "operation" ] }, "backend.operation.getAll": { "path": "/backend/operation", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_OperationCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of operations", "stability": 2, "security": [ "backend.operation" ], "authorization": true, "tags": [ "operation" ] }, "backend.operation.update": { "path": "/backend/operation/$operation_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "operation_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_OperationUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing operation", "stability": 2, "security": [ "backend.operation" ], "authorization": true, "tags": [ "operation" ] }, "backend.page.create": { "path": "/backend/page", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_PageCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new page", "stability": 2, "security": [ "backend.page" ], "authorization": true, "tags": [ "page" ] }, "backend.page.delete": { "path": "/backend/page/$page_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "page_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing page", "stability": 2, "security": [ "backend.page" ], "authorization": true, "tags": [ "page" ] }, "backend.page.get": { "path": "/backend/page/$page_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Page" } }, "arguments": { "page_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific page", "stability": 2, "security": [ "backend.page" ], "authorization": true, "tags": [ "page" ] }, "backend.page.getAll": { "path": "/backend/page", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_PageCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of pages", "stability": 2, "security": [ "backend.page" ], "authorization": true, "tags": [ "page" ] }, "backend.page.update": { "path": "/backend/page/$page_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "page_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_PageUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing page", "stability": 2, "security": [ "backend.page" ], "authorization": true, "tags": [ "page" ] }, "backend.plan.create": { "path": "/backend/plan", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_PlanCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new plan", "stability": 2, "security": [ "backend.plan" ], "authorization": true, "tags": [ "plan" ] }, "backend.plan.delete": { "path": "/backend/plan/$plan_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "plan_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing plan", "stability": 2, "security": [ "backend.plan" ], "authorization": true, "tags": [ "plan" ] }, "backend.plan.get": { "path": "/backend/plan/$plan_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Plan" } }, "arguments": { "plan_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific plan", "stability": 2, "security": [ "backend.plan" ], "authorization": true, "tags": [ "plan" ] }, "backend.plan.getAll": { "path": "/backend/plan", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_PlanCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of plans", "stability": 2, "security": [ "backend.plan" ], "authorization": true, "tags": [ "plan" ] }, "backend.plan.update": { "path": "/backend/plan/$plan_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "plan_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_PlanUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing plan", "stability": 2, "security": [ "backend.plan" ], "authorization": true, "tags": [ "plan" ] }, "backend.rate.create": { "path": "/backend/rate", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_RateCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new rate limitation", "stability": 2, "security": [ "backend.rate" ], "authorization": true, "tags": [ "rate" ] }, "backend.rate.delete": { "path": "/backend/rate/$rate_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "rate_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing rate", "stability": 2, "security": [ "backend.rate" ], "authorization": true, "tags": [ "rate" ] }, "backend.rate.get": { "path": "/backend/rate/$rate_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Rate" } }, "arguments": { "rate_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific rate", "stability": 2, "security": [ "backend.rate" ], "authorization": true, "tags": [ "rate" ] }, "backend.rate.getAll": { "path": "/backend/rate", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_RateCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of rate limitations", "stability": 2, "security": [ "backend.rate" ], "authorization": true, "tags": [ "rate" ] }, "backend.rate.update": { "path": "/backend/rate/$rate_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "rate_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_RateUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing rate", "stability": 2, "security": [ "backend.rate" ], "authorization": true, "tags": [ "rate" ] }, "backend.role.create": { "path": "/backend/role", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_RoleCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new role", "stability": 2, "security": [ "backend.role" ], "authorization": true, "tags": [ "role" ] }, "backend.role.delete": { "path": "/backend/role/$role_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "role_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing role", "stability": 2, "security": [ "backend.role" ], "authorization": true, "tags": [ "role" ] }, "backend.role.get": { "path": "/backend/role/$role_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Role" } }, "arguments": { "role_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific role", "stability": 2, "security": [ "backend.role" ], "authorization": true, "tags": [ "role" ] }, "backend.role.getAll": { "path": "/backend/role", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_RoleCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of roles", "stability": 2, "security": [ "backend.role" ], "authorization": true, "tags": [ "role" ] }, "backend.role.update": { "path": "/backend/role/$role_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "role_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_RoleUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing role", "stability": 2, "security": [ "backend.role" ], "authorization": true, "tags": [ "role" ] }, "backend.schema.create": { "path": "/backend/schema", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_SchemaCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new schema", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.delete": { "path": "/backend/schema/$schema_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "schema_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing schema", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.get": { "path": "/backend/schema/$schema_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Schema" } }, "arguments": { "schema_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific schema", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.getAll": { "path": "/backend/schema", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SchemaCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of schemas", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.getCommits": { "path": "/backend/schema/$schema_id<[0-9]+|^~>/commit", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SchemaCommitCollection" } }, "arguments": { "schema_id": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of schema commits", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.getPreview": { "path": "/backend/schema/preview/:schema_id", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SchemaPreviewResponse" } }, "arguments": { "schema_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a HTML preview of the provided schema", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.schema.update": { "path": "/backend/schema/$schema_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "schema_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_SchemaUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing schema", "stability": 2, "security": [ "backend.schema" ], "authorization": true, "tags": [ "schema" ] }, "backend.scope.create": { "path": "/backend/scope", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ScopeCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new scope", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.scope.delete": { "path": "/backend/scope/$scope_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "scope_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing scope", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.scope.get": { "path": "/backend/scope/$scope_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Scope" } }, "arguments": { "scope_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific scope", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.scope.getAll": { "path": "/backend/scope", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ScopeCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of scopes", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.scope.getCategories": { "path": "/backend/scope/categories", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_ScopeCategories" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all available scopes grouped by category", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.scope.update": { "path": "/backend/scope/$scope_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "scope_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_ScopeUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing scope", "stability": 2, "security": [ "backend.scope" ], "authorization": true, "tags": [ "scope" ] }, "backend.sdk.generate": { "path": "/backend/sdk", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SdkMessage" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_SdkGenerate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Generates a specific SDK", "stability": 2, "security": [ "backend.sdk" ], "authorization": true, "tags": [ "sdk" ] }, "backend.sdk.getAll": { "path": "/backend/sdk", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SdkResponse" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of SDKs", "stability": 2, "security": [ "backend.sdk" ], "authorization": true, "tags": [ "sdk" ] }, "backend.specification.get": { "path": "/backend/specification", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SpecificationGet" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the TypeHub specification", "stability": 2, "security": [ "backend.specification" ], "authorization": true, "tags": [ "specification" ] }, "backend.specification.getChangelog": { "path": "/backend/specification/changelog", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_SpecificationChangelog" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns the changelog between your current specification and the last tag", "stability": 2, "security": [ "backend.specification" ], "authorization": true, "tags": [ "specification" ] }, "backend.specification.publish": { "path": "/backend/specification", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_SpecificationPublish" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Publish the specification", "stability": 2, "security": [ "backend.specification" ], "authorization": true, "tags": [ "specification" ] }, "backend.specification.tag": { "path": "/backend/specification/tag", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Passthru" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new tag of your specification", "stability": 2, "security": [ "backend.specification" ], "authorization": true, "tags": [ "specification" ] }, "backend.statistic.getActivitiesPerUser": { "path": "/backend/statistic/activities_per_user", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the activities per user", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getCountRequests": { "path": "/backend/statistic/count_requests", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticCount" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the request count", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getErrorsPerOperation": { "path": "/backend/statistic/errors_per_operation", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the errors per operation", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getIncomingRequests": { "path": "/backend/statistic/incoming_requests", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the incoming requests", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getIncomingTransactions": { "path": "/backend/statistic/incoming_transactions", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the incoming transactions", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getIssuedTokens": { "path": "/backend/statistic/issued_tokens", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the issues tokens", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getMostUsedActivities": { "path": "/backend/statistic/most_used_activities", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the most used activities", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getMostUsedApps": { "path": "/backend/statistic/most_used_apps", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the most used apps", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getMostUsedOperations": { "path": "/backend/statistic/most_used_operations", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the most used operations", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getRequestsPerIP": { "path": "/backend/statistic/requests_per_ip", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the requests per ip", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getRequestsPerOperation": { "path": "/backend/statistic/requests_per_operation", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the requests per operation", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getRequestsPerUser": { "path": "/backend/statistic/requests_per_user", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the requests per user", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getTestCoverage": { "path": "/backend/statistic/test_coverage", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the test coverage", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getTimeAverage": { "path": "/backend/statistic/time_average", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the time average", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getTimePerOperation": { "path": "/backend/statistic/time_per_operation", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the time per operation", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getUsedPoints": { "path": "/backend/statistic/used_points", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the used points", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.statistic.getUserRegistrations": { "path": "/backend/statistic/user_registrations", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_StatisticChart" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "operationId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "ip": { "in": "query", "schema": { "type": "string" } }, "userAgent": { "in": "query", "schema": { "type": "string" } }, "method": { "in": "query", "schema": { "type": "string" } }, "path": { "in": "query", "schema": { "type": "string" } }, "header": { "in": "query", "schema": { "type": "string" } }, "body": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a statistic containing the user registrations", "stability": 2, "security": [ "backend.statistic" ], "authorization": true, "tags": [ "statistic" ] }, "backend.taxonomy.create": { "path": "/backend/taxonomy", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TaxonomyCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new taxonomy", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.taxonomy.delete": { "path": "/backend/taxonomy/$taxonomy_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "taxonomy_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing taxonomy", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.taxonomy.get": { "path": "/backend/taxonomy/$taxonomy_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Taxonomy" } }, "arguments": { "taxonomy_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific taxonomy", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.taxonomy.getAll": { "path": "/backend/taxonomy", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TaxonomyCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of taxonomies", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.taxonomy.move": { "path": "/backend/taxonomy/$taxonomy_id<[0-9]+|^~>", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "taxonomy_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TaxonomyMove" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Moves the provided ids to the taxonomy", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.taxonomy.update": { "path": "/backend/taxonomy/$taxonomy_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "taxonomy_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TaxonomyUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing taxonomy", "stability": 2, "security": [ "backend.taxonomy" ], "authorization": true, "tags": [ "taxonomy" ] }, "backend.tenant.remove": { "path": "/backend/tenant/:tenant_id", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "tenant_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Removes an existing tenant", "stability": 2, "security": [ "backend.tenant" ], "authorization": true, "tags": [ "tenant" ] }, "backend.tenant.setup": { "path": "/backend/tenant/:tenant_id", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "tenant_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Setup a new tenant", "stability": 2, "security": [ "backend.tenant" ], "authorization": true, "tags": [ "tenant" ] }, "backend.test.get": { "path": "/backend/test/$test_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Test" } }, "arguments": { "test_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific test", "stability": 2, "security": [ "backend.test" ], "authorization": true, "tags": [ "test" ] }, "backend.test.getAll": { "path": "/backend/test", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TestCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of tests", "stability": 2, "security": [ "backend.test" ], "authorization": true, "tags": [ "test" ] }, "backend.test.refresh": { "path": "/backend/test", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Refresh all tests", "stability": 2, "security": [ "backend.test" ], "authorization": true, "tags": [ "test" ] }, "backend.test.run": { "path": "/backend/test", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Run all tests", "stability": 2, "security": [ "backend.test" ], "authorization": true, "tags": [ "test" ] }, "backend.test.update": { "path": "/backend/test/$test_id<[0-9]+>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "test_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_Test" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing test", "stability": 2, "security": [ "backend.test" ], "authorization": true, "tags": [ "test" ] }, "backend.token.get": { "path": "/backend/token/$token_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Token" } }, "arguments": { "token_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific token", "stability": 2, "security": [ "backend.token" ], "authorization": true, "tags": [ "token" ] }, "backend.token.getAll": { "path": "/backend/token", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TokenCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "status": { "in": "query", "schema": { "type": "integer" } }, "scope": { "in": "query", "schema": { "type": "string" } }, "ip": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of tokens", "stability": 2, "security": [ "backend.token" ], "authorization": true, "tags": [ "token" ] }, "backend.transaction.get": { "path": "/backend/transaction/$transaction_id<[0-9]+>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Transaction" } }, "arguments": { "transaction_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific transaction", "stability": 2, "security": [ "backend.transaction" ], "authorization": true, "tags": [ "transaction" ] }, "backend.transaction.getAll": { "path": "/backend/transaction", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TransactionCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "from": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "to": { "in": "query", "schema": { "type": "string", "format": "date-time" } }, "planId": { "in": "query", "schema": { "type": "integer" } }, "userId": { "in": "query", "schema": { "type": "integer" } }, "appId": { "in": "query", "schema": { "type": "integer" } }, "status": { "in": "query", "schema": { "type": "string" } }, "provider": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of transactions", "stability": 2, "security": [ "backend.transaction" ], "authorization": true, "tags": [ "transaction" ] }, "backend.trash.getAllByType": { "path": "/backend/trash/:type", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TrashDataCollection" } }, "arguments": { "type": { "in": "path", "schema": { "type": "string" } }, "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all deleted records by trash type", "stability": 2, "security": [ "backend.trash" ], "authorization": true, "tags": [ "trash" ] }, "backend.trash.getTypes": { "path": "/backend/trash", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TrashTypes" } }, "arguments": [], "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns all trash types", "stability": 2, "security": [ "backend.trash" ], "authorization": true, "tags": [ "trash" ] }, "backend.trash.restore": { "path": "/backend/trash/:type", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "type": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TrashRestore" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Restores a previously deleted record", "stability": 2, "security": [ "backend.trash" ], "authorization": true, "tags": [ "trash" ] }, "backend.trigger.create": { "path": "/backend/trigger", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TriggerCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new trigger", "stability": 2, "security": [ "backend.trigger" ], "authorization": true, "tags": [ "trigger" ] }, "backend.trigger.delete": { "path": "/backend/trigger/$trigger_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "trigger_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing trigger", "stability": 2, "security": [ "backend.trigger" ], "authorization": true, "tags": [ "trigger" ] }, "backend.trigger.get": { "path": "/backend/trigger/$trigger_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Trigger" } }, "arguments": { "trigger_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific trigger", "stability": 2, "security": [ "backend.trigger" ], "authorization": true, "tags": [ "trigger" ] }, "backend.trigger.getAll": { "path": "/backend/trigger", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_TriggerCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } }, "taxonomy": { "in": "query", "schema": { "type": "integer" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of triggers", "stability": 2, "security": [ "backend.trigger" ], "authorization": true, "tags": [ "trigger" ] }, "backend.trigger.update": { "path": "/backend/trigger/$trigger_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "trigger_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_TriggerUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing trigger", "stability": 2, "security": [ "backend.trigger" ], "authorization": true, "tags": [ "trigger" ] }, "backend.user.create": { "path": "/backend/user", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_UserCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new user", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.user.delete": { "path": "/backend/user/$user_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "user_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing user", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.user.get": { "path": "/backend/user/$user_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_User" } }, "arguments": { "user_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific user", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.user.getAll": { "path": "/backend/user", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_UserCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of users", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.user.resend": { "path": "/backend/user/$user_id<[0-9]+|^~>/resend", "method": "POST", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "user_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Passthru" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Resend the activation mail to the provided user", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.user.update": { "path": "/backend/user/$user_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "user_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_UserUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing user", "stability": 2, "security": [ "backend.user" ], "authorization": true, "tags": [ "user" ] }, "backend.webhook.create": { "path": "/backend/webhook", "method": "POST", "return": { "code": 201, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_WebhookCreate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Creates a new webhook", "stability": 2, "security": [ "backend.webhook" ], "authorization": true, "tags": [ "webhook" ] }, "backend.webhook.delete": { "path": "/backend/webhook/$webhook_id<[0-9]+|^~>", "method": "DELETE", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "webhook_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Deletes an existing webhook", "stability": 2, "security": [ "backend.webhook" ], "authorization": true, "tags": [ "webhook" ] }, "backend.webhook.get": { "path": "/backend/webhook/$webhook_id<[0-9]+|^~>", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_Webhook" } }, "arguments": { "webhook_id": { "in": "path", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a specific webhook", "stability": 2, "security": [ "backend.webhook" ], "authorization": true, "tags": [ "webhook" ] }, "backend.webhook.getAll": { "path": "/backend/webhook", "method": "GET", "return": { "code": 200, "schema": { "type": "reference", "target": "Backend_WebhookCollection" } }, "arguments": { "startIndex": { "in": "query", "schema": { "type": "integer" } }, "count": { "in": "query", "schema": { "type": "integer" } }, "search": { "in": "query", "schema": { "type": "string" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Returns a paginated list of webhooks", "stability": 2, "security": [ "backend.webhook" ], "authorization": true, "tags": [ "webhook" ] }, "backend.webhook.update": { "path": "/backend/webhook/$webhook_id<[0-9]+|^~>", "method": "PUT", "return": { "code": 200, "schema": { "type": "reference", "target": "Common_Message" } }, "arguments": { "webhook_id": { "in": "path", "schema": { "type": "string" } }, "payload": { "in": "body", "schema": { "type": "reference", "target": "Backend_WebhookUpdate" } } }, "throws": [ { "code": 999, "schema": { "type": "reference", "target": "Common_Message" } } ], "description": "Updates an existing webhook", "stability": 2, "security": [ "backend.webhook" ], "authorization": true, "tags": [ "webhook" ] } }, "definitions": { "Agent_Input": { "description": "This object represents an agent input", "type": "struct", "properties": { "previousId": { "description": "Optional the chat id of this conversation", "type": "string" }, "item": { "type": "reference", "target": "Agent_Item" } } }, "Agent_Item": { "description": "Agent item", "type": "struct", "base": true, "properties": { "type": { "description": "The result type", "type": "string" }, "metadata": { "description": "Optional result metadata", "type": "map", "schema": { "type": "any" } } }, "discriminator": "type", "mapping": { "Agent_ItemBinary": "binary", "Agent_ItemChoice": "choice", "Agent_ItemObject": "object", "Agent_ItemText": "text", "Agent_ItemToolCall": "tool_call" } }, "Agent_ItemBinary": { "description": "Binary agent message", "type": "struct", "parent": { "type": "reference", "target": "Agent_Item" }, "properties": { "mime": { "description": "The mime of the binary data", "type": "string" }, "data": { "description": "The base64 encoded binary data", "type": "string" } } }, "Agent_ItemChoice": { "description": "Choice agent message", "type": "struct", "parent": { "type": "reference", "target": "Agent_Item" }, "properties": { "items": { "description": "Contains multiple agent items", "type": "array", "schema": { "type": "reference", "target": "Agent_Item" } } } }, "Agent_ItemObject": { "description": "Structured agent message", "type": "struct", "parent": { "type": "reference", "target": "Agent_Item" }, "properties": { "payload": { "description": "The structured JSON payload", "type": "any" } } }, "Agent_ItemText": { "description": "Text agent message", "type": "struct", "parent": { "type": "reference", "target": "Agent_Item" }, "properties": { "content": { "description": "The content text", "type": "string" } } }, "Agent_ItemToolCall": { "description": "Tool call agent message", "type": "struct", "parent": { "type": "reference", "target": "Agent_Item" }, "properties": { "functions": { "description": "An array of concrete functions", "type": "array", "schema": { "type": "reference", "target": "Agent_ItemToolCallFunction" } } } }, "Agent_ItemToolCallFunction": { "description": "Concrete values for a function tool call", "type": "struct", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "arguments": { "type": "string" } } }, "Agent_Output": { "description": "This object represents an agent output", "type": "struct", "properties": { "id": { "description": "Chat id of this conversation", "type": "string" }, "item": { "type": "reference", "target": "Agent_Item" } } }, "Backend_AccountChangePassword": { "type": "struct", "properties": { "oldPassword": { "description": "The old password", "type": "string" }, "newPassword": { "description": "The new password", "type": "string" }, "verifyPassword": { "description": "To verify the new password must contain the same value as the new password", "type": "string" } } }, "Backend_Action": { "description": "This object represents the business logic which can be executed either through an operation or cronjob", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "class": { "description": "Underlying class of this action which handles the action logic", "type": "string" }, "async": { "description": "Whether to execute the action asynchronously, if true the action directly returns a 202 response and the action is executed later on in the background, useful for expensive operations", "type": "boolean" }, "config": { "description": "Contains the action specific configuration. The config depends on the action class, you can get all details of the config format by passing the class to the backend-action-getForm tool", "type": "reference", "target": "Backend_ActionConfig" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_ActionCollection": { "description": "A paginated collection of action objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Action" } } }, "Backend_ActionCommit": { "description": "An action commit which represents a change in the action configuration", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "user": { "description": "The user which has made the change", "type": "reference", "target": "Backend_User" }, "commitHash": { "description": "A unique hash which represents this commit", "type": "string" }, "config": { "description": "The provided action configuration", "type": "reference", "target": "Backend_ActionConfig" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_ActionCommitCollection": { "description": "A paginated collection of action commit objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_ActionCommit" } } }, "Backend_ActionConfig": { "description": "The action configuration which contains arbitrary key-value entries", "type": "map", "schema": { "type": "any" } }, "Backend_ActionCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Action" } }, "Backend_ActionExecuteRequest": { "description": "Represents a request to execute an action", "type": "struct", "properties": { "method": { "description": "HTTP method i.e. GET, POST", "type": "string" }, "uriFragments": { "description": "URL-encoded uri fragments i.e. foo=bar&bar=foo", "type": "string" }, "parameters": { "description": "URL-encoded query parameters i.e. foo=bar&bar=foo", "type": "string" }, "headers": { "description": "URL-encoded headers i.e. foo=bar&bar=foo", "type": "string" }, "body": { "description": "Request body of this execution", "type": "reference", "target": "Backend_ActionExecuteRequestBody" } } }, "Backend_ActionExecuteRequestBody": { "description": "Represents a request body", "type": "map", "schema": { "type": "any" } }, "Backend_ActionExecuteResponse": { "description": "Represents an action execution response", "type": "struct", "properties": { "statusCode": { "description": "HTTP status code i.e. 200, 400, etc.", "type": "integer" }, "headers": { "description": "The response header returned by the action", "type": "reference", "target": "Backend_ActionExecuteResponseHeaders" }, "body": { "description": "The response body returned by the action", "type": "reference", "target": "Backend_ActionExecuteResponseBody" } } }, "Backend_ActionExecuteResponseBody": { "description": "Represents a response body", "type": "map", "schema": { "type": "any" } }, "Backend_ActionExecuteResponseHeaders": { "description": "Represents a map of headers", "type": "map", "schema": { "type": "string" } }, "Backend_ActionIndex": { "description": "Contains all possible classes which can be used at an action as class", "type": "struct", "properties": { "actions": { "type": "array", "schema": { "type": "reference", "target": "Backend_ActionIndexEntry" } } } }, "Backend_ActionIndexEntry": { "description": "Represents a concrete action class", "type": "struct", "properties": { "name": { "description": "Human-readable name of the action class", "type": "string" }, "class": { "description": "Technical identifier of the action class", "type": "string" } } }, "Backend_ActionUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Action" } }, "Backend_Agent": { "description": "This object represents an agent", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "connection": { "description": "The agent connection which should be used", "type": "integer" }, "type": { "description": "The agent type", "type": "integer" }, "public": { "description": "Indicates whether the agent is public", "type": "boolean" }, "name": { "description": "Name of the agent", "type": "string" }, "description": { "description": "Description of the agent", "type": "string" }, "introduction": { "description": "Introduction message", "type": "string" }, "temperature": { "description": "The used temperature default is 1.0", "type": "number" }, "costs": { "description": "Costs per token", "type": "integer" }, "tools": { "description": "Tools available to this agent", "type": "array", "schema": { "type": "string" } }, "outgoing": { "description": "Describes the outgoing response payload, this must contain a schema name", "type": "string" }, "action": { "description": "Action which gets invoked for each generated response", "type": "string" }, "insertDate": { "type": "string", "format": "date-time" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_AgentCollection": { "description": "Represents a collection of agent messages", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Agent" } } }, "Backend_AgentCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Agent" } }, "Backend_AgentMessage": { "description": "This object represents an agent message", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "chatId": { "description": "The assigned chat id which can be used to load the complete conversation", "type": "string" }, "role": { "description": "The role of this message i.e. user, assistant or system", "type": "string" }, "item": { "description": "The message item", "type": "reference", "target": "Agent_Item" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_AgentMessageCollection": { "description": "Represents a collection of agent messages", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_AgentMessage" } } }, "Backend_AgentTool": { "description": "Represents a concrete tool", "type": "struct", "properties": { "name": { "description": "Name of the tool", "type": "string" }, "description": { "description": "Description of the tool", "type": "string" } } }, "Backend_AgentTools": { "description": "Represents a collection of available tools", "type": "struct", "properties": { "tools": { "type": "array", "schema": { "type": "reference", "target": "Backend_AgentTool" } } } }, "Backend_AgentUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Agent" } }, "Backend_App": { "description": "This object represents an app to access the API on-behalf of a user", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "userId": { "type": "integer" }, "status": { "description": "Status of the object either 1 = active, 2 = pending, 3 = deactivated or 4 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "url": { "description": "Url where the app is hosted", "type": "string" }, "parameters": { "description": "Optional URL-encoded parameters of the app i.e. foo=bar&bar=foo", "type": "string" }, "appKey": { "description": "The app key also known as client id which is generated on creation", "type": "string" }, "appSecret": { "description": "The app secret also known as client secret which is generated on creation", "type": "string" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" }, "date": { "description": "The create date of this object", "type": "string", "format": "date-time" }, "scopes": { "description": "A list of assigned scopes for this app", "type": "array", "schema": { "type": "string" } }, "tokens": { "description": "A list of tokens which are assigned to this app", "type": "array", "schema": { "type": "reference", "target": "Backend_Token" } } } }, "Backend_AppCollection": { "description": "A paginated collection of app objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_App" } } }, "Backend_AppCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_App" } }, "Backend_AppUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_App" } }, "Backend_Audit": { "description": "This object represents an audit which is created every time something was changed at the system", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "app": { "type": "reference", "target": "Backend_App" }, "user": { "type": "reference", "target": "Backend_User" }, "event": { "description": "Trigger event of this audit", "type": "string" }, "ip": { "description": "IP which as issued the request", "type": "string" }, "message": { "description": "Message of this audit event", "type": "string" }, "content": { "description": "Content of this adit event", "type": "reference", "target": "Backend_AuditObject" }, "date": { "description": "Insert date of this audit event", "type": "string", "format": "date-time" } } }, "Backend_AuditCollection": { "description": "A paginated collection of audit objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Audit" } } }, "Backend_AuditObject": { "description": "A key value object containing the changes", "type": "map", "schema": { "type": "any" } }, "Backend_BackupExport": { "description": "Export of the complete system configuration", "type": "struct", "properties": { "export": { "type": "string" } } }, "Backend_BackupImport": { "description": "Import a previously exported system configuration", "type": "struct", "properties": { "import": { "type": "string" } } }, "Backend_BackupImportResult": { "description": "Result of a backup import operation", "type": "struct", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "logs": { "type": "array", "schema": { "type": "string" } } } }, "Backend_Bundle": { "description": "This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "version": { "description": "Version of this bundle", "type": "string" }, "icon": { "description": "Icon to represent this bundle", "type": "string" }, "summary": { "description": "Short summary which explains the use case for this bundle", "type": "string" }, "description": { "description": "Long description how to use this bundle may also contains markdown syntax", "type": "string" }, "cost": { "description": "Optional a cost for this bundle", "type": "integer" }, "config": { "description": "The bundle configuration", "type": "reference", "target": "Backend_BundleConfig" } } }, "Backend_BundleCollection": { "description": "A paginated collection of bundle objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Bundle" } } }, "Backend_BundleConfig": { "type": "map", "schema": { "type": "any" } }, "Backend_BundleCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Bundle" } }, "Backend_BundleUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Bundle" } }, "Backend_Category": { "description": "This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" } } }, "Backend_CategoryCollection": { "description": "A paginated collection of category objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Category" } } }, "Backend_CategoryCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Category" } }, "Backend_CategoryUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Category" } }, "Backend_Config": { "description": "This object represents a system configuration", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "type": { "description": "The config value type", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "description": "A short description fo this configuration value", "type": "string" }, "value": { "description": "The actual config value", "type": "any" } } }, "Backend_ConfigCollection": { "description": "A paginated collection of config objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Config" } } }, "Backend_ConfigUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Config" } }, "Backend_Connection": { "description": "This object represents a connection to an external system like i.e. a database, message-queue or client-sdk", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "class": { "description": "Underlying class of this connection which returns a configured client connection i.e. database, message-queue or client-sdk", "type": "string" }, "oauth2": { "description": "Indicates whether it is possible to start an OAuth2 authorization code flow on this connection", "type": "boolean" }, "config": { "description": "Contains the connection specific configuration", "type": "reference", "target": "Backend_ConnectionConfig" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_ConnectionCollection": { "description": "A paginated collection of connection objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Connection" } } }, "Backend_ConnectionConfig": { "description": "The connection configuration which contains arbitrary key-value entries", "type": "map", "schema": { "type": "any" } }, "Backend_ConnectionCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Connection" } }, "Backend_ConnectionIndex": { "description": "Contains all possible classes which can be used at an connection as class", "type": "struct", "properties": { "connections": { "type": "array", "schema": { "type": "reference", "target": "Backend_ConnectionIndexEntry" } } } }, "Backend_ConnectionIndexEntry": { "description": "Represents a concrete connection class", "type": "struct", "properties": { "name": { "description": "Human-readable name of the connection class", "type": "string" }, "class": { "description": "Technical identifier of the connection class", "type": "string" } } }, "Backend_ConnectionRedirectResponse": { "description": "Redirect response to initiate an OAuth2 flow", "type": "struct", "properties": { "redirectUri": { "type": "string" } } }, "Backend_ConnectionUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Connection" } }, "Backend_Cronjob": { "description": "This object represents a cronjob which can invoke an action at a specific interval", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "cron": { "description": "The cron expression i.e. */5 * * * * for every 5 minutes", "type": "string" }, "action": { "description": "The target action which gets invoked", "type": "string" }, "executeDate": { "description": "The last execution date", "type": "string", "format": "date-time" }, "exitCode": { "description": "The last exit code", "type": "integer" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" }, "errors": { "description": "Contains an array of errors in case the cronjob has failed", "type": "array", "schema": { "type": "reference", "target": "Backend_CronjobError" } } } }, "Backend_CronjobCollection": { "description": "A paginated collection of cronjob objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Cronjob" } } }, "Backend_CronjobCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Cronjob" } }, "Backend_CronjobError": { "description": "Represents an error which occurred on cronjob execution", "type": "struct", "properties": { "message": { "type": "string" }, "trace": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "integer" } } }, "Backend_CronjobUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Cronjob" } }, "Backend_Dashboard": { "description": "Represents an object containing all widget data for the dashboard", "type": "struct", "properties": { "errorsPerOperation": { "type": "reference", "target": "Backend_StatisticChart" }, "incomingRequests": { "type": "reference", "target": "Backend_StatisticChart" }, "incomingTransactions": { "type": "reference", "target": "Backend_StatisticChart" }, "mostUsedOperations": { "type": "reference", "target": "Backend_StatisticChart" }, "timePerOperation": { "type": "reference", "target": "Backend_StatisticChart" }, "testCoverage": { "type": "reference", "target": "Backend_StatisticChart" }, "mostUsedActivities": { "type": "reference", "target": "Backend_StatisticChart" }, "activitiesPerUser": { "type": "reference", "target": "Backend_StatisticChart" }, "userRegistrations": { "type": "reference", "target": "Backend_StatisticChart" } } }, "Backend_DatabaseRow": { "description": "This object represents a row on a relational table", "type": "map", "schema": { "type": "any" } }, "Backend_DatabaseRowCollection": { "description": "A paginated collection of database rows", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_DatabaseRow" } } }, "Backend_DatabaseTable": { "description": "This object represents a relational table on a database connection", "type": "struct", "properties": { "name": { "description": "Name of the table", "type": "string" }, "columns": { "description": "Available columns on the table", "type": "array", "schema": { "type": "reference", "target": "Backend_DatabaseTableColumn" } }, "primaryKey": { "description": "The primary key column", "type": "string" }, "indexes": { "description": "Available indices on the table", "type": "array", "schema": { "type": "reference", "target": "Backend_DatabaseTableIndex" } }, "foreignKeys": { "description": "Available foreign key constraints", "type": "array", "schema": { "type": "reference", "target": "Backend_DatabaseTableForeignKeyConstraint" } } } }, "Backend_DatabaseTableCollection": { "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_DatabaseTable" } } }, "Backend_DatabaseTableColumn": { "description": "This object represents a column at a relation table", "type": "struct", "properties": { "name": { "description": "Name of the column", "type": "string" }, "type": { "description": "The column type i.e. integer or string", "type": "string" }, "length": { "description": "Optional the max length of the column", "type": "integer" }, "precision": { "description": "Optional the precision of the column", "type": "integer" }, "scale": { "description": "Optional the scale of the column", "type": "integer" }, "unsigned": { "description": "Indicates whether the column is unsigned, relevant for integer types", "type": "boolean" }, "fixed": { "description": "Indicates whether the column has a fixed length", "type": "boolean" }, "notNull": { "description": "Indicates whether the column allows null", "type": "boolean" }, "autoIncrement": { "description": "Indicates whether this column is an auto increment column", "type": "boolean" }, "default": { "description": "Optional defines the default value", "type": "any" }, "comment": { "description": "Optional a comment for this column", "type": "string" } } }, "Backend_DatabaseTableForeignKeyConstraint": { "description": "This object represents a foreign key constraint on a relational database", "type": "struct", "properties": { "name": { "description": "Name of the foreign key constraint", "type": "string" }, "foreignTable": { "description": "Name of the foreign table", "type": "string" }, "localColumnNames": { "description": "Local column names", "type": "array", "schema": { "type": "string" } }, "foreignColumnNames": { "description": "Foreign column names", "type": "array", "schema": { "type": "string" } } } }, "Backend_DatabaseTableIndex": { "description": "This object represents a table index on a relational database", "type": "struct", "properties": { "name": { "description": "Name of the index", "type": "string" }, "unique": { "description": "Indicates whether the index is unique", "type": "boolean" }, "columns": { "description": "Columns assigned ot the index", "type": "array", "schema": { "type": "string" } } } }, "Backend_Event": { "description": "This object represents an event which can be triggered by an action", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "type": "string" }, "schema": { "type": "string" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_EventCollection": { "description": "A paginated collection of event objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Event" } } }, "Backend_EventCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Event" } }, "Backend_EventUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Event" } }, "Backend_File": { "description": "This object represents a file on the filesystem", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "string" }, "name": { "description": "Name of the file", "type": "string" }, "contentType": { "description": "MIME type of the file", "type": "string" }, "checksum": { "description": "Checksum of the file", "type": "string" }, "lastModified": { "description": "Last modified date of the file", "type": "string", "format": "date-time" } } }, "Backend_FileCollection": { "description": "A paginated collection of file objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_File" } } }, "Backend_Firewall": { "description": "This object represents a firewall rule which blocks specific IP addresses", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "type": { "description": "The type of the rule either 1 = allow or 0 = deny", "type": "integer" }, "ip": { "description": "The target IP address", "type": "string" }, "expire": { "description": "The expire date", "type": "string", "format": "date-time" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_FirewallCollection": { "description": "A paginated collection of firewall objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Firewall" } } }, "Backend_FirewallCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Firewall" } }, "Backend_FirewallUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Firewall" } }, "Backend_Form": { "description": "This object represents a form which helps to dynamically generate a form at a frontend app", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "operationId": { "description": "Target operation which gets invoked through this form", "type": "integer" }, "uiSchema": { "description": "Optional an UI schema to dynamically describe this form", "type": "any" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_FormCollection": { "description": "A paginated collection of form objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Form" } } }, "Backend_FormCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Form" } }, "Backend_FormUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Form" } }, "Backend_GeneratorIndexProvider": { "description": "Represents a concrete generator class", "type": "struct", "properties": { "name": { "description": "Human-readable name of the generator class", "type": "string" }, "class": { "description": "Technical identifier of the generator class", "type": "string" } } }, "Backend_GeneratorIndexProviders": { "description": "Contains all possible classes which can be used at an generator as class", "type": "struct", "properties": { "providers": { "type": "array", "schema": { "type": "reference", "target": "Backend_GeneratorIndexProvider" } } } }, "Backend_GeneratorProvider": { "type": "struct", "properties": { "path": { "type": "string" }, "scopes": { "type": "array", "schema": { "type": "string" } }, "public": { "type": "boolean" }, "config": { "type": "reference", "target": "Backend_GeneratorProviderConfig" } } }, "Backend_GeneratorProviderChangelog": { "type": "struct", "properties": { "schemas": { "type": "array", "schema": { "type": "reference", "target": "Backend_Schema" } }, "actions": { "type": "array", "schema": { "type": "reference", "target": "Backend_Action" } }, "operations": { "type": "array", "schema": { "type": "reference", "target": "Backend_Operation" } } } }, "Backend_GeneratorProviderConfig": { "type": "map", "schema": { "type": "any" } }, "Backend_HttpRequest": { "description": "This object represents a HTTP request", "type": "struct", "properties": { "method": { "description": "HTTP method i.e. GET, POST", "type": "string" }, "uri": { "description": "HTTP request uri", "type": "string" }, "headers": { "description": "HTTP request headers", "type": "map", "schema": { "type": "string" } }, "body": { "description": "HTTP request body", "type": "string" } } }, "Backend_HttpResponse": { "description": "This object represents a HTTP response", "type": "struct", "properties": { "statusCode": { "description": "HTTP status code", "type": "integer" }, "headers": { "description": "HTTP response headers", "type": "map", "schema": { "type": "string" } }, "body": { "description": "HTTP response body", "type": "string" } } }, "Backend_Identity": { "description": "This object represents an identity which allows to authenticate with a remote identity provider", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "appId": { "description": "The target app for this identity", "type": "integer" }, "roleId": { "description": "Role which is assigned to new users", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "icon": { "description": "An icon for this identity provider", "type": "string" }, "class": { "description": "Underlying class of this identity provider", "type": "string" }, "config": { "type": "reference", "target": "Backend_IdentityConfig" }, "allowCreate": { "type": "boolean" } } }, "Backend_IdentityCollection": { "description": "A paginated collection of identity objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Identity" } } }, "Backend_IdentityConfig": { "type": "map", "schema": { "type": "any" } }, "Backend_IdentityCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Identity" } }, "Backend_IdentityIndex": { "description": "Contains all possible classes which can be used at an identity as class", "type": "struct", "properties": { "providers": { "type": "array", "schema": { "type": "reference", "target": "Backend_IdentityIndexEntry" } } } }, "Backend_IdentityIndexEntry": { "description": "Represents a concrete identity class", "type": "struct", "properties": { "name": { "description": "Human-readable name of the identity class", "type": "string" }, "class": { "description": "Technical identifier of the identity class", "type": "string" } } }, "Backend_IdentityUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Identity" } }, "Backend_Log": { "description": "This object represents a log entry. Every HTTP requests to the system generates such a log entry.", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "ip": { "description": "The remote IP which has initiated the request", "type": "string" }, "userAgent": { "description": "The user agent provided by the HTTP user agent header", "type": "string" }, "method": { "description": "The HTTP method i.e. GET or POST", "type": "string" }, "path": { "description": "The target path", "type": "string" }, "header": { "description": "The provided HTTP headers", "type": "string" }, "body": { "description": "The provided HTTP body", "type": "string" }, "date": { "description": "Insert date of this request", "type": "string", "format": "date-time" }, "errors": { "description": "An array of errors which occurred through this request", "type": "array", "schema": { "type": "reference", "target": "Backend_LogError" } } } }, "Backend_LogCollection": { "description": "A paginated collection of log objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Log" } } }, "Backend_LogError": { "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "logId": { "type": "integer" }, "message": { "type": "string" }, "trace": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "integer" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_LogErrorCollection": { "description": "A paginated collection of log error objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_LogError" } } }, "Backend_Operation": { "description": "This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "active": { "description": "Indicates whether the operation is active", "type": "boolean" }, "public": { "description": "Indicates whether the operation is public, if false a user must provide an Authorization header with an Bearer access token", "type": "boolean" }, "stability": { "description": "Describes the stability of this operation 0 = deprecated, 1 = experimental, 2 = stable and 3 = legacy", "type": "integer" }, "description": { "description": "A short description of this operation, it should explain the operation in a simple and precise way", "type": "string" }, "httpMethod": { "description": "The target HTTP method i.e. GET or POST", "type": "string" }, "httpPath": { "description": "The target HTTP path i.e. /foo or /product/:product_id", "type": "string" }, "httpCode": { "description": "The success HTTP code i.e. 200 or 201", "type": "integer" }, "name": { "description": "Unique name of the object. It is recommended to group your operations into logical units by using a dot i.e. product.getAll and product.insert which has also an effect on the automatically generated SDK", "type": "string" }, "parameters": { "description": "Describes available query parameters", "type": "reference", "target": "Backend_OperationParameters" }, "incoming": { "description": "Describes the incoming request payload, this must contain a schema name", "type": "string" }, "outgoing": { "description": "Describes the outgoing response payload, this must contain a schema name", "type": "string" }, "throws": { "description": "Describes error responses for i.e. client or server errors", "type": "reference", "target": "Backend_OperationThrows" }, "action": { "description": "The target action to invoke, this must contain an action name", "type": "string" }, "costs": { "description": "Costs to invoke this operation. A user can only invoke this operation in case he has enough points", "type": "integer" }, "scopes": { "description": "Scopes which are required to invoke this operation", "type": "array", "schema": { "type": "string" } }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_OperationCollection": { "description": "A paginated collection of operation objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Operation" } } }, "Backend_OperationCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Operation" } }, "Backend_OperationParameters": { "type": "map", "schema": { "type": "reference", "target": "Backend_OperationSchema" } }, "Backend_OperationSchema": { "type": "struct", "properties": { "description": { "type": "string" }, "type": { "type": "string" }, "format": { "type": "string" }, "enum": { "type": "string" } } }, "Backend_OperationThrows": { "type": "map", "schema": { "type": "string" } }, "Backend_OperationUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Operation" } }, "Backend_Page": { "description": "This object represents a page at the developer portal", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = visible, 2 = invisible or 0 = deleted", "type": "integer" }, "title": { "description": "Title of the page", "type": "string" }, "slug": { "description": "Slug of the page which gets dynamically generated from the title", "type": "string" }, "content": { "description": "HTML content of this page", "type": "string" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_PageCollection": { "description": "A paginated collection of page objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Page" } } }, "Backend_PageCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Page" } }, "Backend_PageUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Page" } }, "Backend_Plan": { "description": "This object represents a plan, a plan allows users to obtain points or in general subscribe to your app", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Name of the plan", "type": "string" }, "description": { "description": "Short description of the plan", "type": "string" }, "price": { "description": "The price of this plan", "type": "number" }, "points": { "description": "The points which are assigned to the user on purchase", "type": "integer" }, "period": { "description": "Whether the plan is one-time or periodically", "type": "integer" }, "externalId": { "description": "An external id of a remote payment provider like Stripe", "type": "string" }, "scopes": { "description": "Scopes which are assigned dynamically to the user on purchase", "type": "array", "schema": { "type": "string" } }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_PlanCollection": { "description": "A paginated collection of plan objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Plan" } } }, "Backend_PlanCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Plan" } }, "Backend_PlanUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Plan" } }, "Backend_Rate": { "description": "This object represents a rate limitation, which allows to limit the requests which a user can send", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "priority": { "description": "All rates are applied based on the priority, higher priorities are applied first", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "rateLimit": { "description": "Maximum number of allowed requests", "type": "integer" }, "timespan": { "description": "Timespan for the allowed requests", "type": "string" }, "allocation": { "description": "Through a rate allocation a user gets assigned to a specific rate", "type": "array", "schema": { "type": "reference", "target": "Backend_RateAllocation" } }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_RateAllocation": { "description": "This object represents a rate allocation, in case a request matches it gets assigned to the attached rate", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "operationId": { "type": "integer" }, "userId": { "type": "integer" }, "planId": { "type": "integer" }, "appId": { "type": "integer" }, "authenticated": { "description": "Whether the request is authenticated", "type": "boolean" } } }, "Backend_RateCollection": { "description": "A paginated collection of rate objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Rate" } } }, "Backend_RateCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Rate" } }, "Backend_RateUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Rate" } }, "Backend_Role": { "description": "This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "categoryId": { "description": "The assigned category id of this role", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "scopes": { "description": "All scopes which are assigned to this role", "type": "array", "schema": { "type": "string" } } } }, "Backend_RoleCollection": { "description": "A paginated collection of role objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Role" } } }, "Backend_RoleCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Role" } }, "Backend_RoleUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Role" } }, "Backend_Schema": { "description": "This object represents a schema to describe a JSON payload", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "source": { "description": "The TypeSchema specification to describe a JSON payload", "type": "reference", "target": "Backend_SchemaSource" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_SchemaCollection": { "description": "A paginated collection of schema objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Schema" } } }, "Backend_SchemaCommit": { "description": "A schema commit which represents a change in the schema source", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "user": { "description": "The user which has made the change", "type": "reference", "target": "Backend_User" }, "commitHash": { "description": "A unique hash which represents this commit", "type": "string" }, "schema": { "description": "The provided schema payload", "type": "reference", "target": "Backend_SchemaSource" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_SchemaCommitCollection": { "description": "A paginated collection of schema commit objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_SchemaCommit" } } }, "Backend_SchemaCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Schema" } }, "Backend_SchemaPreviewResponse": { "type": "struct", "properties": { "preview": { "type": "string" } } }, "Backend_SchemaSource": { "description": "Contains the TypeSchema specification", "type": "map", "schema": { "type": "any" } }, "Backend_SchemaUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Schema" } }, "Backend_Scope": { "description": "This object represents a scope. A scope is assigned to a user and is required to access operations", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "description": { "description": "Short description of the scope", "type": "string" }, "operations": { "description": "All operations which can be access through this scope", "type": "array", "schema": { "type": "reference", "target": "Backend_ScopeOperation" } }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_ScopeCategories": { "type": "struct", "properties": { "categories": { "type": "array", "schema": { "type": "reference", "target": "Backend_ScopeCategory" } } } }, "Backend_ScopeCategory": { "type": "struct", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "scopes": { "type": "array", "schema": { "type": "reference", "target": "Backend_ScopeCategoryScope" } } } }, "Backend_ScopeCategoryScope": { "type": "struct", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "Backend_ScopeCollection": { "description": "A paginated collection of scope objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Scope" } } }, "Backend_ScopeCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Scope" } }, "Backend_ScopeOperation": { "type": "struct", "properties": { "operationId": { "type": "integer" }, "allow": { "type": "boolean" } } }, "Backend_ScopeUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Scope" } }, "Backend_SdkGenerate": { "type": "struct", "properties": { "format": { "type": "string" }, "config": { "type": "string" } } }, "Backend_SdkMessage": { "type": "struct", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "link": { "type": "string" } } }, "Backend_SdkResponse": { "type": "struct", "properties": { "types": { "type": "reference", "target": "Backend_SdkTypes" } } }, "Backend_SdkTypes": { "description": "Represents available SDK type which can be generated", "type": "map", "schema": { "type": "string" } }, "Backend_SpecificationChangelog": { "type": "struct", "properties": { "master": { "type": "any" }, "tag": { "type": "any" }, "version": { "type": "string" }, "changelog": { "type": "string" } } }, "Backend_SpecificationGet": { "type": "struct", "properties": { "spec": { "type": "any" } } }, "Backend_SpecificationPublish": { "type": "struct", "properties": { "name": { "type": "string" }, "filterName": { "type": "string" }, "standalone": { "type": "boolean" } } }, "Backend_StatisticChart": { "type": "struct", "properties": { "labels": { "type": "array", "schema": { "type": "string" } }, "series": { "type": "array", "schema": { "type": "reference", "target": "Backend_StatisticChartSeries" } } } }, "Backend_StatisticChartSeries": { "type": "struct", "properties": { "name": { "type": "string" }, "data": { "type": "array", "schema": { "type": "number" } } } }, "Backend_StatisticCount": { "type": "struct", "properties": { "count": { "type": "integer" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "Backend_Taxonomy": { "description": "This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "parentId": { "description": "Identifier of the parent object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" } } }, "Backend_TaxonomyCollection": { "description": "A paginated collection of taxonomy objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Taxonomy" } } }, "Backend_TaxonomyCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Taxonomy" } }, "Backend_TaxonomyMove": { "description": "Moves the provided objects to a taxonomy", "type": "struct", "properties": { "operations": { "type": "array", "schema": { "type": "integer" } }, "actions": { "type": "array", "schema": { "type": "integer" } }, "schemas": { "type": "array", "schema": { "type": "integer" } }, "events": { "type": "array", "schema": { "type": "integer" } }, "cronjobs": { "type": "array", "schema": { "type": "integer" } }, "triggers": { "type": "array", "schema": { "type": "integer" } } } }, "Backend_TaxonomyUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Taxonomy" } }, "Backend_Test": { "description": "This object represents a test. A test helps to verify that all operations work as expected", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = pending, 2 = success, 3 = warning, 4 = error, 5 = skipped or 6 = disabled", "type": "integer" }, "operationName": { "type": "string" }, "message": { "type": "string" }, "response": { "type": "string" }, "config": { "type": "reference", "target": "Backend_TestConfig" } } }, "Backend_TestCollection": { "description": "A paginated collection of test objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Test" } } }, "Backend_TestConfig": { "type": "struct", "parent": { "type": "reference", "target": "Backend_ActionExecuteRequest" } }, "Backend_Token": { "description": "This object represents a token, this an access token which was requested by a user", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 2 = deleted", "type": "integer" }, "name": { "type": "string" }, "scopes": { "type": "array", "schema": { "type": "string" } }, "ip": { "type": "string" }, "expire": { "type": "string", "format": "date-time" }, "date": { "type": "string", "format": "date-time" } } }, "Backend_TokenCollection": { "description": "A paginated collection of token objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Token" } } }, "Backend_Transaction": { "description": "This object represents a transaction. The system generates a transaction in case a payment was successfully executed", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "userId": { "type": "integer" }, "planId": { "type": "integer" }, "transactionId": { "type": "string" }, "amount": { "type": "number" }, "points": { "type": "number" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "insertDate": { "type": "string", "format": "date-time" } } }, "Backend_TransactionCollection": { "description": "A paginated collection of transaction objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Transaction" } } }, "Backend_TrashData": { "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "status": { "description": "Status of the object either 1 = active or 0 = deleted", "type": "integer" }, "name": { "type": "string" } } }, "Backend_TrashDataCollection": { "description": "A paginated collection of deleted objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_TrashData" } } }, "Backend_TrashRestore": { "type": "struct", "properties": { "id": { "type": "integer" } } }, "Backend_TrashTypes": { "type": "struct", "properties": { "types": { "type": "array", "schema": { "type": "string" } } } }, "Backend_Trigger": { "description": "This object represents a trigger which can invoke an action on a custom event", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "event": { "description": "The name of the trigger event", "type": "string" }, "action": { "description": "The target action which gets invoked", "type": "string" }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" } } }, "Backend_TriggerCollection": { "description": "A paginated collection of trigger objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Trigger" } } }, "Backend_TriggerCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Trigger" } }, "Backend_TriggerUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Trigger" } }, "Backend_User": { "description": "This object represents a user", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "roleId": { "description": "A role which is assigned to the user", "type": "integer" }, "planId": { "description": "A plan which is assigned to the user", "type": "integer" }, "status": { "description": "Status of the object either 1 = active, 2 = disabled or 0 = deleted", "type": "integer" }, "name": { "description": "Unique name of the object", "type": "string" }, "email": { "description": "The email address of the user", "type": "string" }, "points": { "description": "Points assigned to the user", "type": "integer" }, "scopes": { "description": "List of scopes which are assigned to the user", "type": "array", "schema": { "type": "string" } }, "apps": { "type": "array", "schema": { "type": "reference", "target": "Backend_App" } }, "metadata": { "description": "Use this parameter to attach key-value data", "type": "reference", "target": "Common_Metadata" }, "date": { "description": "The insert date", "type": "string", "format": "date-time" } } }, "Backend_UserCollection": { "description": "A paginated collection of user objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_User" } } }, "Backend_UserCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_User" }, "properties": { "password": { "type": "string" } } }, "Backend_UserUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_User" } }, "Backend_Webhook": { "description": "This object represents a webhook, a webhook is called in case a specific event was triggered", "type": "struct", "properties": { "id": { "description": "Unique identifier for the object", "type": "integer" }, "eventId": { "type": "integer" }, "userId": { "type": "integer" }, "name": { "type": "string" }, "endpoint": { "type": "string" }, "responses": { "type": "array", "schema": { "type": "reference", "target": "Backend_WebhookResponse" } } } }, "Backend_WebhookCollection": { "description": "A paginated collection of webhook objects", "type": "struct", "parent": { "type": "reference", "target": "Common_Collection", "template": { "T": "Backend_Webhook" } } }, "Backend_WebhookCreate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Webhook" } }, "Backend_WebhookResponse": { "type": "struct", "properties": { "id": { "type": "integer" }, "status": { "type": "integer" }, "code": { "type": "integer" }, "attempts": { "type": "integer" }, "error": { "type": "string" }, "executeDate": { "type": "string", "format": "date-time" } } }, "Backend_WebhookUpdate": { "type": "struct", "parent": { "type": "reference", "target": "Backend_Webhook" } }, "Common_Collection": { "description": "Base collection", "type": "struct", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "schema": { "type": "generic", "name": "T" } } } }, "Common_FormContainer": { "description": "Represents a config form with a list of elements", "type": "struct", "properties": { "element": { "type": "array", "schema": { "type": "reference", "target": "Common_FormElement" } } } }, "Common_FormElement": { "description": "Form base element", "type": "struct", "base": true, "properties": { "element": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "help": { "type": "string" } }, "discriminator": "type", "mapping": { "Common_FormElementCheckbox": "checkbox", "Common_FormElementCollection": "collection", "Common_FormElementInput": "input", "Common_FormElementMap": "map", "Common_FormElementSelect": "select", "Common_FormElementTextArea": "textarea", "Common_FormElementTypeAPI": "typeapi", "Common_FormElementTypeSchema": "typeschema" } }, "Common_FormElementCheckbox": { "description": "Form element which represents a checkbox element", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" } }, "Common_FormElementCollection": { "description": "Form element which represents a collection element", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" }, "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } }, "Common_FormElementInput": { "description": "Form element which represents an input element", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" }, "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } }, "Common_FormElementMap": { "description": "Form element which represents a map element", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" }, "properties": { "type": { "description": "The input type i.e. text or password, all HTML input types are allowed", "type": "string" } } }, "Common_FormElementSelect": { "description": "Form element which represents a select element", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" }, "properties": { "options": { "description": "Available options for the select element", "type": "array", "schema": { "type": "reference", "target": "Common_FormElementSelectOption" } } } }, "Common_FormElementSelectOption": { "description": "Represents a concrete option entry", "type": "struct", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "Common_FormElementTextArea": { "description": "Form element which represents a textarea", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" }, "properties": { "mode": { "description": "Describes which data is provided at the textarea, this can be i.e. a programming language like php, java or python or also a data format like json", "type": "string" } } }, "Common_FormElementTypeAPI": { "description": "Form element which represents a TypeAPI editor", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" } }, "Common_FormElementTypeSchema": { "description": "Form element which represents a TypeSchema editor", "type": "struct", "parent": { "type": "reference", "target": "Common_FormElement" } }, "Common_Message": { "description": "Common error message", "type": "struct", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "id": { "type": "string" } } }, "Common_Metadata": { "type": "map", "schema": { "type": "string" } }, "MarketplaceAction": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceObject" }, "properties": { "class": { "type": "string" }, "config": { "type": "reference", "target": "MarketplaceActionConfig" } } }, "MarketplaceActionCollection": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceCollection", "template": { "T": "MarketplaceAction" } } }, "MarketplaceActionConfig": { "type": "map", "schema": { "type": "any" } }, "MarketplaceApp": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceObject" }, "properties": { "scopes": { "type": "array", "schema": { "type": "string" } }, "downloadUrl": { "type": "string" }, "hash": { "type": "string" } } }, "MarketplaceAppCollection": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceCollection", "template": { "T": "MarketplaceApp" } } }, "MarketplaceBundle": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceObject" }, "properties": { "config": { "type": "reference", "target": "MarketplaceBundleConfig" } } }, "MarketplaceBundleAction": { "type": "struct", "properties": { "name": { "type": "string" }, "class": { "type": "string" }, "config": { "type": "reference", "target": "MarketplaceBundleActionConfig" } } }, "MarketplaceBundleActionConfig": { "type": "map", "schema": { "type": "any" } }, "MarketplaceBundleCollection": { "type": "struct", "parent": { "type": "reference", "target": "MarketplaceCollection", "template": { "T": "MarketplaceBundle" } } }, "MarketplaceBundleConfig": { "type": "struct", "properties": { "actions": { "type": "array", "schema": { "type": "reference", "target": "MarketplaceBundleAction" } }, "schemas": { "type": "array", "schema": { "type": "reference", "target": "MarketplaceBundleSchema" } }, "events": { "type": "array", "schema": { "type": "reference", "target": "MarketplaceBundleEvent" } }, "cronjobs": { "type": "array", "schema": { "type": "reference", "target": "MarketplaceBundleCronjob" } }, "triggers": { "type": "array", "schema": { "type": "reference", "target": "MarketplaceBundleTrigger" } } } }, "MarketplaceBundleCronjob": { "type": "struct", "properties": { "name": { "type": "string" }, "cron": { "type": "string" }, "action": { "type": "string" } } }, "MarketplaceBundleEvent": { "type": "struct", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "string" } } }, "MarketplaceBundleSchema": { "type": "struct", "properties": { "name": { "type": "string" }, "source": { "type": "reference", "target": "MarketplaceBundleSchemaSource" } } }, "MarketplaceBundleSchemaSource": { "type": "map", "schema": { "type": "any" } }, "MarketplaceBundleTrigger": { "type": "struct", "properties": { "name": { "type": "string" }, "event": { "type": "string" }, "action": { "type": "string" } } }, "MarketplaceCollection": { "type": "struct", "properties": { "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "entry": { "type": "array", "schema": { "type": "generic", "name": "T" } } } }, "MarketplaceInstall": { "description": "Installs an object from the marketplace", "type": "struct", "properties": { "name": { "type": "string" } } }, "MarketplaceMessage": { "type": "struct", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "id": { "type": "string" } } }, "MarketplaceObject": { "description": "Base class of all objects on the marketplace", "type": "struct", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "author": { "type": "reference", "target": "MarketplaceUser" }, "version": { "type": "string" }, "icon": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "cost": { "type": "integer" }, "updateDate": { "type": "string", "format": "date-time" }, "insertDate": { "type": "string", "format": "date-time" } } }, "MarketplaceUser": { "type": "struct", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "verified": { "type": "boolean" } } }, "Passthru": { "description": "No schema information available", "type": "map", "schema": { "type": "any" } } } }