{ "openapi": "3.0.3", "info": { "title": "Auto Appy Custom App & Database API", "version": "2026-09-22.2", "description": "Auto Appy native application API reference, independent of workflow actions. Use the coverage report and exclusions to audit available endpoints. Third-party adapter endpoints are internal-only. Authentication and resource permissions still apply; see each operation for its authentication contract." }, "servers": [ { "url": "https://api.autoappy.com" } ], "security": [ { "ApiKeyBearer": [] } ], "components": { "securitySchemes": { "ApiKeyBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "Auto Appy application API key" }, "UserBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "OAuth access token", "description": "Signed-in Auto Appy actor with platform scope and access to the requested products and records. Connector credentials are not accepted." } } }, "paths": { "/api/v1/auth/me": { "get": { "summary": "Me identity", "operationId": "GET_api_v1_auth_me", "tags": [ "Identity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\IdentityController@me", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:identity,apps,workspaces" ], "description": "Me for identity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/api/v1/apps": { "get": { "summary": "Applications identity", "operationId": "GET_api_v1_apps", "tags": [ "Identity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\IdentityController@applications", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:apps" ], "description": "Applications for identity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/api/v1/workspaces": { "get": { "summary": "Workspaces identity", "operationId": "GET_api_v1_workspaces", "tags": [ "Identity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\IdentityController@workspaces", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:workspaces" ], "description": "Workspaces for identity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/apps": { "get": { "summary": "List app", "operationId": "GET_apps", "tags": [ "App" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppController@index", "x-auth-middleware": [ "api" ], "description": "Index for app. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/modules/{appId}": { "get": { "summary": "Modules app", "operationId": "GET_modules__appId_", "tags": [ "App" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppController@modules", "x-auth-middleware": [ "api" ], "description": "Modules for app. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "appId", "in": "path", "required": true, "description": "App id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/workflows/templates": { "get": { "summary": "List workflow template", "operationId": "GET_workflows_templates", "tags": [ "Workflow template" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowTemplateController@index", "x-auth-middleware": [ "api" ], "description": "Index for workflow template. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/workflows/templates/{templateId}": { "get": { "summary": "Import template workflow template", "operationId": "GET_workflows_templates__templateId_", "tags": [ "Workflow template" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowTemplateController@importTemplate", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Import template for workflow template. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "templateId", "in": "path", "required": true, "description": "Template id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow_templates_extended/{workflow_template_id}": { "get": { "summary": "Get workflow templates extended", "operationId": "GET_workflow_templates_extended__workflow_template_id_", "tags": [ "Workflow templates extended" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowTemplatesExtendedController@show", "x-auth-middleware": [ "api" ], "description": "Show for workflow templates extended. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "workflow_template_id", "in": "path", "required": true, "description": "Workflow template id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/send-welcome-email": { "get": { "summary": "Send welcome mail email", "operationId": "GET_send_welcome_email", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\EmailController@sendWelcomeMail", "x-auth-middleware": [ "api" ], "description": "Send welcome mail for email. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/workflows/execute/{id}": { "get": { "summary": "Execute workflow workflow", "operationId": "GET_workflows_execute__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@executeWorkflow", "x-auth-middleware": [ "api" ], "description": "Execute workflow for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/workflows/execute_delay_workflow": { "post": { "summary": "Execute delay workflow workflow", "operationId": "POST_workflows_execute_delay_workflow", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@executeDelayWorkflow", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthenticateScheduler" ], "description": "Execute delay workflow for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "delay_id": { "type": "string", "format": "uuid", "description": "Delay id. Optional. " }, "task_id": { "type": "string", "format": "uuid", "description": "Task id. Required. " }, "workflow_excution_id": { "type": "integer", "description": "Workflow excution id. Required. Limits: min:1." }, "workflow_data": { "type": "array", "items": {}, "description": "Workflow data. Optional. " }, "next_tasks": { "type": "array", "items": {}, "description": "Next tasks. Optional. " }, "resume_task": { "type": "array", "items": {}, "description": "Resume task. Optional. " } }, "required": [ "task_id", "workflow_excution_id" ] } } } }, "x-authentication": "interactive-session" } }, "/workflows/execute_scheduled_workflow": { "post": { "summary": "Execute scheduled workflow workflow", "operationId": "POST_workflows_execute_scheduled_workflow", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@executeScheduledWorkflow", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthenticateScheduler" ], "description": "Execute scheduled workflow for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow_id": { "type": "string", "format": "uuid", "description": "Workflow id. Required. " }, "task_id": { "type": "string", "format": "uuid", "description": "Task id. Required. " }, "dispatch_id": { "type": "string", "description": "Dispatch id. Required. Limits: size:64." }, "configuration_hash": { "type": "string", "nullable": true, "description": "Configuration hash. Optional. Limits: size:64." }, "scheduled_for": { "type": "string", "format": "date-time", "nullable": true, "description": "Scheduled for. Optional. " } }, "required": [ "workflow_id", "task_id", "dispatch_id" ] } } } }, "x-authentication": "interactive-session" } }, "/founder/redirect": { "get": { "summary": "Redirect after payment founder call payment", "operationId": "GET_founder_redirect", "tags": [ "Founder call payment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FounderCallPaymentController@redirectAfterPayment", "x-auth-middleware": [ "api" ], "description": "Redirect after payment for founder call payment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/agent-builder/models/discover": { "post": { "summary": "Discover agent model", "operationId": "POST_agent_builder_models_discover", "tags": [ "Agent model" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentModelController@discover", "x-auth-middleware": [ "api", "autoappy.product", "throttle:10,1" ], "description": "Discover for agent model. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "description": "Provider. Required. " }, "connection_id": { "type": "string", "description": "Connection id. Required. Limits: max:255." } }, "required": [ "provider", "connection_id" ] } } } }, "x-authentication": "application-api-key" } }, "/agent-builder/catalog": { "get": { "summary": "Catalog agent builder", "operationId": "GET_agent_builder_catalog", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@catalog", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Catalog for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/agent-builder/apps": { "get": { "summary": "Apps agent builder", "operationId": "GET_agent_builder_apps", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@apps", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Apps for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "nullable": true, "description": "Q. Optional. Limits: max:120." }, "description": "Q. Optional. Limits: max:120." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "nullable": true, "description": "Page. Optional. Limits: min:1, max:10000." }, "description": "Page. Optional. Limits: min:1, max:10000." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/agent-builder/apps/{app}/actions": { "get": { "summary": "Actions agent builder", "operationId": "GET_agent_builder_apps__app__actions", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@actions", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Actions for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/agent-builder/apps/{app}/actions/{action}": { "get": { "summary": "Action agent builder", "operationId": "GET_agent_builder_apps__app__actions__action_", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@action", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Action for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "description": "Action identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/agent-builder/workflows": { "get": { "summary": "List agent builder", "operationId": "GET_agent_builder_workflows", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Create agent builder", "operationId": "POST_agent_builder_workflows", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "template": { "type": "string", "nullable": true, "description": "Template. Optional. " } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" } }, "/tasks/{task}/agent-config": { "get": { "summary": "Get agent builder", "operationId": "GET_tasks__task__agent_config", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@show", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update agent builder", "operationId": "PUT_tasks__task__agent_config", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "array", "items": {}, "description": "Config. Required. " } }, "required": [ "config" ] } } } }, "x-authentication": "application-api-key" } }, "/tasks/{task}/agent-enable": { "post": { "summary": "Enable agent builder", "operationId": "POST_tasks__task__agent_enable", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@enable", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Enable for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "string", "description": "Config. Required. " } }, "required": [ "config" ] } } } } } }, "/tasks/{task}/agent-runs": { "get": { "summary": "Runs agent builder", "operationId": "GET_tasks__task__agent_runs", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@runs", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Runs for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/tasks/{task}/agent-test": { "post": { "summary": "Test agent builder", "operationId": "POST_tasks__task__agent_test", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@test", "x-auth-middleware": [ "api", "autoappy.product", "throttle:10,1" ], "description": "Test for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "array", "items": {}, "description": "Input. Required. " } }, "required": [ "input" ] } } } }, "x-authentication": "application-api-key" } }, "/tasks/{task}/agent-memory": { "delete": { "summary": "Clear memory agent builder", "operationId": "DELETE_tasks__task__agent_memory", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@clearMemory", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Clear memory for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/tasks/{task}/agent-mcp": { "post": { "summary": "Mcp agent builder", "operationId": "POST_tasks__task__agent_mcp", "tags": [ "Agent builder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AgentBuilderController@mcp", "x-auth-middleware": [ "api", "autoappy.product", "throttle:60,1" ], "description": "Mcp for agent builder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/{workflow}/mcp-exposure": { "get": { "summary": "Show exposure mcp settings", "operationId": "GET_workflows__workflow__mcp_exposure", "tags": [ "Mcp settings" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\McpSettingsController@showExposure", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show exposure for mcp settings. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Save exposure mcp settings", "operationId": "PUT_workflows__workflow__mcp_exposure", "tags": [ "Mcp settings" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\McpSettingsController@saveExposure", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Save exposure for mcp settings. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enabled. Required. " }, "tool_name": { "type": "string", "description": "Tool name. Required. Limits: max:64." }, "description": { "type": "string", "nullable": true, "description": "Description. Optional. Limits: max:2000." }, "input_schema": { "type": "array", "items": {}, "description": "Input schema. Required. " }, "approval_policy": { "type": "string", "description": "Approval policy. Required. ", "enum": [ "always", "never" ] } }, "required": [ "enabled", "tool_name", "input_schema", "approval_policy" ] } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Disable exposure mcp settings", "operationId": "DELETE_workflows__workflow__mcp_exposure", "tags": [ "Mcp settings" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\McpSettingsController@disableExposure", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Disable exposure for mcp settings. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/tasks/{task}/mcp-sample": { "post": { "summary": "Sample mcp trigger", "operationId": "POST_tasks__task__mcp_sample", "tags": [ "Mcp trigger" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\McpTriggerController@sample", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Sample for mcp trigger. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/{workflow}/graph": { "get": { "summary": "Get workflow graph", "operationId": "GET_workflows__workflow__graph", "tags": [ "Workflow graph" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowGraphController@show", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Show for workflow graph. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update workflow graph", "operationId": "PUT_workflows__workflow__graph", "tags": [ "Workflow graph" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowGraphController@update", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update for workflow graph. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "description": "Revision. Required. Limits: min:0." }, "nodes": { "type": "array", "items": {}, "description": "Nodes. Optional. " }, "edges": { "type": "array", "items": {}, "description": "Edges. Optional. " }, "viewport": { "type": "string", "description": "Viewport. Optional. " } }, "required": [ "revision" ] } } } } } }, "/workflows/{workflow}/graph/nodes": { "post": { "summary": "Add node workflow graph", "operationId": "POST_workflows__workflow__graph_nodes", "tags": [ "Workflow graph" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowGraphController@addNode", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Add node for workflow graph. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "description": "Revision. Required. Limits: min:0." }, "task_type": { "type": "string", "description": "Task type. Required. Limits: max:255." }, "action_type": { "type": "string", "description": "Action type. Required. Limits: max:255." }, "parent_id": { "type": "string", "nullable": true, "description": "Parent id. Optional. Limits: max:255." }, "position": { "type": "string", "description": "Position. Optional. " } }, "required": [ "revision", "task_type", "action_type" ] } } } }, "x-authentication": "application-api-key" } }, "/workflows/{workflow}/graph/delete": { "post": { "summary": "Delete nodes workflow graph", "operationId": "POST_workflows__workflow__graph_delete", "tags": [ "Workflow graph" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowGraphController@deleteNodes", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Delete nodes for workflow graph. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "description": "Revision. Required. Limits: min:0." }, "node_ids": { "type": "array", "items": {}, "description": "Node ids. Required. Limits: min:1." } }, "required": [ "revision", "node_ids" ] } } } }, "x-authentication": "application-api-key" } }, "/workflows/{workflow}/graph/duplicate": { "post": { "summary": "Duplicate workflow graph", "operationId": "POST_workflows__workflow__graph_duplicate", "tags": [ "Workflow graph" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowGraphController@duplicate", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Duplicate for workflow graph. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "description": "Revision. Required. Limits: min:0." }, "node_ids": { "type": "array", "items": {}, "description": "Node ids. Required. Limits: min:1." }, "source_workflow_id": { "type": "string", "nullable": true, "description": "Source workflow id. Optional. Limits: max:255." }, "source_revision": { "type": "integer", "description": "Source revision. Optional. Limits: min:0." }, "offset": { "type": "string", "description": "Offset. Optional. " } }, "required": [ "revision", "node_ids" ] } } } }, "x-authentication": "application-api-key" } }, "/app-connections/catalog": { "get": { "summary": "Catalog app connection", "operationId": "GET_app_connections_catalog", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@catalog", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Catalog for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/app-connections/{id}/replace": { "post": { "summary": "Replace app connection", "operationId": "POST_app_connections__id__replace", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@replace", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Replace for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "replacement_id": { "type": "string", "format": "uuid", "description": "Replacement id. Required. " } }, "required": [ "replacement_id" ] } } } }, "x-authentication": "application-api-key" } }, "/app-connections": { "get": { "summary": "List app connection", "operationId": "GET_app_connections", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Create app connection", "operationId": "POST_app_connections", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "format": "uuid", "description": "App id. Required. " }, "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "profile_id": { "type": "string", "description": "Profile id. Required. " } }, "required": [ "app_id", "name", "profile_id" ] } } } }, "x-authentication": "application-api-key" } }, "/app-connections/{id}": { "get": { "summary": "Get app connection", "operationId": "GET_app_connections__id_", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@show", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update app connection", "operationId": "PUT_app_connections__id_", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Update app connection", "operationId": "PATCH_app_connections__id_", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "delete": { "summary": "Delete app connection", "operationId": "DELETE_app_connections__id_", "tags": [ "App connection" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppConnectionController@destroy", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Destroy for app connection. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/scheduling": { "get": { "summary": "List user scheduling", "operationId": "GET_scheduling", "tags": [ "User scheduling" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserSchedulingController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for user scheduling. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Type. Optional. " }, "description": "Type. Optional. " }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "description": "View. Optional. " }, "description": "View. Optional. " }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1, max:1000000." }, "description": "Page. Optional. Limits: min:1, max:1000000." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per page. Optional. Limits: min:1, max:50." }, "description": "Per page. Optional. Limits: min:1, max:50." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "nullable": true, "description": "Q. Optional. Limits: max:150." }, "description": "Q. Optional. Limits: max:150." }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Workflow id. Optional. " }, "description": "Workflow id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/scheduling/overview": { "get": { "summary": "Invoke scheduling overview", "operationId": "GET_scheduling_overview", "tags": [ "Scheduling overview" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\SchedulingOverviewController", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Invoke for scheduling overview. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow/export/{workflowId}": { "get": { "summary": "Export workflow workflow export import", "operationId": "GET_workflow_export__workflowId_", "tags": [ "Workflow export import" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExportImportController@exportWorkflow", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Export workflow for workflow export import. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "workflowId", "in": "path", "required": true, "description": "Workflow id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow/import": { "post": { "summary": "Import workflow workflow export import", "operationId": "POST_workflow_import", "tags": [ "Workflow export import" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExportImportController@importWorkflow", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Import workflow for workflow export import. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow": { "type": "array", "items": {}, "description": "Workflow. Required. " }, "tasks": { "type": "array", "items": {}, "description": "Tasks. Required. Limits: min:1, max:1000." }, "graph": { "type": "array", "items": {}, "description": "Graph. Optional. " } }, "required": [ "workflow", "tasks" ] } } } }, "x-authentication": "application-api-key" } }, "/folders": { "post": { "summary": "Create folder", "operationId": "POST_folders", "tags": [ "Folder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FolderController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for folder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "parent_id": { "type": "string", "nullable": true, "description": "Parent id. Optional. " }, "icon": { "type": "string", "nullable": true, "description": "Icon. Optional. " } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" }, "get": { "summary": "List folder", "operationId": "GET_folders", "tags": [ "Folder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FolderController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for folder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/folders/{id}": { "put": { "summary": "Update folder", "operationId": "PUT_folders__id_", "tags": [ "Folder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FolderController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for folder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "icon": { "type": "string", "nullable": true, "description": "Icon. Optional. Limits: max:10." } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Delete folder", "operationId": "DELETE_folders__id_", "tags": [ "Folder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FolderController@destroy", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Destroy for folder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/folders/move-workflow": { "post": { "summary": "Move workflow folder", "operationId": "POST_folders_move_workflow", "tags": [ "Folder" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FolderController@moveWorkflow", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Move workflow for folder. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow_id": { "type": "string", "description": "Workflow id. Required. " }, "folder_id": { "type": "string", "nullable": true, "description": "Folder id. Optional. " } }, "required": [ "workflow_id" ] } } } }, "x-authentication": "application-api-key" } }, "/workflows": { "post": { "summary": "Create workflow", "operationId": "POST_workflows", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@store", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Store for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" }, "get": { "summary": "List workflow", "operationId": "GET_workflows", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@index", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Index for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/summery": { "get": { "summary": "Get workflow summery workflow", "operationId": "GET_workflows_summery", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@getWorkflowSummery", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get workflow summery for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/summery/{id}": { "get": { "summary": "Get workflow summery workflow", "operationId": "GET_workflows_summery__id__", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@getWorkflowSummery", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get workflow summery for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/executeSingleTask/{id}": { "post": { "summary": "Execute single task workflow", "operationId": "POST_workflows_executeSingleTask__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@executeSingleTask", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Execute single task for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/workflowdata/{taskId}/{includeCurrentTask}": { "get": { "summary": "Get workflow data workflow", "operationId": "GET_workflows_workflowdata__taskId___includeCurrentTask__", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@getWorkflowData", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get workflow data for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "includeCurrentTask", "in": "path", "required": true, "description": "Include current task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/task-capture-data-status/{id}": { "get": { "summary": "Get task capture data status workflow", "operationId": "GET_workflows_task_capture_data_status__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@getTaskCaptureDataStatus", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get task capture data status for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Set task capture data status workflow", "operationId": "POST_workflows_task_capture_data_status__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@setTaskCaptureDataStatus", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Set task capture data status for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/simple-response/{id}": { "post": { "summary": "Update simple response workflow", "operationId": "POST_workflows_simple_response__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@updateSimpleResponse", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update simple response for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "simple_response": { "type": "boolean", "description": "Simple response. Required. " } }, "required": [ "simple_response" ] } } } }, "x-authentication": "application-api-key" }, "get": { "summary": "Get simple response workflow", "operationId": "GET_workflows_simple_response__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@getSimpleResponse", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get simple response for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/runOnes/{id}": { "post": { "summary": "Run ones workflow", "operationId": "POST_workflows_runOnes__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@runOnes", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Run ones for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/{id}/scheduling": { "get": { "summary": "Scheduling workflow", "operationId": "GET_workflows__id__scheduling", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@scheduling", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Scheduling for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/{id}": { "get": { "summary": "Get workflow", "operationId": "GET_workflows__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@show", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Show for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update workflow", "operationId": "PUT_workflows__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@update", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Delete workflow", "operationId": "DELETE_workflows__id_", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@destroy", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Destroy for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflows/{id}/status": { "post": { "summary": "Update status workflow", "operationId": "POST_workflows__id__status", "tags": [ "Workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowController@updateStatus", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update status for workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status. Required. ", "enum": [ "' . implode('", "'", " $validStatuses)" ] } }, "required": [ "status" ] } } } }, "x-authentication": "application-api-key" } }, "/tasks/task-hierarchy/{taskId}": { "get": { "summary": "Get task hierarchy task", "operationId": "GET_tasks_task_hierarchy__taskId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getTaskHierarchy", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get task hierarchy for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/userProfile/{user_id}": { "get": { "summary": "Get user profile user profile", "operationId": "GET_userProfile__user_id_", "tags": [ "User profile" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserProfileController@getUserProfile", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get user profile for user profile. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "user_id", "in": "path", "required": true, "description": "User id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update user profile user profile", "operationId": "PUT_userProfile__user_id_", "tags": [ "User profile" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserProfileController@updateUserProfile", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update user profile for user profile. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "description": "User id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "nullable": true, "description": "Username. Optional. " }, "user_role": { "type": "string", "nullable": true, "description": "User role. Optional. " }, "contact_number": { "type": "string", "nullable": true, "description": "Contact number. Optional. " }, "business_details": { "type": "string", "nullable": true, "description": "Business details. Optional. " }, "business_website": { "type": "string", "nullable": true, "description": "Business website. Optional. " }, "business_logo": { "type": "string", "nullable": true, "description": "Business logo. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/raise-query": { "post": { "summary": "Create query", "operationId": "POST_raise_query", "tags": [ "Query" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\QueryController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for query. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "queryType": { "type": "string", "description": "Query type. Required. Limits: max:255." }, "queryDescription": { "type": "string", "description": "Query description. Required. " }, "contactNumber": { "type": "string", "description": "Contact number. Required. Limits: max:20." }, "availableTime": { "type": "string", "description": "Available time. Required. Limits: max:50." } }, "required": [ "queryType", "queryDescription", "contactNumber", "availableTime" ] } } } }, "x-authentication": "application-api-key" } }, "/queries": { "get": { "summary": "Show user queries query", "operationId": "GET_queries", "tags": [ "Query" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\QueryController@showUserQueries", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show user queries for query. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow-execution/user": { "get": { "summary": "List workflow execution", "operationId": "GET_workflow_execution_user", "tags": [ "Workflow execution" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExecutionController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for workflow execution. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow-execution/details": { "get": { "summary": "Get workflow execution details workflow execution", "operationId": "GET_workflow_execution_details", "tags": [ "Workflow execution" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExecutionController@getWorkflowExecutionDetails", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get workflow execution details for workflow execution. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow-execution/list": { "get": { "summary": "Index with dto workflow execution", "operationId": "GET_workflow_execution_list", "tags": [ "Workflow execution" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExecutionController@indexWithDTO", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index with dto for workflow execution. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow-execution/task-overview": { "get": { "summary": "User task overview workflow execution", "operationId": "GET_workflow_execution_task_overview", "tags": [ "Workflow execution" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExecutionController@userTaskOverview", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "User task overview for workflow execution. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/workflow-execution/{id}": { "get": { "summary": "Show task results workflow execution", "operationId": "GET_workflow_execution__id_", "tags": [ "Workflow execution" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\WorkflowExecutionController@showTaskResults", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show task results for workflow execution. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/userdata": { "get": { "summary": "Get user data user", "operationId": "GET_userdata", "tags": [ "User" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserController@getUserData", "x-auth-middleware": [ "api" ], "description": "Get user data for user. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/ideas": { "post": { "summary": "Create idea", "operationId": "POST_ideas", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." } }, "required": [ "name" ] } } } }, "x-authentication": "application-api-key" }, "get": { "summary": "List idea", "operationId": "GET_ideas", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}": { "get": { "summary": "Get idea", "operationId": "GET_ideas__id_", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@show", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update idea", "operationId": "PUT_ideas__id_", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "delete": { "summary": "Delete idea", "operationId": "DELETE_ideas__id_", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@destroy", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Destroy for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}/status": { "post": { "summary": "Update status idea", "operationId": "POST_ideas__id__status", "tags": [ "Idea" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaController@updateStatus", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update status for idea. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status. Required. " } }, "required": [ "status" ] } } } }, "x-authentication": "application-api-key" } }, "/ideas/{id}/save-flow": { "post": { "summary": "Save flow idea flow", "operationId": "POST_ideas__id__save_flow", "tags": [ "Idea flow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaFlowController@saveFlow", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Save flow for idea flow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flow": { "type": "array", "items": {}, "description": "Flow. Required. " } }, "required": [ "flow" ] } } } }, "x-authentication": "application-api-key" } }, "/ideas/{id}/flow": { "get": { "summary": "Get active flow idea flow", "operationId": "GET_ideas__id__flow", "tags": [ "Idea flow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaFlowController@getActiveFlow", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get active flow for idea flow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}/flow-history": { "get": { "summary": "Get flow history idea flow", "operationId": "GET_ideas__id__flow_history", "tags": [ "Idea flow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaFlowController@getFlowHistory", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get flow history for idea flow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}/flow/{version}": { "get": { "summary": "Get flow by version idea flow", "operationId": "GET_ideas__id__flow__version_", "tags": [ "Idea flow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaFlowController@getFlowByVersion", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get flow by version for idea flow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "description": "Version identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}/restore/{version}": { "post": { "summary": "Restore version idea flow", "operationId": "POST_ideas__id__restore__version_", "tags": [ "Idea flow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaFlowController@restoreVersion", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Restore version for idea flow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "description": "Version identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/{id}/attachments": { "post": { "summary": "Create idea attachment", "operationId": "POST_ideas__id__attachments", "tags": [ "Idea attachment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaAttachmentController@store", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Store for idea attachment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file_url": { "type": "string", "format": "uri", "description": "File url. Required. " }, "file_name": { "type": "string", "description": "File name. Required. Limits: max:255." }, "type": { "type": "string", "format": "binary", "description": "Type. Required. " } }, "required": [ "file_url", "file_name", "type" ] } } } }, "x-authentication": "application-api-key" }, "get": { "summary": "List idea attachment", "operationId": "GET_ideas__id__attachments", "tags": [ "Idea attachment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaAttachmentController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for idea attachment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/ideas/attachments/{attachmentId}": { "delete": { "summary": "Delete idea attachment", "operationId": "DELETE_ideas_attachments__attachmentId_", "tags": [ "Idea attachment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\IdeaAttachmentController@destroy", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Destroy for idea attachment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Attachment id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/user/preferences": { "get": { "summary": "Get preferences user preference", "operationId": "GET_user_preferences", "tags": [ "User preference" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPreferenceController@getPreferences", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Get preferences for user preference. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save preferences user preference", "operationId": "POST_user_preferences", "tags": [ "User preference" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPreferenceController@savePreferences", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Save preferences for user preference. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow_menu_preference": { "type": "array", "items": {}, "description": "Workflow menu preference. Required. " } }, "required": [ "workflow_menu_preference" ] } } } }, "x-authentication": "application-api-key" } }, "/task-templates/{taskTemplateId}/extended": { "post": { "summary": "Update extended app", "operationId": "POST_task_templates__taskTemplateId__extended", "tags": [ "App" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppController@updateExtended", "x-auth-middleware": [ "api", "autoappy.product", "task.assigned" ], "description": "Update extended for app. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "taskTemplateId", "in": "path", "required": true, "description": "Task template id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "nullable": true, "description": "Tag. Optional. Limits: max:255." } } } } } }, "x-authentication": "application-api-key" } }, "/task-templates/{taskTemplateId}/categories": { "post": { "summary": "Assign categories app", "operationId": "POST_task_templates__taskTemplateId__categories", "tags": [ "App" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppController@assignCategories", "x-auth-middleware": [ "api", "autoappy.product", "task.assigned" ], "description": "Assign categories for app. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "taskTemplateId", "in": "path", "required": true, "description": "Task template id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "categories": { "type": "array", "items": {}, "description": "Categories. Required. " } }, "required": [ "categories" ] } } } }, "x-authentication": "application-api-key" } }, "/task-templates/{taskTemplateId}/showAppWithCategories": { "get": { "summary": "Show app with categories app", "operationId": "GET_task_templates__taskTemplateId__showAppWithCategories", "tags": [ "App" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\AppController@showAppWithCategories", "x-auth-middleware": [ "api", "autoappy.product", "task.assigned" ], "description": "Show app with categories for app. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "taskTemplateId", "in": "path", "required": true, "description": "Task template id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/categories": { "get": { "summary": "List category", "operationId": "GET_categories", "tags": [ "Category" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\CategoryController@index", "x-auth-middleware": [ "api", "autoappy.product", "can:canViewCategories" ], "description": "Index for category. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Type." }, "description": "Type." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Create category", "operationId": "POST_categories", "tags": [ "Category" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\CategoryController@store", "x-auth-middleware": [ "api", "autoappy.product", "can:isAdmin" ], "description": "Store for category. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "parent_id": { "type": "string", "nullable": true, "description": "Parent id. Optional. " }, "type": { "type": "string", "description": "Type. Required. " } }, "required": [ "name", "type" ] } } } }, "x-authentication": "application-api-key" } }, "/rankings": { "get": { "summary": "List task ranking", "operationId": "GET_rankings", "tags": [ "Task ranking" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskRankingController@index", "x-auth-middleware": [ "api", "autoappy.product", "can:isAdmin" ], "description": "Index for task ranking. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/rankings/{id}": { "get": { "summary": "Get task ranking", "operationId": "GET_rankings__id_", "tags": [ "Task ranking" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskRankingController@show", "x-auth-middleware": [ "api", "autoappy.product", "can:isAdmin" ], "description": "Show for task ranking. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Update task ranking", "operationId": "PUT_rankings__id_", "tags": [ "Task ranking" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskRankingController@update", "x-auth-middleware": [ "api", "autoappy.product", "can:isAdmin" ], "description": "Update for task ranking. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/rankings/update-batch": { "post": { "summary": "Update rankings task ranking", "operationId": "POST_rankings_update_batch", "tags": [ "Task ranking" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskRankingController@updateRankings", "x-auth-middleware": [ "api", "autoappy.product", "can:isAdmin" ], "description": "Update rankings for task ranking. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/tasks/getCondition/{next_task_id}": { "get": { "summary": "Get condition task", "operationId": "GET_tasks_getCondition__next_task_id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getCondition", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get condition for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "next_task_id", "in": "path", "required": true, "description": "Next task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/formfields/{taskId}": { "get": { "summary": "Get form fields task", "operationId": "GET_tasks_formfields__taskId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getFormFields", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get form fields for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/updateCondition/{next_task_id}": { "post": { "summary": "Update condition task", "operationId": "POST_tasks_updateCondition__next_task_id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@updateCondition", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update condition for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "next_task_id", "in": "path", "required": true, "description": "Next task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "type": "array", "items": {}, "description": "Conditions. Optional. " } } } } } }, "x-authentication": "interactive-session" } }, "/tasks/output-or-error/{taskId}": { "get": { "summary": "Fetch output or error task", "operationId": "GET_tasks_output_or_error__taskId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@fetchOutputOrError", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Fetch output or error for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/isTriggerNode/{nodeId}": { "get": { "summary": "Is trigger node task", "operationId": "GET_tasks_isTriggerNode__nodeId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@isTriggerNode", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Is trigger node for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "nodeId", "in": "path", "required": true, "description": "Node id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/getNodeChilds/{nodeId}": { "get": { "summary": "Get node childs task", "operationId": "GET_tasks_getNodeChilds__nodeId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getNodeChilds", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get node childs for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "nodeId", "in": "path", "required": true, "description": "Node id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/addNewNode/{parentNodeId}": { "patch": { "summary": "Add new node task", "operationId": "PATCH_tasks_addNewNode__parentNodeId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@addNewNode", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Add new node for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "parentNodeId", "in": "path", "required": true, "description": "Parent node id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_type": { "type": "string", "description": "Task type. Required. " }, "action_type": { "type": "string", "description": "Action type. Required. " }, "sequence": { "type": "integer", "nullable": true, "description": "Sequence. Optional. " }, "insert_between": { "type": "array", "items": {}, "nullable": true, "description": "Insert between. Optional. " } }, "required": [ "task_type", "action_type" ] } } } }, "x-authentication": "interactive-session" } }, "/tasks/deleteNode/{nodeId}": { "delete": { "summary": "Delete node task", "operationId": "DELETE_tasks_deleteNode__nodeId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@deleteNode", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Delete node for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "nodeId", "in": "path", "required": true, "description": "Node id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recursively_delete": { "type": "boolean", "description": "Recursively delete. Required. " }, "has_multiple_child": { "type": "array", "items": {}, "nullable": true, "description": "Has multiple child. Optional. " } }, "required": [ "recursively_delete" ] } } } }, "x-authentication": "interactive-session" } }, "/tasks/updateNode/{taskId}": { "patch": { "summary": "Update node task", "operationId": "PATCH_tasks_updateNode__taskId_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@updateNode", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update node for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_type": { "type": "string", "description": "Task type. Required. " }, "action_type": { "type": "string", "description": "Action type. Required. " }, "is_trigger_node": { "type": "boolean", "description": "Is trigger node. Optional. " } }, "required": [ "task_type", "action_type" ] } } } }, "x-authentication": "interactive-session" } }, "/tasks/metadata/{task_id}": { "get": { "summary": "Get task metadata task", "operationId": "GET_tasks_metadata__task_id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getTaskMetadata", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get task metadata for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/editAppName/{task_id}": { "patch": { "summary": "Edit app name task", "operationId": "PATCH_tasks_editAppName__task_id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@editAppName", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Edit app name for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "boolean", "description": "Override. Required. " }, "name": { "type": "string", "description": "Name. Optional. Limits: max:255." } }, "required": [ "override" ] } } } }, "x-authentication": "interactive-session" } }, "/tasks/editActionName/{task_id}": { "patch": { "summary": "Edit action name task", "operationId": "PATCH_tasks_editActionName__task_id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@editActionName", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Edit action name for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "override": { "type": "boolean", "description": "Override. Required. " }, "name": { "type": "string", "description": "Name. Optional. Limits: max:255." } }, "required": [ "override" ] } } } }, "x-authentication": "interactive-session" } }, "/tasks": { "post": { "summary": "Create task", "operationId": "POST_tasks", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@store", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Store for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow_id": { "type": "string", "description": "Workflow id. Required. " }, "task_type": { "type": "string", "description": "Task type. Required. Limits: max:255." }, "action_type": { "type": "string", "description": "Action type. Required. Limits: max:255." }, "incoming_data": { "type": "array", "items": {}, "nullable": true, "description": "Incoming data. Optional. " }, "outgoing_data": { "type": "array", "items": {}, "nullable": true, "description": "Outgoing data. Optional. " }, "config_data_tag": { "type": "string", "nullable": true, "description": "Config data tag. Optional. Limits: max:255." }, "next_tasks": { "type": "array", "items": {}, "nullable": true, "description": "Next tasks. Optional. " }, "parent_task_id": { "type": "string", "nullable": true, "description": "Parent task id. Optional. Limits: max:255." } }, "required": [ "workflow_id", "task_type", "action_type" ] } } } } } }, "/tasks/{id}": { "get": { "summary": "Get task", "operationId": "GET_tasks__id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@show", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Show for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" }, "put": { "summary": "Update task", "operationId": "PUT_tasks__id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@update", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow_id": { "type": "string", "description": "Workflow id. Required. " }, "task_type": { "type": "string", "description": "Task type. Required. Limits: max:255." }, "action_type": { "type": "string", "description": "Action type. Required. Limits: max:255." }, "incoming_data": { "type": "array", "items": {}, "nullable": true, "description": "Incoming data. Optional. " }, "outgoing_data": { "type": "array", "items": {}, "nullable": true, "description": "Outgoing data. Optional. " }, "config_data_tag": { "type": "string", "nullable": true, "description": "Config data tag. Optional. Limits: max:255." }, "next_tasks": { "type": "array", "items": {}, "nullable": true, "description": "Next tasks. Optional. " }, "parent_task_id": { "type": "string", "nullable": true, "description": "Parent task id. Optional. Limits: max:255." } }, "required": [ "workflow_id", "task_type", "action_type" ] } } } } }, "delete": { "summary": "Delete task", "operationId": "DELETE_tasks__id_", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@destroy", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Destroy for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tasks/{id}/parents": { "post": { "summary": "Get parent tasks task", "operationId": "POST_tasks__id__parents", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@getParentTasks", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get parent tasks for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/plans": { "get": { "summary": "List plan", "operationId": "GET_plans", "tags": [ "Plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PlanController@index", "x-auth-middleware": [ "api" ], "description": "Index for plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/plans/{plan}": { "get": { "summary": "Get plan", "operationId": "GET_plans__plan_", "tags": [ "Plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PlanController@show", "x-auth-middleware": [ "api" ], "description": "Show for plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/payments": { "get": { "summary": "List payment", "operationId": "GET_payments", "tags": [ "Payment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PaymentController@index", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Index for payment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/payments/details": { "get": { "summary": "Payment details payment", "operationId": "GET_payments_details", "tags": [ "Payment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PaymentController@paymentDetails", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Payment details for payment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/payments/process": { "post": { "summary": "Process payment", "operationId": "POST_payments_process", "tags": [ "Payment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PaymentController@process", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Process for payment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User id. Required. " }, "plan_id": { "type": "string", "description": "Plan id. Required. " }, "amount": { "type": "number", "description": "Amount. Required. Limits: min:0." }, "payment_method": { "type": "string", "description": "Payment method. Required. " } }, "required": [ "user_id", "plan_id", "amount", "payment_method" ] } } } }, "x-authentication": "application-api-key" } }, "/payments/processPayment": { "post": { "summary": "Process payment payment", "operationId": "POST_payments_processPayment", "tags": [ "Payment" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\PaymentController@processPayment", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Process payment for payment. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Message. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/user-plans/consume-tasks": { "post": { "summary": "Consume tasks user plan", "operationId": "POST_user_plans_consume_tasks", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@consumeTasks", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Consume tasks for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User id. Required. " }, "task_count": { "type": "integer", "description": "Task count. Required. Limits: min:1." } }, "required": [ "user_id", "task_count" ] } } } }, "x-authentication": "application-api-key" } }, "/user-plans": { "post": { "summary": "Create user plan", "operationId": "POST_user_plans", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@create", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Create for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User id. Required. " }, "plan_id": { "type": "string", "description": "Plan id. Required. " }, "initial_task_balance": { "type": "integer", "description": "Initial task balance. Required. Limits: min:0." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starts at. Required. " }, "expires_at": { "type": "string", "format": "date-time", "description": "Expires at. Required. " } }, "required": [ "user_id", "plan_id", "initial_task_balance", "starts_at", "expires_at" ] } } } }, "x-authentication": "application-api-key" } }, "/user-plans/allocate-initial-tasks": { "post": { "summary": "Allocate initial tasks user plan", "operationId": "POST_user_plans_allocate_initial_tasks", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@allocateInitialTasks", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Allocate initial tasks for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User id. Required. " }, "initial_task_balance": { "type": "integer", "description": "Initial task balance. Required. Limits: min:1." } }, "required": [ "user_id", "initial_task_balance" ] } } } }, "x-authentication": "application-api-key" } }, "/user-plans/{id}": { "put": { "summary": "Update user plan", "operationId": "PUT_user_plans__id_", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@update", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Update for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "Plan id. Optional. " }, "initial_task_balance": { "type": "integer", "description": "Initial task balance. Optional. Limits: min:0." }, "remaining_task_balance": { "type": "integer", "description": "Remaining task balance. Optional. Limits: min:0." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starts at. Optional. " }, "expires_at": { "type": "string", "format": "date-time", "description": "Expires at. Optional. " } } } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Delete user plan", "operationId": "DELETE_user_plans__id_", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@delete", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Delete for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "get": { "summary": "Get user plan", "operationId": "GET_user_plans__id_", "tags": [ "User plan" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\UserPlanController@show", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Show for user plan. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/tasks/{id}/status": { "post": { "summary": "Update status task", "operationId": "POST_tasks__id__status", "tags": [ "Task" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\TaskController@updateStatus", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Update status for task. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status. Required. ", "enum": [ "' . implode('", "'", " $validStatuses)" ] } }, "required": [ "status" ] } } } }, "x-authentication": "interactive-session" } }, "/form/{task_id}": { "get": { "summary": "Get save form dynamic input", "operationId": "GET_form__task_id_", "tags": [ "Dynamic input" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\DynamicInputController@getSaveForm", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get save form for dynamic input. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/form/save/{task_id}": { "post": { "summary": "Save form dynamic input", "operationId": "POST_form_save__task_id_", "tags": [ "Dynamic input" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\DynamicInputController@saveForm", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Save form for dynamic input. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "array", "items": {}, "description": "Values. Optional. " }, "dynamicFields": { "type": "array", "items": {}, "description": "Dynamic fields. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/form/getdynamicchoices/{task_id}": { "post": { "summary": "Get dynamic choices dynamic input", "operationId": "POST_form_getdynamicchoices__task_id_", "tags": [ "Dynamic input" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\DynamicInputController@getDynamicChoices", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get dynamic choices for dynamic input. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/form/getdynamicfields/{task_id}": { "post": { "summary": "Get dynamic fields dynamic input", "operationId": "POST_form_getdynamicfields__task_id_", "tags": [ "Dynamic input" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\DynamicInputController@getDynamicFields", "x-auth-middleware": [ "api", "autoappy.product", "App\\Http\\Middleware\\AuthorizePlatformWorkflow" ], "description": "Get dynamic fields for dynamic input. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "Task id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/reviews": { "get": { "summary": "List review", "operationId": "GET_reviews", "tags": [ "Review" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\ReviewController@index", "x-auth-middleware": [ "api" ], "description": "Index for review. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/leads/{lead}/owners": { "get": { "summary": "List lead owner", "operationId": "GET_leads__lead__owners", "tags": [ "Lead owner" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadOwnerController@index", "x-auth-middleware": [ "api" ], "description": "Index for lead owner. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "lead", "in": "path", "required": true, "description": "Lead identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-stages": { "get": { "summary": "List lead stage", "operationId": "GET_lead_stages", "tags": [ "Lead stage" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadStageController@index", "x-auth-middleware": [ "api" ], "description": "Index for lead stage. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-stages/{id}": { "get": { "summary": "Get lead stage", "operationId": "GET_lead_stages__id_", "tags": [ "Lead stage" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadStageController@show", "x-auth-middleware": [ "api" ], "description": "Show for lead stage. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-workflow/{leadId}": { "get": { "summary": "Current lead workflow", "operationId": "GET_lead_workflow__leadId_", "tags": [ "Lead workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadWorkflowController@current", "x-auth-middleware": [ "api" ], "description": "Current for lead workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "leadId", "in": "path", "required": true, "description": "Lead id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-workflow/{leadId}/available-transitions": { "get": { "summary": "Available transitions lead workflow", "operationId": "GET_lead_workflow__leadId__available_transitions", "tags": [ "Lead workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadWorkflowController@availableTransitions", "x-auth-middleware": [ "api" ], "description": "Available transitions for lead workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "leadId", "in": "path", "required": true, "description": "Lead id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-workflow/{leadId}/history": { "get": { "summary": "History lead workflow", "operationId": "GET_lead_workflow__leadId__history", "tags": [ "Lead workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadWorkflowController@history", "x-auth-middleware": [ "api" ], "description": "History for lead workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "leadId", "in": "path", "required": true, "description": "Lead id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-workflow/workflow/stages": { "get": { "summary": "Workflow stages lead workflow", "operationId": "GET_lead_workflow_workflow_stages", "tags": [ "Lead workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadWorkflowController@workflowStages", "x-auth-middleware": [ "api" ], "description": "Workflow stages for lead workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-workflow/{leadId}/workflow/current": { "get": { "summary": "Workflow current lead workflow", "operationId": "GET_lead_workflow__leadId__workflow_current", "tags": [ "Lead workflow" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadWorkflowController@workflowCurrent", "x-auth-middleware": [ "api" ], "description": "Workflow current for lead workflow. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "leadId", "in": "path", "required": true, "description": "Lead id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/node-transitions": { "get": { "summary": "List node transition", "operationId": "GET_node_transitions", "tags": [ "Node transition" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\NodeTransitionController@index", "x-auth-middleware": [ "api" ], "description": "Index for node transition. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/node-transitions/{id}": { "get": { "summary": "Get node transition", "operationId": "GET_node_transitions__id_", "tags": [ "Node transition" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\NodeTransitionController@show", "x-auth-middleware": [ "api" ], "description": "Show for node transition. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/stage-nodes": { "get": { "summary": "List stage node", "operationId": "GET_stage_nodes", "tags": [ "Stage node" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\StageNodeController@index", "x-auth-middleware": [ "api" ], "description": "Index for stage node. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/stage-nodes/{id}": { "get": { "summary": "Get stage node", "operationId": "GET_stage_nodes__id_", "tags": [ "Stage node" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\StageNodeController@show", "x-auth-middleware": [ "api" ], "description": "Show for stage node. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/leads": { "get": { "summary": "List lead", "operationId": "GET_leads", "tags": [ "Lead" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadController@index", "x-auth-middleware": [ "api" ], "description": "Index for lead. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/leads/{lead}": { "get": { "summary": "Get lead", "operationId": "GET_leads__lead_", "tags": [ "Lead" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadController@show", "x-auth-middleware": [ "api" ], "description": "Show for lead. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "lead", "in": "path", "required": true, "description": "Lead identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/meetings": { "get": { "summary": "List meeting", "operationId": "GET_meetings", "tags": [ "Meeting" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\MeetingController@index", "x-auth-middleware": [ "api" ], "description": "Index for meeting. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/tags": { "get": { "summary": "List tag", "operationId": "GET_tags", "tags": [ "Tag" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\TagController@index", "x-auth-middleware": [ "api" ], "description": "Index for tag. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-activities": { "get": { "summary": "List lead activity", "operationId": "GET_lead_activities", "tags": [ "Lead activity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadActivityController@index", "x-auth-middleware": [ "api" ], "description": "Index for lead activity. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/lead-activities/{lead_activity}": { "get": { "summary": "Get lead activity", "operationId": "GET_lead_activities__lead_activity_", "tags": [ "Lead activity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadActivityController@show", "x-auth-middleware": [ "api" ], "description": "Show for lead activity. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "lead_activity", "in": "path", "required": true, "description": "Lead activity identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/leads/{lead}/timeline": { "get": { "summary": "Timeline lead activity", "operationId": "GET_leads__lead__timeline", "tags": [ "Lead activity" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\LeadActivityController@timeline", "x-auth-middleware": [ "api" ], "description": "Timeline for lead activity. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "lead", "in": "path", "required": true, "description": "Lead identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/api/v1/platform/catalog": { "get": { "summary": "Catalog platform", "operationId": "GET_api_v1_platform_catalog", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@catalog", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Catalog for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/invitations": { "get": { "summary": "Invitations platform", "operationId": "GET_api_v1_platform_invitations", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@invitations", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Invitations for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/invitations/{invitation}/respond": { "post": { "summary": "Respond invitation platform", "operationId": "POST_api_v1_platform_invitations__invitation__respond", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@respondInvitation", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Respond invitation for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "invitation", "in": "path", "required": true, "description": "Invitation identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accept": { "type": "string", "description": "Accept. Required. " } }, "required": [ "accept" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisation-preference": { "put": { "summary": "Select organisation platform", "operationId": "PUT_api_v1_platform_organisation_preference", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@selectOrganisation", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Select organisation for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace_id": { "type": "string", "nullable": true, "description": "Workspace id. Optional. " }, "set_default": { "type": "string", "description": "Set default. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations": { "get": { "summary": "Organisations platform", "operationId": "GET_api_v1_platform_organisations", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@organisations", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Organisations for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Create organisation platform", "operationId": "POST_api_v1_platform_organisations", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@createOrganisation", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Create organisation for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}": { "get": { "summary": "Organisation platform", "operationId": "GET_api_v1_platform_organisations__workspace_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@organisation", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Organisation for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Update organisation platform", "operationId": "PATCH_api_v1_platform_organisations__workspace_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@updateOrganisation", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Update organisation for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/members": { "get": { "summary": "Members platform", "operationId": "GET_api_v1_platform_organisations__workspace__members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@members", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Members for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save member platform", "operationId": "POST_api_v1_platform_organisations__workspace__members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@saveMember", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save member for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email. Optional. Limits: max:255." }, "user_id": { "type": "string", "description": "User id. Optional. " }, "role": { "type": "string", "description": "Role. Optional. ", "enum": [ "owner", "admin", "manager", "member" ] }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "inactive", "suspended", "pending" ] }, "reports_to_user_id": { "type": "string", "nullable": true, "description": "Reports to user id. Optional. " }, "permissions": { "type": "string", "description": "Permissions. Optional. " }, "module_access": { "type": "string", "description": "Module access. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/members/{user}": { "patch": { "summary": "Save member platform", "operationId": "PATCH_api_v1_platform_organisations__workspace__members__user_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@saveMember", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save member for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "User identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email. Optional. Limits: max:255." }, "user_id": { "type": "string", "description": "User id. Optional. " }, "role": { "type": "string", "description": "Role. Optional. ", "enum": [ "owner", "admin", "manager", "member" ] }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "inactive", "suspended", "pending" ] }, "reports_to_user_id": { "type": "string", "nullable": true, "description": "Reports to user id. Optional. " }, "permissions": { "type": "string", "description": "Permissions. Optional. " }, "module_access": { "type": "string", "description": "Module access. Optional. " } } } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Remove member platform", "operationId": "DELETE_api_v1_platform_organisations__workspace__members__user_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@removeMember", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Remove member for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "User identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts": { "get": { "summary": "Contacts platform", "operationId": "GET_api_v1_platform_organisations__workspace__contacts", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@contacts", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Contacts for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string", "description": "Per page." }, "description": "Per page." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts/resolve": { "post": { "summary": "Resolve contact platform", "operationId": "POST_api_v1_platform_organisations__workspace__contacts_resolve", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@resolveContact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Resolve contact for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Optional. Limits: max:255." }, "email": { "type": "string", "format": "email", "description": "Email. Optional. Limits: max:255." }, "phone": { "type": "string", "description": "Phone. Optional. Limits: max:50." }, "country_code": { "type": "string", "description": "Country code. Optional. Limits: max:5." }, "contact_id": { "type": "string", "description": "Contact id. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts/{contact}": { "get": { "summary": "Contact platform", "operationId": "GET_api_v1_platform_organisations__workspace__contacts__contact_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@contact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Contact for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Update contact platform", "operationId": "PATCH_api_v1_platform_organisations__workspace__contacts__contact_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@updateContact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Update contact for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "name": { "type": "string", "nullable": true, "description": "Name. Optional. Limits: max:255." }, "company_id": { "type": "string", "nullable": true, "description": "Company id. Optional. " }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "custom_fields": { "type": "array", "items": {}, "description": "Custom fields. Optional. Limits: max:100." } }, "required": [ "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/companies": { "get": { "summary": "Companies platform", "operationId": "GET_api_v1_platform_organisations__workspace__companies", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@companies", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Companies for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save company platform", "operationId": "POST_api_v1_platform_organisations__workspace__companies", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@saveCompany", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save company for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "website": { "type": "string", "description": "Website. Optional. " }, "industry": { "type": "string", "description": "Industry. Optional. Limits: max:255." }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "custom_fields": { "type": "array", "items": {}, "description": "Custom fields. Optional. Limits: max:100." } }, "required": [ "name", "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/companies/{company}": { "patch": { "summary": "Save company platform", "operationId": "PATCH_api_v1_platform_organisations__workspace__companies__company_", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@saveCompany", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save company for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "company", "in": "path", "required": true, "description": "Company identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "website": { "type": "string", "description": "Website. Optional. " }, "industry": { "type": "string", "description": "Industry. Optional. Limits: max:255." }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "custom_fields": { "type": "array", "items": {}, "description": "Custom fields. Optional. Limits: max:100." } }, "required": [ "name", "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/fields": { "get": { "summary": "Fields platform", "operationId": "GET_api_v1_platform_organisations__workspace__fields", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@fields", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Fields for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Define field platform", "operationId": "PUT_api_v1_platform_organisations__workspace__fields", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@defineField", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Define field for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "Resource type. Required. ", "enum": [ "contact", "company" ] }, "key": { "type": "string", "description": "Key. Required. " }, "label": { "type": "string", "description": "Label. Required. Limits: max:255." }, "type": { "type": "boolean", "format": "date-time", "description": "Type. Required. ", "enum": [ "text", "number", "boolean", "date", "select" ] }, "options": { "type": "array", "items": {}, "description": "Options. Optional. Limits: max:100." }, "active": { "type": "string", "description": "Active. Optional. " } }, "required": [ "resource_type", "key", "label", "type" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts/{contact}/assignment": { "put": { "summary": "Assign platform", "operationId": "PUT_api_v1_platform_organisations__workspace__contacts__contact__assignment", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@assign", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Assign for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "membership_id": { "type": "string", "nullable": true, "description": "Membership id. Optional. " }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:0." } }, "required": [ "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts/{contact}/shares": { "put": { "summary": "Share contact platform", "operationId": "PUT_api_v1_platform_organisations__workspace__contacts__contact__shares", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@shareContact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Share contact for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/workflows/{workflow}/shares": { "put": { "summary": "Share workflow platform", "operationId": "PUT_api_v1_platform_organisations__workspace__workflows__workflow__shares", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\PlatformController@shareWorkflow", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Share workflow for platform. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "workflow", "in": "path", "required": true, "description": "Workflow identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/bootstrap": { "get": { "summary": "Bootstrap contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management_bootstrap", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@bootstrap", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Bootstrap for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/contacts": { "get": { "summary": "List contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management_contacts", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@index", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Index for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "description": "Q. Optional. Limits: max:255." }, "description": "Q. Optional. Limits: max:255." }, { "name": "list_id", "in": "query", "required": false, "schema": { "type": "string", "description": "List id. Optional. " }, "description": "List id. Optional. " }, { "name": "segment_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Segment id. Optional. " }, "description": "Segment id. Optional. " }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived", "all" ] }, "description": "Status. Optional. " }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "description": "Role. Optional. Limits: max:64." }, "description": "Role. Optional. Limits: max:64." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Tag. Optional. Limits: max:64." }, "description": "Tag. Optional. Limits: max:64." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1." }, "description": "Page. Optional. Limits: min:1." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per page. Optional. Limits: min:1, max:100." }, "description": "Per page. Optional. Limits: min:1, max:100." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management_contacts", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "duplicate_policy": { "type": "string", "format": "email", "description": "Duplicate policy. Optional. " } } } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/contacts/{contact}": { "get": { "summary": "Get contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management_contacts__contact_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@show", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Show for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save contact management", "operationId": "PATCH_api_v1_platform_organisations__workspace__contact_management_contacts__contact_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "duplicate_policy": { "type": "string", "format": "email", "description": "Duplicate policy. Optional. " } } } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/contacts/{contact}/activities": { "get": { "summary": "Activities contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management_contacts__contact__activities", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@activities", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Activities for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Type. Optional. Limits: max:64." }, "description": "Type. Optional. Limits: max:64." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "completed", "cancelled" ] }, "description": "Status. Optional. " }, { "name": "after_id", "in": "query", "required": false, "schema": { "type": "string", "description": "After id. Optional. " }, "description": "After id. Optional. " }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Limit. Optional. Limits: min:1, max:500." }, "description": "Limit. Optional. Limits: min:1, max:500." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Create activity contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management_contacts__contact__activities", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@createActivity", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Create activity for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Type. Required. " }, "title": { "type": "string", "description": "Title. Required. Limits: max:255." }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "completed", "cancelled" ] }, "dates": { "type": "array", "items": {}, "description": "Dates. Optional. Limits: max:50." }, "timezone": { "type": "string", "description": "Timezone. Optional. " }, "custom_fields": { "type": "string", "description": "Custom fields. Optional. " }, "parameters": { "type": "string", "description": "Parameters. Optional. " }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "type", "title", "expected_version" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/activities/{activity}": { "patch": { "summary": "Update activity contact management", "operationId": "PATCH_api_v1_platform_organisations__workspace__contact_management_activities__activity_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@updateActivity", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Update activity for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "activity", "in": "path", "required": true, "description": "Activity identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Type. Required. " }, "title": { "type": "string", "description": "Title. Required. Limits: max:255." }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "completed", "cancelled" ] }, "dates": { "type": "array", "items": {}, "description": "Dates. Optional. Limits: max:50." }, "timezone": { "type": "string", "description": "Timezone. Optional. " }, "custom_fields": { "type": "string", "description": "Custom fields. Optional. " }, "parameters": { "type": "string", "description": "Parameters. Optional. " }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "type", "title", "expected_version" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/lists/{list}/members": { "put": { "summary": "Members contact management", "operationId": "PUT_api_v1_platform_organisations__workspace__contact_management_lists__list__members", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@members", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Members for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_ids": { "type": "array", "items": {}, "description": "Contact ids. Required. Limits: min:1, max:500." }, "operation": { "type": "string", "description": "Operation. Required. ", "enum": [ "add", "remove" ] }, "parameters": { "type": "string", "description": "Parameters. Optional. " } }, "required": [ "contact_ids", "operation" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/lists/{list}/members/{contact}": { "patch": { "summary": "Save membership contact management", "operationId": "PATCH_api_v1_platform_organisations__workspace__contact_management_lists__list__members__contact_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@saveMembership", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save membership for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "values": { "type": "array", "items": {}, "description": "Values. Optional. " }, "parameters": { "type": "array", "items": {}, "description": "Parameters. Optional. " } }, "required": [ "expected_version" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/lists/{list}/schema": { "get": { "summary": "Schema contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management_lists__list__schema", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@schema", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Schema for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/lists/{list}/columns": { "post": { "summary": "Save column contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management_lists__list__columns", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@saveColumn", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save column for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/lists/{list}/columns/{column}": { "patch": { "summary": "Save column contact management", "operationId": "PATCH_api_v1_platform_organisations__workspace__contact_management_lists__list__columns__column_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@saveColumn", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save column for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "column", "in": "path", "required": true, "description": "Column identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "delete": { "summary": "Archive column contact management", "operationId": "DELETE_api_v1_platform_organisations__workspace__contact_management_lists__list__columns__column_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@archiveColumn", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Archive column for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "list", "in": "path", "required": true, "description": "List identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "column", "in": "path", "required": true, "description": "Column identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/fields": { "put": { "summary": "Field contact management", "operationId": "PUT_api_v1_platform_organisations__workspace__contact_management_fields", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@field", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Field for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "Resource type. Required. ", "enum": [ "contact", "activity" ] }, "key": { "type": "string", "description": "Key. Required. " }, "label": { "type": "string", "description": "Label. Required. Limits: max:255." }, "type": { "type": "boolean", "format": "date-time", "description": "Type. Required. ", "enum": [ "text", "number", "boolean", "date", "select" ] }, "options": { "type": "array", "items": {}, "description": "Options. Optional. Limits: max:100." }, "active": { "type": "string", "description": "Active. Optional. " } }, "required": [ "resource_type", "key", "label", "type" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/import/preview": { "post": { "summary": "Preview import contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management_import_preview", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@previewImport", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Preview import for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": {}, "description": "Rows. Required. Limits: min:1, max:500." }, "list_id": { "type": "string", "description": "List id. Optional. " }, "proposed_columns": { "type": "array", "items": {}, "description": "Proposed columns. Optional. Limits: max:100." } }, "required": [ "rows" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contact-management/import": { "post": { "summary": "Import contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management_import", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@import", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Import for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": {}, "description": "Rows. Required. Limits: min:1, max:500." }, "list_id": { "type": "string", "description": "List id. Optional. " }, "duplicate_policy": { "type": "string", "description": "Duplicate policy. Required. ", "enum": [ "skip", "separate", "reuse" ] }, "confirmed": { "type": "string", "description": "Confirmed. Required. " }, "proposed_columns": { "type": "array", "items": {}, "description": "Proposed columns. Optional. Limits: max:100." }, "schema_version": { "type": "string", "description": "Schema version. Optional. Limits: size:64." } }, "required": [ "rows", "duplicate_policy", "confirmed" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/{kind}": { "get": { "summary": "Resources contact management", "operationId": "GET_api_v1_platform_organisations__workspace__contact_management__kind_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@resources", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Resources for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save resource contact management", "operationId": "POST_api_v1_platform_organisations__workspace__contact_management__kind_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@saveResource", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save resource for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:5000." }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "workspace", "private" ] }, "parent_id": { "type": "string", "description": "Parent id. Optional. " }, "folder_id": { "type": "string", "description": "Folder id. Optional. " }, "conditions": { "type": "string", "description": "Conditions. Required. " }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "name", "conditions", "expected_version" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/contact-management/{kind}/{resource}": { "patch": { "summary": "Save resource contact management", "operationId": "PATCH_api_v1_platform_organisations__workspace__contact_management__kind___resource_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@saveResource", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save resource for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "resource", "in": "path", "required": true, "description": "Resource identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:255." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:5000." }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "workspace", "private" ] }, "parent_id": { "type": "string", "description": "Parent id. Optional. " }, "folder_id": { "type": "string", "description": "Folder id. Optional. " }, "conditions": { "type": "string", "description": "Conditions. Required. " }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "name", "conditions", "expected_version" ] } } } } }, "delete": { "summary": "Delete resource contact management", "operationId": "DELETE_api_v1_platform_organisations__workspace__contact_management__kind___resource_", "tags": [ "Contact management" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\ContactManagementController@deleteResource", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Delete resource for contact management. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "resource", "in": "path", "required": true, "description": "Resource identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/bootstrap": { "get": { "summary": "Discover app tables", "description": "\n\nLookup `table_id`: read `data.tables[].id` as the value and `data.tables[].name` as the label. Use identifiers only within their authorised workspace.", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_bootstrap", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "database_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "databases": { "type": "array", "items": { "type": "object", "properties": {} } }, "tables": { "type": "array", "items": { "type": "object", "properties": {} } }, "truncated": { "type": "boolean" } } } } }, "examples": { "table_id": { "summary": "Lookup fields for table_id", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": { "tables": [ { "id": "example-table_id", "name": "Example table id" } ] } } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "tags": [ "Databases" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@bootstrap", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps": { "get": { "summary": "List data app", "operationId": "GET_api_v1_platform_organisations__workspace__data_apps", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@index", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Index for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save data app", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}": { "get": { "summary": "Get data app", "operationId": "GET_api_v1_platform_organisations__workspace__data_apps__app_", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@show", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Show for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save data app", "operationId": "PATCH_api_v1_platform_organisations__workspace__data_apps__app_", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "delete": { "summary": "Delete data app", "operationId": "DELETE_api_v1_platform_organisations__workspace__data_apps__app_", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@destroy", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Destroy for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "confirmation": { "type": "string", "description": "Confirmation. Required. Limits: max:180." } }, "required": [ "expected_version", "confirmation" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/deletion-plan": { "get": { "summary": "Deletion plan data app", "operationId": "GET_api_v1_platform_organisations__workspace__data_apps__app__deletion_plan", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@deletionPlan", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Deletion plan for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/source": { "get": { "summary": "App source data developer", "operationId": "GET_api_v1_platform_organisations__workspace__data_apps__app__source", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appSource", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App source for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save app source data developer", "operationId": "PATCH_api_v1_platform_organisations__workspace__data_apps__app__source", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@saveAppSource", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save app source for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:0." }, "source_hash": { "type": "string", "description": "Source hash. Required. " }, "request_id": { "type": "string", "description": "Request id. Required. " }, "project": { "type": "string", "description": "Project. Required. " }, "settings": { "type": "string", "description": "Settings. Optional. " } }, "required": [ "expected_version", "source_hash", "request_id", "project" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/devkit": { "get": { "summary": "App devkit data developer", "operationId": "GET_api_v1_platform_organisations__workspace__data_apps__app__devkit", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appDevkit", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App devkit for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/schema/plan": { "post": { "summary": "App schema plan data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__schema_plan", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appSchemaPlan", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App schema plan for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/schema/{token}/apply": { "post": { "summary": "App schema apply data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__schema__token__apply", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appSchemaApply", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App schema apply for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "review_hash": { "type": "string", "description": "Review hash. Required. Limits: size:64." } }, "required": [ "review_hash" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/seed/plan": { "post": { "summary": "App seed plan data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__seed_plan", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appSeedPlan", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App seed plan for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/seed/{token}/apply": { "post": { "summary": "App seed apply data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__seed__token__apply", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appSeedApply", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App seed apply for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "review_hash": { "type": "string", "description": "Review hash. Required. Limits: size:64." } }, "required": [ "review_hash" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/models/{key}/run": { "post": { "summary": "App model run data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__models__key__run", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appModelRun", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App model run for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "description": "Key identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "description": "Operation. Required. " }, "inputs": { "type": "string", "description": "Inputs. Optional. " }, "preview": { "type": "string", "description": "Preview. Optional. " }, "id": { "type": "string", "description": "Id. Required. " } }, "required": [ "operation", "id" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/apps/{app}/apis/{artifact}/run": { "post": { "summary": "App api run data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_apps__app__apis__artifact__run", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@appApiRun", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "App api run for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "app", "in": "path", "required": true, "description": "App identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/devkit": { "get": { "summary": "Devkit data developer", "operationId": "GET_api_v1_platform_organisations__workspace__data_devkit", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@devkit", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Devkit for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Database id. Optional. " }, "description": "Database id. Optional. " }, { "name": "app_id", "in": "query", "required": false, "schema": { "type": "string", "description": "App id. Optional. " }, "description": "App id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/schema/plan": { "post": { "summary": "Schema plan data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_schema_plan", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@schemaPlan", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Schema plan for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/schema/{token}/apply": { "post": { "summary": "Schema apply data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_schema__token__apply", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@schemaApply", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Schema apply for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "review_hash": { "type": "string", "description": "Review hash. Required. Limits: size:64." } }, "required": [ "review_hash" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/models/{table}/run": { "post": { "summary": "Model run data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_models__table__run", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@modelRun", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Model run for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "description": "Table identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "description": "Operation. Required. " }, "inputs": { "type": "string", "description": "Inputs. Optional. " }, "preview": { "type": "string", "description": "Preview. Optional. " }, "id": { "type": "string", "description": "Id. Required. " } }, "required": [ "operation", "id" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/views/{view}/models/{table}/run": { "post": { "summary": "View model run data developer", "operationId": "POST_api_v1_platform_organisations__workspace__data_views__view__models__table__run", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@viewModelRun", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "View model run for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "view", "in": "path", "required": true, "description": "View identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "description": "Table identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "description": "Operation. Required. " }, "inputs": { "type": "string", "description": "Inputs. Optional. " }, "preview": { "type": "string", "description": "Preview. Optional. " }, "id": { "type": "string", "description": "Id. Required. " } }, "required": [ "operation", "id" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/databases": { "get": { "summary": "List databases", "description": "\n\nLookup `database_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace.", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_databases", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" } ], "responses": { "200": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "examples": { "database_id": { "summary": "Lookup fields for database_id", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": [ { "id": "example-database_id", "name": "Example database id" } ] } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "tags": [ "Databases" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@databases", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" }, "post": { "summary": "Save database data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_databases", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveDatabase", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save database for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "slug": { "type": "string", "description": "Slug. Optional. Limits: max:150." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:2000." }, "appearance_icon": { "type": "string", "nullable": true, "description": "Appearance icon. Optional. ", "enum": [ "window", "chart", "people", "document", "fitness", "education", "commerce", "calendar" ] }, "appearance_color": { "type": "string", "nullable": true, "description": "Appearance color. Optional. ", "enum": [ "blue", "violet", "green", "orange", "rose", "slate" ] }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "private", "workspace" ] }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "main_view_id": { "type": "string", "nullable": true, "description": "Main view id. Optional. " } }, "required": [ "name" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/databases/{database}": { "get": { "summary": "Database data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_databases__database_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@database", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Database for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database", "in": "path", "required": true, "description": "Database identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save database data workspace", "operationId": "PATCH_api_v1_platform_organisations__workspace__data_databases__database_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveDatabase", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save database for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database", "in": "path", "required": true, "description": "Database identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "slug": { "type": "string", "description": "Slug. Optional. Limits: max:150." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:2000." }, "appearance_icon": { "type": "string", "nullable": true, "description": "Appearance icon. Optional. ", "enum": [ "window", "chart", "people", "document", "fitness", "education", "commerce", "calendar" ] }, "appearance_color": { "type": "string", "nullable": true, "description": "Appearance color. Optional. ", "enum": [ "blue", "violet", "green", "orange", "rose", "slate" ] }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "private", "workspace" ] }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "main_view_id": { "type": "string", "nullable": true, "description": "Main view id. Optional. " } }, "required": [ "name" ] } } } } }, "delete": { "summary": "Delete database data workspace", "operationId": "DELETE_api_v1_platform_organisations__workspace__data_databases__database_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@deleteDatabase", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Delete database for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database", "in": "path", "required": true, "description": "Database identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "confirmation": { "type": "string", "description": "Confirmation. Required. Limits: max:180." } }, "required": [ "expected_version", "confirmation" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/databases/{database}/deletion-plan": { "get": { "summary": "Database deletion plan data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_databases__database__deletion_plan", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@databaseDeletionPlan", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Database deletion plan for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database", "in": "path", "required": true, "description": "Database identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apis/{artifact}/sample": { "get": { "summary": "Sample data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_apis__artifact__sample", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sample", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Sample for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } }, { "name": "inputs", "in": "query", "required": false, "schema": { "type": "string", "description": "Inputs. Optional. " }, "description": "Inputs. Optional. " }, { "name": "response", "in": "query", "required": false, "schema": { "type": "string", "description": "Response. Optional. " }, "description": "Response. Optional. " } ], "x-authentication": "application-api-key" }, "post": { "summary": "Sample data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_apis__artifact__sample", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sample", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Sample for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " }, "response": { "type": "string", "description": "Response. Optional. " } } } } } } } }, "/api/v1/platform/organisations/{workspace}/data/apis/{artifact}/contract": { "get": { "summary": "Contract data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_apis__artifact__contract", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@contract", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Contract for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/imports/google-sheets/discover": { "post": { "summary": "Sheet discover data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_google_sheets_discover", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sheetDiscover", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1", "throttle:20,1,data-sheet-discover" ], "description": "Sheet discover for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Url. Required. Limits: max:2048." } }, "required": [ "url" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/imports/google-sheets/preview": { "post": { "summary": "Sheet preview data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_google_sheets_preview", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sheetPreview", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1", "throttle:30,1,data-sheet-preview" ], "description": "Sheet preview for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Url. Required. Limits: max:2048." }, "gid": { "type": "string", "description": "Gid. Required. " }, "sheet_name": { "type": "string", "description": "Sheet name. Required. Limits: max:120." }, "header_row": { "type": "integer", "description": "Header row. Required. Limits: min:1, max:50." } }, "required": [ "url", "gid", "sheet_name", "header_row" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/imports/google-sheets/{token}/review": { "post": { "summary": "Sheet review data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_google_sheets__token__review", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sheetReview", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Sheet review for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "group_name": { "type": "string", "description": "Group name. Required. Limits: max:120." }, "database_id": { "type": "string", "nullable": true, "description": "Database id. Optional. " }, "visibility": { "type": "string", "description": "Visibility. Required. ", "enum": [ "private", "workspace" ] }, "name_column": { "type": "integer", "description": "Name column. Optional. Limits: min:0, max:99." }, "columns": { "type": "array", "items": {}, "description": "Columns. Required. Limits: min:1, max:100." } }, "required": [ "name", "group_name", "visibility", "columns" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/imports/google-sheets/{token}/commit": { "post": { "summary": "Sheet commit data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_google_sheets__token__commit", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@sheetCommit", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Sheet commit for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "review_hash": { "type": "string", "description": "Review hash. Required. Limits: size:64." } }, "required": [ "review_hash" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/tables": { "post": { "summary": "Create table", "description": "Requires table management and database write access. Supply an existing database_id to avoid default database selection.", "operationId": "customapp_post_api_v1_platform_organisations_workspace_data_tables", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Invalid credential" }, "403": { "description": "Insufficient access" }, "404": { "description": "Resource unavailable" }, "409": { "description": "Version conflict" }, "422": { "description": "Validation failed" }, "201": { "description": "Successful response. Inspect data and business state." }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 2000, "nullable": true }, "database_id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "standard", "contact" ] }, "visibility": { "type": "string", "enum": [ "private", "workspace" ] }, "fields": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "label": { "type": "string", "maxLength": 120 }, "type": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "select", "email", "url", "json", "contact", "relation" ] }, "required": { "type": "boolean" }, "active": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "string" } }, "target_table_id": { "type": "string", "format": "uuid", "nullable": true }, "multiple": { "type": "boolean" }, "date_format": { "type": "string" }, "section": { "type": "string" } }, "required": [ "key", "label", "type" ] } }, "layout": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "sheet", "page" ] }, "columns": { "type": "array", "items": { "type": "string" } } } } }, "required": [ "name" ] }, "example": { "database_id": "33333333-3333-4333-8333-333333333333", "name": "Orders", "type": "standard", "fields": [ { "key": "amount", "label": "Amount", "type": "number" } ], "layout": { "mode": "sheet" } } } } }, "tags": [ "Tables" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveTable", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/tables/{table}": { "get": { "summary": "Read table schema", "description": "\n\nLookup `lookup_field`: read `data.fields[].key` as the value and `data.fields[].label` as the label. Use identifiers only within their authorised workspace.\n\nLookup `lookup_field_2`: read `data.fields[].key` as the value and `data.fields[].label` as the label. Use identifiers only within their authorised workspace.\n\nLookup `field`: read `data.fields[].key` as the value and `data.fields[].label` as the label. Use identifiers only within their authorised workspace.", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_tables_table", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." } ], "responses": { "200": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": {} } } }, "examples": { "lookup_field": { "summary": "Lookup fields for lookup_field", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": { "fields": [ { "key": "example-lookup_field", "label": "Example lookup field" } ] } } }, "lookup_field_2": { "summary": "Lookup fields for lookup_field_2", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": { "fields": [ { "key": "example-lookup_field_2", "label": "Example lookup field 2" } ] } } }, "field": { "summary": "Lookup fields for field", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": { "fields": [ { "key": "example-field", "label": "Example field" } ] } } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "tags": [ "Tables" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@table", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save table data workspace", "operationId": "PATCH_api_v1_platform_organisations__workspace__data_tables__table_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveTable", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save table for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "description": "Table identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:2000." }, "slug": { "type": "string", "description": "Slug. Optional. Limits: max:150." }, "database_id": { "type": "string", "description": "Database id. Optional. " }, "type": { "type": "string", "description": "Type. Optional. ", "enum": [ "standard", "contact" ] }, "group_name": { "type": "string", "nullable": true, "description": "Group name. Optional. Limits: max:120." }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "private", "workspace" ] }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "active", "archived" ] }, "fields": { "type": "array", "items": {}, "description": "Fields. Optional. Limits: max:100." }, "layout": { "type": "string", "description": "Layout. Optional. " } }, "required": [ "name" ] } } } } }, "delete": { "summary": "Delete table data workspace", "operationId": "DELETE_api_v1_platform_organisations__workspace__data_tables__table_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@deleteTable", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Delete table for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "description": "Table identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "confirmed": { "type": "string", "description": "Confirmed. Required. " } }, "required": [ "expected_version", "confirmed" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/tables/{table}/records": { "get": { "summary": "Find records", "description": "Find accessible rows by title, external key and up to ten typed column filters, combined with AND. q searches only the title. Use filters for email or other columns. No matches returns data: [] and total: 0. See the lookup cookbook for a complete curl example.\n\nLookup `record_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace.", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_tables_table_records", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255, "description": "Substring of row name; the API does not use search." } }, { "name": "external_key", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 190, "description": "Exact match." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "archived", "all" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "filters", "in": "query", "required": false, "description": "JSON array of typed AND conditions. PHP-style nested query keys are also supported; see the cookbook.", "content": { "application/json": { "schema": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Active schema key, or name for the record title.", "example": "email" }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "contains", "empty" ], "description": "Typed comparison. Filters combine with AND." }, "value": { "description": "Typed comparison value; omit for empty.", "example": "raj@example.com" } }, "required": [ "field", "operator" ] } }, "example": [ { "field": "email", "operator": "eq", "value": "raj@example.com" } ] } } } ], "responses": { "200": { "description": "Paginated matching rows; an empty data array is a valid no-match result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "Rows on the current page.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Record identifier." }, "name": { "type": "string", "description": "Record title." }, "version": { "type": "integer", "description": "Current optimistic concurrency version." }, "values": { "type": "object", "description": "Typed values keyed by stable schema key.", "additionalProperties": true } } } }, "total": { "type": "integer", "description": "Total matching accessible rows." }, "current_page": { "type": "integer", "description": "Current page, starting at one." }, "last_page": { "type": "integer", "description": "Final page number." }, "per_page": { "type": "integer", "description": "Page size." } } }, "examples": { "complete": { "summary": "Response example", "value": { "data": [ { "id": "row-example", "name": "Raj", "version": 1, "values": { "email": "raj@example.com" } } ], "total": 1, "current_page": 1, "last_page": 1, "per_page": 30 } }, "record_id": { "summary": "Lookup fields for record_id", "description": "Synthetic example showing the relevant identifier and label fields. Other response fields are omitted.", "value": { "data": [ { "id": "example-record_id", "name": "Example record id" } ] } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "tags": [ "Rows" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@records", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" }, "post": { "summary": "Create record", "description": "", "operationId": "customapp_post_api_v1_platform_organisations_workspace_data_tables_table_records", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." } ], "responses": { "201": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": {} } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "values": { "type": "object", "properties": {} }, "external_key": { "type": "string", "maxLength": 190, "nullable": true }, "schema_version": { "type": "integer", "minimum": 1 }, "contact_id": { "type": "string", "format": "uuid" }, "contact": { "type": "object", "properties": {} }, "expected_contact_version": { "type": "integer", "minimum": 1 }, "input_date_format": { "type": "string", "enum": [ "iso", "dmy", "mdy", "long" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] } }, "required": [ "name" ] }, "example": { "name": "Example order", "values": { "amount": 0, "paid": false }, "external_key": "example-order-123" } } } }, "tags": [ "Rows" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveRecord", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/tables/{table}/records/{record}": { "get": { "summary": "Get record", "description": "", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_tables_table_records_record", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." } ], "responses": { "200": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": {} } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "tags": [ "Rows" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@record", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" }, "patch": { "summary": "Update record", "description": "", "operationId": "customapp_patch_api_v1_platform_organisations_workspace_data_tables_table_records_record", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Central organisation UUID" }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Local resource identifier; see README." } ], "responses": { "200": { "description": "Successful response; inspect resource/business state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": {} } } } } } }, "401": { "description": "Invalid, expired or missing application API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "403": { "description": "Application, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "404": { "description": "Resource not found or inaccessible.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "409": { "description": "Version conflict; read current state before updating.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "422": { "description": "Request validation failed; inspect message and errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "429": { "description": "Rate limit reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "500": { "description": "Server failure; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } }, "503": { "description": "Service unavailable; check write outcome before retrying.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": {} } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "values": { "type": "object", "properties": {} }, "external_key": { "type": "string", "maxLength": 190, "nullable": true }, "schema_version": { "type": "integer", "minimum": 1 }, "contact_id": { "type": "string", "format": "uuid" }, "contact": { "type": "object", "properties": {} }, "expected_contact_version": { "type": "integer", "minimum": 1 }, "input_date_format": { "type": "string", "enum": [ "iso", "dmy", "mdy", "long" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "expected_version": { "type": "integer", "minimum": 1 } }, "required": [ "expected_version" ] }, "example": { "expected_version": 1, "values": { "paid": true } } } } }, "tags": [ "Rows" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveRecord", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" }, "delete": { "summary": "Delete row", "description": "Permanent deletion, including dependent row links/history. Does not delete a canonical contact. Stale version is rejected; inspect state before retrying.", "operationId": "customapp_delete_api_v1_platform_organisations_workspace_data_tables_table_records_record", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. Inspect data and business state." }, "401": { "description": "Invalid credential" }, "403": { "description": "Insufficient access" }, "404": { "description": "Resource unavailable" }, "409": { "description": "Version conflict" }, "422": { "description": "Validation failed" }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 1 } }, "required": [ "expected_version" ] }, "example": { "expected_version": 1 } } } }, "tags": [ "Rows" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@deleteRecord", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/tables/{table}/aggregate": { "get": { "summary": "Aggregate rows", "description": "", "operationId": "customapp_get_api_v1_platform_organisations_workspace_data_tables_table_aggregate", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Central organisation UUID; never a local CRM/WhatsApp ID." }, { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255, "description": "Substring of row name; the API does not use search." } }, { "name": "external_key", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 190, "description": "Exact match." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "archived", "all" ] } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "contains", "empty" ] }, "value": {} }, "required": [ "field", "operator" ] } } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "operation", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "count", "sum", "avg", "min", "max" ] } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "description": "Active numeric field key, required except for count." } } ], "responses": { "200": { "description": "Successful response. Inspect data and business state." }, "401": { "description": "Invalid credential" }, "403": { "description": "Insufficient access" }, "404": { "description": "Resource unavailable" }, "409": { "description": "Version conflict" }, "422": { "description": "Validation failed" }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "tags": [ "Calculations" ], "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@aggregate", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/tables/{table}/import": { "post": { "summary": "Import data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_tables__table__import", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@import", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Import for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table", "in": "path", "required": true, "description": "Table identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": {}, "description": "Rows. Required. Limits: min:1, max:100." }, "confirmed": { "type": "string", "description": "Confirmed. Optional. " }, "schema_version": { "type": "integer", "description": "Schema version. Required. Limits: min:1." }, "input_date_format": { "type": "string", "description": "Input date format. Optional. " } }, "required": [ "rows", "schema_version" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/related/{type}/{record}": { "get": { "summary": "Related data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_related__type___record_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@related", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Related for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "description": "Type identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "description": "Record identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1, max:100000." }, "description": "Page. Optional. Limits: min:1, max:100000." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apis/{artifact}/run": { "get": { "summary": "Run data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@run", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "inputs", "in": "query", "required": false, "schema": { "type": "string", "description": "Inputs. Optional. " }, "description": "Inputs. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } }, { "name": "number", "in": "query", "required": false, "schema": { "type": "number", "description": "Number. Optional. " }, "description": "Number. Optional. " }, { "name": "array", "in": "query", "required": false, "schema": { "type": "array", "items": {}, "description": "Array. Optional. " }, "description": "Array. Optional. " }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "description": "Q. Optional. Limits: max:255." }, "description": "Q. Optional. Limits: max:255." }, { "name": "list_id", "in": "query", "required": false, "schema": { "type": "string", "description": "List id. Optional. " }, "description": "List id. Optional. " }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "description": "Role. Optional. Limits: max:64." }, "description": "Role. Optional. Limits: max:64." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Tag. Optional. Limits: max:64." }, "description": "Tag. Optional. Limits: max:64." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "description": "Page. Optional. Limits: min:1." }, "description": "Page. Optional. Limits: min:1." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string", "description": "Per page. Optional. Limits: min:1, max:100." }, "description": "Per page. Optional. Limits: min:1, max:100." } ], "x-authentication": "application-api-key" }, "post": { "summary": "Run data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@run", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " } } } } } }, "x-authentication": "application-api-key" }, "put": { "summary": "Run data workspace", "operationId": "PUT_api_v1_platform_organisations__workspace__data_apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@run", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " } } } } } }, "x-authentication": "application-api-key" }, "patch": { "summary": "Run data workspace", "operationId": "PATCH_api_v1_platform_organisations__workspace__data_apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@run", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " } } } } } }, "x-authentication": "application-api-key" }, "delete": { "summary": "Run data workspace", "operationId": "DELETE_api_v1_platform_organisations__workspace__data_apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@run", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/apis/{artifact}/preview": { "post": { "summary": "Preview data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_apis__artifact__preview", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@preview", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Preview for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " }, "method": { "type": "string", "description": "Method. Required. ", "enum": [ "'.implode('", "'", " DataPrograms::METHODS)" ] } }, "required": [ "method" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/views/{view}/apis/{artifact}/run": { "post": { "summary": "View run data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data_views__view__apis__artifact__run", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@viewRun", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "View run for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "view", "in": "path", "required": true, "description": "View identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputs": { "type": "string", "description": "Inputs. Optional. " }, "preview": { "type": "string", "description": "Preview. Optional. " } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/history/{kind}/{artifact}": { "get": { "summary": "History data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data_history__kind___artifact_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@history", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "History for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "table_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Table id. Optional. " }, "description": "Table id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/{kind}": { "get": { "summary": "Artifacts data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data__kind_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@artifacts", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Artifacts for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "database_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Database id. Optional. " }, "description": "Database id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save artifact data workspace", "operationId": "POST_api_v1_platform_organisations__workspace__data__kind_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveArtifact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save artifact for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:2000." }, "slug": { "type": "string", "description": "Slug. Optional. Limits: max:150." }, "source": { "type": "string", "description": "Source. Required. " }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "draft", "published", "archived" ] }, "database_id": { "type": "string", "nullable": true, "description": "Database id. Optional. " }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "private", "workspace" ] }, "settings": { "type": "string", "description": "Settings. Optional. " } }, "required": [ "name", "source" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/data/{kind}/{artifact}": { "get": { "summary": "Artifact data workspace", "operationId": "GET_api_v1_platform_organisations__workspace__data__kind___artifact_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@artifact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Artifact for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "patch": { "summary": "Save artifact data workspace", "operationId": "PATCH_api_v1_platform_organisations__workspace__data__kind___artifact_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@saveArtifact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Save artifact for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name. Required. Limits: max:120." }, "description": { "type": "string", "description": "Description. Optional. Limits: max:2000." }, "slug": { "type": "string", "description": "Slug. Optional. Limits: max:150." }, "source": { "type": "string", "description": "Source. Required. " }, "status": { "type": "string", "description": "Status. Optional. ", "enum": [ "draft", "published", "archived" ] }, "database_id": { "type": "string", "nullable": true, "description": "Database id. Optional. " }, "visibility": { "type": "string", "description": "Visibility. Optional. ", "enum": [ "private", "workspace" ] }, "settings": { "type": "string", "description": "Settings. Optional. " } }, "required": [ "name", "source" ] } } } } }, "delete": { "summary": "Delete artifact data workspace", "operationId": "DELETE_api_v1_platform_organisations__workspace__data__kind___artifact_", "tags": [ "Data workspace" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataWorkspaceController@deleteArtifact", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Delete artifact for data workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Kind identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "artifact", "in": "path", "required": true, "description": "Artifact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." } }, "required": [ "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/resolve/{username}": { "get": { "summary": "Resolve data developer", "operationId": "GET_api_v1_platform_resolve__username_", "tags": [ "Data developer" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataDeveloperController@resolve", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Resolve for data developer. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "username", "in": "path", "required": true, "description": "Username identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "required": true, "schema": { "type": "string", "description": "Kind. Required. ", "enum": [ "app", "sheet", "database" ] }, "description": "Kind. Required. " }, { "name": "slug", "in": "query", "required": true, "schema": { "type": "string", "description": "Slug. Required. Limits: max:150." }, "description": "Slug. Required. Limits: max:150." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/apps/{username}/{slug}": { "get": { "summary": "Resolve data app", "operationId": "GET_api_v1_platform_apps__username___slug_", "tags": [ "Data app" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DataAppController@resolve", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:120,1" ], "description": "Resolve for data app. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "username", "in": "path", "required": true, "description": "Username identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Slug identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/imports/json/preview": { "post": { "summary": "Preview database bundle", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_json_preview", "tags": [ "Database bundle" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DatabaseBundleController@preview", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:30,1,data-json-import" ], "description": "Preview for database bundle. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/data/imports/json/{token}/commit": { "post": { "summary": "Commit database bundle", "operationId": "POST_api_v1_platform_organisations__workspace__data_imports_json__token__commit", "tags": [ "Database bundle" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\DatabaseBundleController@commit", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:30,1,data-json-import" ], "description": "Commit for database bundle. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "description": "Token identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "review_hash": { "type": "string", "description": "Review hash. Required. Limits: size:64." } }, "required": [ "review_hash" ] } } } } } }, "/api/v1/platform/organisations/{workspace}/follow-ups": { "get": { "summary": "List follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@index", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Index for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1." }, "description": "Page. Optional. Limits: min:1." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Status. Optional. ", "enum": [ "draft", "active", "paused", "archived" ] }, "description": "Status. Optional. " }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "description": "Q. Optional. Limits: max:160." }, "description": "Q. Optional. Limits: max:160." }, { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Source id. Optional. " }, "description": "Source id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "post": { "summary": "Save follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request. CRM activity plans require scope=activity, recipient_mode=source and both stopping flags enabled. Existing main-app, contacts.edit, workflow permission and task balance requirements remain. CRM-only packaged reminders are not supported yet. Current source reads occur before dispatch; external edits after that read are not atomically fenced.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "Version. Optional. " }, "source_type": { "type": "string", "enum": [ "all", "list", "segment", "data_table", "crm_activity" ], "description": "crm_activity selects one source-owned CRM activity; no central contact copy." }, "source_id": { "type": "string", "format": "uuid", "nullable": true, "description": "List/segment/table ID, or the owner’s saved CRM connection row ID for crm_activity." }, "source_record_id": { "type": "string", "nullable": true, "pattern": "^[1-9][0-9]{0,18}$", "description": "Required for crm_activity: original numeric CRM activity ID as a string." }, "recipient_mode": { "type": "string", "enum": [ "contact", "record", "source" ], "description": "Use source for CRM activities; contact is null in the workflow input." } } } } } } } }, "/api/v1/platform/organisations/{workspace}/follow-ups/meta": { "get": { "summary": "Meta follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups_meta", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@meta", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Meta for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/source-fields": { "get": { "summary": "Source fields follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups_source_fields", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@sourceFields", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:60,1" ], "description": "Source fields for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "source_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Source type. Required. ", "enum": [ "all", "list", "segment", "data_table", "crm_activity" ] }, "description": "Source type. Required. " }, { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "nullable": true, "description": "Source id. Optional. " }, "description": "Source id. Optional. " }, { "name": "scope", "in": "query", "required": true, "schema": { "type": "string", "description": "Scope. Required. ", "enum": [ "contact", "activity", "record" ] }, "description": "Scope. Required. " }, { "name": "activity_type", "in": "query", "required": false, "schema": { "type": "string", "nullable": true, "description": "Activity type. Optional. Limits: max:100." }, "description": "Activity type. Optional. Limits: max:100." }, { "name": "recipient_mode", "in": "query", "required": false, "schema": { "type": "string", "description": "Recipient mode. Optional. ", "enum": [ "contact", "record", "source" ] }, "description": "Recipient mode. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/preview": { "post": { "summary": "Preview follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups_preview", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@preview", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:30,1" ], "description": "Preview for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request. CRM activity plans require scope=activity, recipient_mode=source and both stopping flags enabled. Existing main-app, contacts.edit, workflow permission and task balance requirements remain. CRM-only packaged reminders are not supported yet. Current source reads occur before dispatch; external edits after that read are not atomically fenced.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_ids": { "type": "array", "items": {}, "description": "Contact ids. Optional. Limits: max:30." }, "source_type": { "type": "string", "enum": [ "all", "list", "segment", "data_table", "crm_activity" ], "description": "crm_activity selects one source-owned CRM activity; no central contact copy." }, "source_id": { "type": "string", "format": "uuid", "nullable": true, "description": "List/segment/table ID, or the owner’s saved CRM connection row ID for crm_activity." }, "source_record_id": { "type": "string", "nullable": true, "pattern": "^[1-9][0-9]{0,18}$", "description": "Required for crm_activity: original numeric CRM activity ID as a string." }, "recipient_mode": { "type": "string", "enum": [ "contact", "record", "source" ], "description": "Use source for CRM activities; contact is null in the workflow input." } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}": { "get": { "summary": "Get follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups__plan_", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@show", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Show for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Save follow up", "operationId": "PUT_api_v1_platform_organisations__workspace__follow_ups__plan_", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@save", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request. CRM activity plans require scope=activity, recipient_mode=source and both stopping flags enabled. Existing main-app, contacts.edit, workflow permission and task balance requirements remain. CRM-only packaged reminders are not supported yet. Current source reads occur before dispatch; external edits after that read are not atomically fenced.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "Version. Optional. " }, "source_type": { "type": "string", "enum": [ "all", "list", "segment", "data_table", "crm_activity" ], "description": "crm_activity selects one source-owned CRM activity; no central contact copy." }, "source_id": { "type": "string", "format": "uuid", "nullable": true, "description": "List/segment/table ID, or the owner’s saved CRM connection row ID for crm_activity." }, "source_record_id": { "type": "string", "nullable": true, "pattern": "^[1-9][0-9]{0,18}$", "description": "Required for crm_activity: original numeric CRM activity ID as a string." }, "recipient_mode": { "type": "string", "enum": [ "contact", "record", "source" ], "description": "Use source for CRM activities; contact is null in the workflow input." } } } } } } }, "delete": { "summary": "Delete follow up", "operationId": "DELETE_api_v1_platform_organisations__workspace__follow_ups__plan_", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@destroy", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Destroy for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/control": { "post": { "summary": "Control follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups__plan__control", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@control", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Control for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "description": "Action. Required. ", "enum": [ "pause", "resume", "archive" ] } }, "required": [ "action" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/enroll": { "post": { "summary": "Enroll follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups__plan__enroll", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@enroll", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:20,1" ], "description": "Enroll for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_ids": { "type": "array", "items": {}, "description": "Contact ids. Optional. Limits: max:100." }, "record_ids": { "type": "array", "items": {}, "description": "Record ids. Optional. Limits: max:100." }, "activity_ids": { "type": "array", "items": {}, "description": "Activity ids. Optional. Limits: max:100." } } } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/steps/{step}/test-sample": { "get": { "summary": "Test sample follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups__plan__steps__step__test_sample", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@testSample", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:30,1" ], "description": "Test sample for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "step", "in": "path", "required": true, "description": "Step identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/steps/{step}/test": { "post": { "summary": "Test step follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups__plan__steps__step__test", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@testStep", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess", "throttle:6,1" ], "description": "Test step for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "step", "in": "path", "required": true, "description": "Step identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:1." }, "request_id": { "type": "string", "format": "uuid", "description": "Request id. Required. " }, "mode": { "type": "string", "description": "Mode. Optional. ", "enum": [ "capture", "run" ] }, "record_values": { "type": "array", "items": {}, "description": "Record values. Optional. Limits: max:100." } }, "required": [ "expected_version", "request_id" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/enrollments": { "get": { "summary": "Enrollments follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups__plan__enrollments", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@enrollments", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Enrollments for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1." }, "description": "Page. Optional. Limits: min:1." }, { "name": "contact_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Contact id. Optional. " }, "description": "Contact id. Optional. " }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Status. Optional. Limits: max:30." }, "description": "Status. Optional. Limits: max:30." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/occurrences": { "get": { "summary": "Occurrences follow up", "operationId": "GET_api_v1_platform_organisations__workspace__follow_ups__plan__occurrences", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@occurrences", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Occurrences for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page. Optional. Limits: min:1." }, "description": "Page. Optional. Limits: min:1." }, { "name": "contact_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Contact id. Optional. " }, "description": "Contact id. Optional. " }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Status. Optional. Limits: max:30." }, "description": "Status. Optional. Limits: max:30." }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/{plan}/enrollments/{enrollment}/control": { "post": { "summary": "Control enrollment follow up", "operationId": "POST_api_v1_platform_organisations__workspace__follow_ups__plan__enrollments__enrollment__control", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@controlEnrollment", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Control enrollment for follow up. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "plan", "in": "path", "required": true, "description": "Plan identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "enrollment", "in": "path", "required": true, "description": "Enrollment identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "description": "Action. Required. ", "enum": [ "pause", "resume", "cancel", "restart" ] }, "parameters": { "type": "array", "items": {}, "description": "Parameters. Optional. Limits: max:100." } }, "required": [ "action" ] } } } }, "x-authentication": "application-api-key" } }, "/tasks/{task}/contact-follow-up": { "get": { "summary": "Trigger follow up", "operationId": "GET_tasks__task__contact_follow_up", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@trigger", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Trigger for follow up. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Workspace id. Optional. " }, "description": "Workspace id. Optional. " }, { "name": "plan_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Plan id. Optional. " }, "description": "Plan id. Optional. " }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Save trigger follow up", "operationId": "PUT_tasks__task__contact_follow_up", "tags": [ "Follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@saveTrigger", "x-auth-middleware": [ "api", "autoappy.product" ], "description": "Save trigger for follow up. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "task", "in": "path", "required": true, "description": "Task identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "Workspace id. Required. " }, "plan_id": { "type": "string", "format": "uuid", "description": "Plan id. Required. " }, "step_ids": { "type": "array", "items": {}, "description": "Step ids. Required. Limits: min:1, max:20." } }, "required": [ "workspace_id", "plan_id", "step_ids" ] } } } }, "x-authentication": "application-api-key" } }, "/internal/contact-follow-ups/status": { "get": { "summary": "Status scheduler follow up", "operationId": "GET_internal_contact_follow_ups_status", "tags": [ "Scheduler follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\SchedulerFollowUpController@status", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthenticateScheduler" ], "description": "Status for scheduler follow up. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. ", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/internal/contact-follow-ups/awake": { "post": { "summary": "Awake scheduler follow up", "operationId": "POST_internal_contact_follow_ups_awake", "tags": [ "Scheduler follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\SchedulerFollowUpController@awake", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthenticateScheduler" ], "description": "Awake for scheduler follow up. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Limit. Optional. Limits: min:1, max:100." } } } } } }, "x-authentication": "interactive-session" } }, "/internal/contact-follow-ups/{occurrence}/execute": { "post": { "summary": "Execute scheduler follow up", "operationId": "POST_internal_contact_follow_ups__occurrence__execute", "tags": [ "Scheduler follow up" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\SchedulerFollowUpController@execute", "x-auth-middleware": [ "api", "App\\Http\\Middleware\\AuthenticateScheduler" ], "description": "Execute for scheduler follow up. Use a main application API key for product routes; account/security management still requires interactive sign-in. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "occurrence", "in": "path", "required": true, "description": "Occurrence identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "interactive-session" } }, "/api/v1/platform/organisations/{workspace}/customer-sharing/settings": { "get": { "summary": "Settings customer sharing", "operationId": "GET_api_v1_platform_organisations__workspace__customer_sharing_settings", "tags": [ "Customer sharing" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\CustomerSharingController@settings", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Settings for customer sharing. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Save settings customer sharing", "operationId": "PUT_api_v1_platform_organisations__workspace__customer_sharing_settings", "tags": [ "Customer sharing" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\CustomerSharingController@saveSettings", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Save settings for customer sharing. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "automatic": { "type": "boolean", "description": "Automatic. Required. " }, "targets": { "type": "array", "items": {}, "description": "Targets. Optional. Limits: max:20." }, "expected_version": { "type": "integer", "description": "Expected version. Required. Limits: min:0." } }, "required": [ "automatic", "expected_version" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/contacts/{contact}/app-sharing": { "get": { "summary": "Get customer sharing", "operationId": "GET_api_v1_platform_organisations__workspace__contacts__contact__app_sharing", "tags": [ "Customer sharing" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\CustomerSharingController@show", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Show for customer sharing. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. ", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "x-authentication": "application-api-key" }, "put": { "summary": "Distribute customer sharing", "operationId": "PUT_api_v1_platform_organisations__workspace__contacts__contact__app_sharing", "tags": [ "Customer sharing" ], "responses": { "200": { "description": "Successful response. Shape follows the resource returned by this operation.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Rate limit reached. Honour Retry-After before another request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } } }, "x-controller": "App\\Http\\Controllers\\Api\\V1\\CustomerSharingController@distribute", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Distribute for customer sharing. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "contact", "in": "path", "required": true, "description": "Contact identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "module": { "type": "string", "description": "Module. Required. " }, "mode": { "type": "string", "description": "Mode. Required. ", "enum": [ "copy", "sync", "off" ] } }, "required": [ "module", "mode" ] } } } }, "x-authentication": "application-api-key" } }, "/api/v1/platform/organisations/{workspace}/follow-ups/crm-activities/{activity}/plans": { "get": { "summary": "List my verified activity reminder plans", "operationId": "followup_crm_activity_plans", "tags": [ "Follow up" ], "responses": { "200": { "description": "Bounded summary, without workflow inputs or credentials.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "has_more", "page", "scope" ], "properties": { "data": { "type": "array", "maxItems": 20, "description": "Only the current actor’s plans with a previously verified exact activity binding. Unenrolled drafts and other owners’ plans are omitted.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Existing central reminder plan ID." }, "name": { "type": "string", "description": "Plan name." }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ], "description": "Saved plan state; paused plans do not dispatch." }, "next_run_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Earliest pending occurrence in UTC for this exact binding; null if none. Not a delivery guarantee." } } } }, "has_more": { "type": "boolean", "description": "Request the next page explicitly when true." }, "page": { "type": "integer", "description": "Current page, starting at 1." }, "scope": { "type": "string", "enum": [ "own_verified_plans", "not_connected" ], "description": "not_connected is returned only by CRM when its organisation is unlinked." } } }, "example": { "data": [ { "id": "a9892043-1519-4cf9-9875-268d915eea23", "name": "Call reminder", "status": "active", "next_run_at": "2026-09-26T09:00:00+00:00" } ], "has_more": false, "page": 1, "scope": "own_verified_plans" } } } }, "401": { "description": "Missing or expired authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "403": { "description": "Application, read/write permission, organisation or resource access denied.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "404": { "description": "Resource does not exist or is unavailable to this caller.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "422": { "description": "Invalid request fields; inspect errors by field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }, "429": { "description": "Too many reads; wait before refreshing." }, "503": { "description": "Service unavailable or invalid upstream response. Refresh explicitly; do not treat as an empty list." } }, "x-controller": "App\\Http\\Controllers\\FollowUpController@index", "x-auth-middleware": [ "api", "auth:sanctum,api", "passport.bearer", "identity.scopes:platform", "App\\Http\\Middleware\\RequirePlatformClientAccess" ], "description": "Read-only, on-demand summary. No plans are created and no messages are sent. Requires the signed-in actor’s access; CRM checks activity visibility before forwarding that actor’s token. Central membership, main-product entitlement and plan ownership are enforced. No connector credential fallback. Empty data is not an organisation-wide assurance that no reminders exist. Open or refresh explicitly; do not poll this endpoint.", "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "Workspace identifier. Obtain it from the corresponding list endpoint in this workspace.", "schema": { "type": "string" } }, { "name": "X-AutoAppy-Workspace", "in": "header", "required": false, "description": "Central organisation UUID for the authorised workspace. Required by organisation-scoped operations.", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 1 }, "description": "Page of at most 20 plans." }, { "name": "activity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]+$" }, "description": "Original CRM activity ID." }, { "name": "local_workspace_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "CRM local workspace ID, not the central organisation ID." }, { "name": "lead_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "description": "Original CRM lead ID belonging to the activity." } ], "x-authentication": "application-api-key" } }, "/api/v1/platform/module/organisations/{workspace}/contacts/{contact}/context": { "get": { "summary": "Load one connected customer section", "operationId": "custom_app_customer_context_show", "tags": [ "Connected customer" ], "security": [ { "UserBearer": [] } ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Explicit existing identifier; must belong to the authorised organisation." }, { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Explicit existing identifier; must belong to the authorised organisation." }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 1 }, "description": "Explicit page of at most 20 records or events." }, { "name": "record_id", "in": "query", "schema": { "type": "string", "maxLength": 128 }, "description": "Optional selected CRM opportunity or WhatsApp conversation ID from this customer section. Loads its activities or messages." }, { "name": "section", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "profile", "crm", "whatsapp" ] }, "description": "Only this section is fetched. Other apps are not queried." }, { "name": "X-AutoAppy-Module", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "crm", "whatsapp" ] }, "description": "Calling product; its entitlement and customer grant are checked." } ], "description": "On-demand actor-authorized read. Requires an explicit connected customer. Data remains in each owner service. No customer replication, sending, connector fallback or automatic retry. Paginated summaries; selected CRM records return activities, selected WhatsApp records return message previews. Responses are private/no-store. Partial source failure is distinct from empty data.", "responses": { "200": { "description": "data envelope: status ready/not_connected/denied/unavailable, customer_id, source, fetched_at, items, has_more. Access checks return only customer_id." }, "401": { "description": "Sign in again." }, "403": { "description": "Actor, workspace, customer or product access denied." }, "404": { "description": "Selected record unavailable." }, "422": { "description": "Invalid section, page or identifier." }, "429": { "description": "Rate limited; refresh later." }, "503": { "description": "Context service unavailable; do not interpret as empty data." } } } }, "/api/v1/platform/module/organisations/{workspace}/contacts/{contact}/context-access": { "get": { "summary": "Check the current actor customer connection", "operationId": "custom_app_customer_context_access", "tags": [ "Connected customer" ], "security": [ { "UserBearer": [] } ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Explicit existing identifier; must belong to the authorised organisation." }, { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Explicit existing identifier; must belong to the authorised organisation." }, { "name": "X-AutoAppy-Module", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "crm", "whatsapp" ] }, "description": "Calling product; its entitlement and customer grant are checked." } ], "description": "On-demand actor-authorized read. Requires an explicit connected customer. Data remains in each owner service. No customer replication, sending, connector fallback or automatic retry. Paginated summaries; selected CRM records return activities, selected WhatsApp records return message previews. Responses are private/no-store. Partial source failure is distinct from empty data.", "responses": { "200": { "description": "data envelope: status ready/not_connected/denied/unavailable, customer_id, source, fetched_at, items, has_more. Access checks return only customer_id." }, "401": { "description": "Sign in again." }, "403": { "description": "Actor, workspace, customer or product access denied." }, "404": { "description": "Selected record unavailable." }, "422": { "description": "Invalid section, page or identifier." }, "429": { "description": "Rate limited; refresh later." }, "503": { "description": "Context service unavailable; do not interpret as empty data." } } } } }, "externalDocs": { "description": "Standalone API guide", "url": "https://autoappy.com/api/guide.md" }, "tags": [ { "name": "Agent builder" }, { "name": "Agent model" }, { "name": "App" }, { "name": "App connection" }, { "name": "Calculations" }, { "name": "Category" }, { "name": "Contact management" }, { "name": "Customer sharing" }, { "name": "Data app" }, { "name": "Data developer" }, { "name": "Data workspace" }, { "name": "Database bundle" }, { "name": "Databases" }, { "name": "Dynamic input" }, { "name": "Email" }, { "name": "Folder" }, { "name": "Follow up" }, { "name": "Founder call payment" }, { "name": "Idea" }, { "name": "Idea attachment" }, { "name": "Idea flow" }, { "name": "Identity" }, { "name": "Lead" }, { "name": "Lead activity" }, { "name": "Lead owner" }, { "name": "Lead stage" }, { "name": "Lead workflow" }, { "name": "Mcp settings" }, { "name": "Mcp trigger" }, { "name": "Meeting" }, { "name": "Node transition" }, { "name": "Payment" }, { "name": "Plan" }, { "name": "Platform" }, { "name": "Query" }, { "name": "Review" }, { "name": "Rows" }, { "name": "Scheduler follow up" }, { "name": "Scheduling overview" }, { "name": "Stage node" }, { "name": "Tables" }, { "name": "Tag" }, { "name": "Task" }, { "name": "Task ranking" }, { "name": "User" }, { "name": "User plan" }, { "name": "User preference" }, { "name": "User profile" }, { "name": "User scheduling" }, { "name": "Workflow" }, { "name": "Workflow execution" }, { "name": "Workflow export import" }, { "name": "Workflow graph" }, { "name": "Workflow template" }, { "name": "Workflow templates extended" } ] }