{ "openapi": "3.1.0", "info": { "title": "Workfront Fusion API", "description": "REST APIs for managing and monitoring your Workfront Fusion resources. Use these APIs to programmatically access activity logs and other Fusion components coming soon.\n\n**Base URL:** https://fusion.adobe.io\n\n**Getting Started:**\n\n For detailed setup instructions, make sure to visit the [Getting Started guide](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/).\n1. Set up authentication in Adobe Developer Console, as documented [here](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/authentication/).\n2. Obtain required headers (Authorization, x-api-key, x-organization-id, x-gw-region). More details [here](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/api_headers/).\n3. Update permissions for the technical account, as documented [here](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/technical_accounts/).\n4. Make your first API call.\n", "version": "v3" }, "servers": [ { "url": "https://fusion.adobe.io", "description": "Production server" } ], "tags": [ { "name": "Scenarios", "description": "Endpoints for listing, retrieving, cloning, and inspecting scenario dependencies in your organization, and related scenario operations." }, { "name": "Folders", "description": "Endpoints for creating and managing folders used to organize automations within teams." }, { "name": "Activity Logs", "description": "Endpoints for getting and exporting log of activities, such as creating a scenario or inviting a user, for your organization. Please note, for accessing activity logs, user must be a Workfront Fusion administrator for the organization.", "externalDocs": { "description": "Find out more in product documentation.", "url": "https://experienceleague.adobe.com/en/docs/workfront-fusion/using/set-up-and-manage-fusion/set-up-and-manage-orgs-and-teams/set-up-orgs-teams-and-users/view-activity-logs-for-an-org" } }, { "name": "Operations", "description": "Endpoints for getting operation count in a particular Fusion organization, grouped by various parameters. An operation is a task performed by a module. For tracking purposes, any successful action performed by a module is an operation.", "externalDocs": { "description": "Find out more in product documentation.", "url": "https://experienceleague.adobe.com/en/docs/workfront-fusion/using/set-up-and-manage-fusion/licensing-and-operations-overviews/operations-in-workfront-fusion" } }, { "name": "Connections", "description": "Endpoints for managing connections within your organization. These endpoints allow you to list all connections, retrieve details for a specific connection, and view scenarios associated with a given connection." }, { "name": "Hooks", "description": "Endpoints for managing hooks within your organization. These endpoints allow you to list all hooks scoped to a team and retrieve full details and configuration for a specific hook." }, { "name": "Data Stores", "description": "Endpoints for managing data stores within your organization. These endpoints allow you to list all data stores scoped to a team, and retrieve details for a specific data store including its metadata and usage metrics such as record count and storage size." }, { "name": "Logs", "description": "Endpoints for retrieving execution logs within your organization. These endpoints allow you to list all executions scoped to a scenario or incomplete execution." } ], "paths": { "/api/v3/scenarios/export": { "post": { "description": "Download the full blueprint for one or more scenarios.\n**Limits:** up to 100 scenario IDs per request.", "operationId": "ScenariosControllerV3_exportScenarios_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "scenarioIds": { "description": "One or more scenario IDs to export. Maximum 100 IDs per request.", "example": [ 1, 2, 3 ], "type": "array", "items": { "type": "number" } } }, "required": [ "scenarioIds" ] } } } }, "responses": { "200": { "description": "The scenario blueprints. Each line of the response is one scenario record.", "content": { "application/x-ndjson": { "schema": { "type": "object", "properties": { "scenarioId": { "type": "number", "description": "The ID of the exported scenario.", "example": 42 }, "name": { "type": "string", "description": "The name of the exported scenario.", "example": "My Firefly Scenario" }, "teamId": { "type": "number", "description": "The ID of the team that owns this scenario.", "example": 88 }, "folderId": { "type": "number", "description": "The ID of the folder the scenario belongs to, or `null` if it is not in any folder.", "example": null, "nullable": true }, "blueprint": { "type": "object", "description": "The full scenario blueprint — modules, connections, mappings, and settings exactly as configured.", "example": { "flow": [ { "id": 1, "mapper": { "n": "1", "style": { "imageReference": {} }, "locale": "en-US", "prompt": "ocean and pineapple cocktail", "extension": "default", "structure": { "imageReference": {} } }, "module": "adobe-firefly:generateAnImage2", "version": 1, "metadata": { "expect": [ { "name": "prompt", "type": "text", "label": "Prompt", "required": true }, { "name": "modelVersion", "type": "select", "label": "Model version", "validate": { "enum": [ "image3", "image3_custom", "image4_standard", "image4_ultra", "image4_custom" ] } }, { "name": "n", "type": "number", "label": "Number of variations" }, { "name": "extension", "type": "select", "label": "Generated image format", "required": true, "validate": { "enum": [ "jpeg", "png", "webp", "default" ] } }, { "name": "negativePrompt", "type": "text", "label": "Negative prompt" }, { "name": "contentClass", "type": "select", "label": "Content class", "validate": { "enum": [ "photo", "art" ] } }, { "name": "seeds", "type": "array", "label": "Seeds" }, { "name": "size", "type": "select", "label": "Size", "validate": { "enum": [ "2048,2048", "1024,1024", "2304,1792", "1792,2304", "2688,1536", "1344,768", "1152,896", "896,1152" ] } }, { "name": "visualIntensity", "type": "number", "label": "Visual intensity" }, { "name": "locale", "type": "text", "label": "Locale" }, { "name": "tileable", "type": "boolean", "label": "Tileable" }, { "name": "structure", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Structure" }, { "name": "style", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" }, { "name": "presets", "type": "array", "label": "Presets" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Style" } ], "restore": { "size": { "mode": "chose", "label": "" }, "seeds": { "mode": "chose", "items": [] }, "style": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" }, "presets": { "mode": "chose", "items": [] } } } } }, "tileable": { "mode": "chose" }, "extension": { "mode": "chose", "label": "Default" }, "structure": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" } } } } }, "connection": { "label": "My Adobe Firefly Connection connection" }, "contentClass": { "mode": "chose", "label": "" }, "modelVersion": { "mode": "chose", "label": "" } }, "designer": { "x": 0, "y": 0 }, "parameters": [ { "name": "connection", "type": "account", "label": "Connection", "required": true } ] }, "parameters": { "connection": 23252 } } ], "name": "Integration Adobe Firefly", "metadata": { "instant": false, "version": 1, "designer": { "orphans": [], "samples": { "1": { "data": "IMTBuffer(1032427, binary, 101231cde69182e66345b914ecf31f65d4141489): ffd8ffe000104a4649460001010000...", "details": { "url": "https://pre-signed-firefly-stage.s3-accelerate.amazonaws.com/images/ca17c73e-bf03-4c38-8a3d-29ac28f5...", "seed": 1663688808 }, "filename": "generated_result.jpeg..." } } }, "scenario": { "dlq": false, "dataloss": false, "maxErrors": 3, "autoCommit": true, "roundtrips": 1, "sequential": false, "confidential": false, "autoCommitTriggerLast": true } } } } }, "required": [ "scenarioId", "name", "teamId", "folderId", "blueprint" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "At least one scenarioId must be provided.", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Scenario(s) not found: 123, 456.", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Export scenario blueprints", "tags": [ "Scenarios" ] } }, "/api/v3/scenarios/{scenarioId}": { "get": { "description": "Returns the scenario details and full blueprint for the given scenario.", "operationId": "ScenariosControllerV3_getScenario_v3", "parameters": [ { "name": "scenarioId", "required": true, "in": "path", "description": "Scenario ID", "schema": { "example": 123, "type": "number" } } ], "responses": { "200": { "description": "Scenario details and blueprint", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario identifier within the organization context.", "example": 123 }, "name": { "type": "string", "description": "Display name of the scenario.", "example": "Daily data sync" }, "teamId": { "type": "number", "description": "ID of the team that owns this scenario (maps to the team/company in Fusion).", "example": 88 }, "description": { "type": "string", "description": "Optional longer description shown in the UI.", "example": "Generate an image." }, "folderId": { "type": "number", "description": "Folder ID for organizing scenarios; omit if the scenario is not in a folder.", "example": 10 }, "usedPackages": { "description": "Identifiers of app packages or modules referenced by the scenario (for example integrations).", "example": [ "adobe-firefly" ], "type": "array", "items": { "type": "string" } }, "isInvalid": { "type": "boolean", "description": "True when the scenario is considered invalid (for example disabled after repeated errors).", "example": false }, "isActive": { "type": "boolean", "description": "Whether the scenario is linked and eligible to run.", "example": false }, "isLocked": { "type": "boolean", "description": "True while the scenario cannot be executed (for example still being configured).", "example": false }, "isPaused": { "type": "boolean", "description": "True when execution is paused after errors until the scenario is resumed.", "example": false }, "sequential": { "type": "boolean", "description": "Whether modules in the scenario run strictly in order (sequential execution).", "example": true }, "lastEdit": { "type": "string", "description": "ISO 8601 timestamp of the last modification to the scenario.", "example": "2026-03-05T15:20:00.000Z", "format": "date-time" }, "scheduling": { "type": "object", "description": "Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).", "example": { "time": "07:53", "type": "daily" } }, "hookId": { "type": "number", "description": "Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.", "example": 555 }, "blueprint": { "type": "object", "description": "Full automation blueprint: modules, flow, parameters, and metadata. Structure depends on the apps and modules in use.", "example": { "flow": [ { "id": 1, "mapper": { "n": "1", "style": { "imageReference": {} }, "locale": "en-US", "prompt": "ocean and pineapple cocktail", "extension": "default", "structure": { "imageReference": {} } }, "module": "adobe-firefly:generateAnImage2", "version": 1, "metadata": { "expect": [ { "name": "prompt", "type": "text", "label": "Prompt", "required": true }, { "name": "modelVersion", "type": "select", "label": "Model version", "validate": { "enum": [ "image3", "image3_custom", "image4_standard", "image4_ultra", "image4_custom" ] } }, { "name": "n", "type": "number", "label": "Number of variations" }, { "name": "extension", "type": "select", "label": "Generated image format", "required": true, "validate": { "enum": [ "jpeg", "png", "webp", "default" ] } }, { "name": "negativePrompt", "type": "text", "label": "Negative prompt" }, { "name": "contentClass", "type": "select", "label": "Content class", "validate": { "enum": [ "photo", "art" ] } }, { "name": "seeds", "type": "array", "label": "Seeds" }, { "name": "size", "type": "select", "label": "Size", "validate": { "enum": [ "2048,2048", "1024,1024", "2304,1792", "1792,2304", "2688,1536", "1344,768", "1152,896", "896,1152" ] } }, { "name": "visualIntensity", "type": "number", "label": "Visual intensity" }, { "name": "locale", "type": "text", "label": "Locale" }, { "name": "tileable", "type": "boolean", "label": "Tileable" }, { "name": "structure", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Structure" }, { "name": "style", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" }, { "name": "presets", "type": "array", "label": "Presets" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Style" } ], "restore": { "size": { "mode": "chose", "label": "" }, "seeds": { "mode": "chose", "items": [] }, "style": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" }, "presets": { "mode": "chose", "items": [] } } } } }, "tileable": { "mode": "chose" }, "extension": { "mode": "chose", "label": "Default" }, "structure": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" } } } } }, "connection": { "label": "My Adobe Firefly Connection connection" }, "contentClass": { "mode": "chose", "label": "" }, "modelVersion": { "mode": "chose", "label": "" } }, "designer": { "x": 0, "y": 0 }, "parameters": [ { "name": "connection", "type": "account", "label": "Connection", "required": true } ] }, "parameters": { "connection": 23252 } } ], "name": "Integration Adobe Firefly", "metadata": { "instant": false, "version": 1, "designer": { "orphans": [], "samples": { "1": { "data": "IMTBuffer(1032427, binary, 101231cde69182e66345b914ecf31f65d4141489): ffd8ffe000104a4649460001010000...", "details": { "url": "https://pre-signed-firefly-stage.s3-accelerate.amazonaws.com/images/ca17c73e-bf03-4c38-8a3d-29ac28f5...", "seed": 1663688808 }, "filename": "generated_result.jpeg..." } } }, "scenario": { "dlq": false, "dataloss": false, "maxErrors": 3, "autoCommit": true, "roundtrips": 1, "sequential": false, "confidential": false, "autoCommitTriggerLast": true } } } } }, "required": [ "id", "name", "teamId", "isInvalid", "isActive", "isLocked", "isPaused", "sequential", "blueprint" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "scenarioId must be a number string", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get scenario by ID", "tags": [ "Scenarios" ] } }, "/api/v3/scenarios": { "get": { "description": "Returns a paginated, filterable list of scenarios in the organization. Supply `teamId` in the property query to restrict results to one team.", "operationId": "ScenariosControllerV3_getScenarios_v3", "parameters": [ { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- name\n- teamId\n- description\n- folderId\n- isInvalid\n- isActive\n- isLocked\n- isPaused\n- lastEdit\n- hookId\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, lastEdit.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved paged scenarios", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of scenarios", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario identifier within the organization context.", "example": 123 }, "name": { "type": "string", "description": "Display name of the scenario.", "example": "Daily data sync" }, "teamId": { "type": "number", "description": "ID of the team that owns this scenario (maps to the team/company in Fusion).", "example": 88 }, "description": { "type": "string", "description": "Optional longer description shown in the UI.", "example": "Generate an image." }, "folderId": { "type": "number", "description": "Folder ID for organizing scenarios; omit if the scenario is not in a folder.", "example": 10 }, "usedPackages": { "description": "Identifiers of app packages or modules referenced by the scenario (for example integrations).", "example": [ "adobe-firefly" ], "type": "array", "items": { "type": "string" } }, "isInvalid": { "type": "boolean", "description": "True when the scenario is considered invalid (for example disabled after repeated errors).", "example": false }, "isActive": { "type": "boolean", "description": "Whether the scenario is linked and eligible to run.", "example": false }, "isLocked": { "type": "boolean", "description": "True while the scenario cannot be executed (for example still being configured).", "example": false }, "isPaused": { "type": "boolean", "description": "True when execution is paused after errors until the scenario is resumed.", "example": false }, "sequential": { "type": "boolean", "description": "Whether modules in the scenario run strictly in order (sequential execution).", "example": true }, "lastEdit": { "type": "string", "description": "ISO 8601 timestamp of the last modification to the scenario.", "example": "2026-03-05T15:20:00.000Z", "format": "date-time" }, "scheduling": { "type": "object", "description": "Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).", "example": { "time": "07:53", "type": "daily" } }, "hookId": { "type": "number", "description": "Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.", "example": 555 } }, "required": [ "id", "name", "teamId", "isInvalid", "isActive", "isLocked", "isPaused", "sequential" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "\"teamId\" has to be set.", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List scenarios", "tags": [ "Scenarios" ] } }, "/api/v3/scenarios/{scenarioId}/dependencies": { "get": { "description": "Returns the connections, keys, data stores, hooks, and data structures referenced by the scenario blueprint.", "operationId": "ScenariosControllerV3_getScenarioDependency_v3", "parameters": [ { "name": "scenarioId", "required": true, "in": "path", "description": "Scenario ID", "schema": { "example": 123, "type": "number" } } ], "responses": { "200": { "description": "Dependencies used by the scenario (connections, keys, data stores, hooks, data structures)", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "description": "List of scenario dependencies (connections, keys, data stores, hooks, and data structures)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Dependency ID", "example": 1 }, "name": { "type": "string", "description": "Dependency name", "example": "Firefly connection" }, "kind": { "type": "string", "description": "Type of dependency", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ], "example": "connection" }, "type": { "type": "string", "description": "Optional subtype for hook, connection, and key", "example": "workfront-workfront" } }, "required": [ "id", "name", "kind" ] } } }, "required": [ "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get scenario dependencies", "tags": [ "Scenarios" ] } }, "/api/v3/scenarios/{scenarioId}/clone": { "post": { "description": "Creates a copy of the scenario in the target team, applying dependency replacements from the body.\nThe response body contains the new scenario ID; the `Location` header points to the new resource.\n\n**Rules**\n- **Same team**: existing connections may be reused; you can omit replacements for them.\n- **Different team**: connections cannot be reused; provide replacements for each required connection.\n- If the source scenario uses a **hook**, provide an unused hook in the replacements.\n- For **data stores, data structures, and keys**: if you supply IDs in the request, those are used; otherwise they are duplicated in the target team.", "operationId": "ScenariosControllerV3_cloneScenario_v3", "parameters": [ { "name": "scenarioId", "required": true, "in": "path", "description": "Source scenario ID to clone", "schema": { "example": 123, "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "number", "description": "Team ID where the cloned scenario will be created", "example": 88 }, "folderId": { "type": "number", "description": "Folder ID where the cloned scenario will be created", "example": 88 }, "name": { "type": "string", "description": "Name for the cloned scenario", "example": "My copied scenario", "maxLength": 255 }, "replacements": { "description": "Maps source dependencies to target resources in the new team", "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "description": "Type of dependency to replace", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ] }, "sourceId": { "type": "number", "description": "Source dependency id (in the original scenario)", "example": 100 }, "targetId": { "type": "number", "description": "Target dependency id (replacement in the clone)", "example": 200 } }, "required": [ "kind", "sourceId", "targetId" ] } } }, "required": [ "teamId", "replacements" ] } } } }, "responses": { "201": { "description": "New scenario created; response body contains its ID. `Location` header is set to the new scenario URL.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the newly created (cloned) scenario", "example": 456 } }, "required": [ "id" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Correct hook should be provided", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Clone scenario", "tags": [ "Scenarios" ] } }, "/api/v3/folders": { "get": { "description": "Returns folders for the team with scenario counts.", "operationId": "FoldersControllerV3_getFolders_v3", "parameters": [ { "name": "teamId", "required": true, "in": "query", "description": "Team ID", "schema": { "example": 88, "type": "number" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- name\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, scenariosTotal.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "Folders for the team", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 501 }, "name": { "type": "string", "example": "Marketing automations" }, "scenariosTotal": { "type": "number", "description": "Number of scenarios in the folder", "example": 0 } }, "required": [ "id", "name", "scenariosTotal" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get folders", "tags": [ "Folders" ] }, "post": { "description": "Creates a folder for organizing scenarios in the team.", "operationId": "FoldersControllerV3_createFolder_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "number", "description": "Team that will own the folder", "example": 88 }, "name": { "type": "string", "description": "Display name of the folder", "example": "Marketing automations" } }, "required": [ "teamId", "name" ] } } } }, "responses": { "201": { "description": "Folder created", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the created folder", "example": 501 } }, "required": [ "id" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Create a folder", "tags": [ "Folders" ] } }, "/api/v3/folders/{folderId}": { "delete": { "description": "Deletes a folder", "operationId": "FoldersControllerV3_deleteFolder_v3", "parameters": [ { "name": "folderId", "required": true, "in": "path", "schema": { "example": 501, "type": "number" } }, { "name": "x-organization-id", "in": "header", "description": "Fusion organization ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Folder deleted" }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Delete folder", "tags": [ "Folders" ] }, "patch": { "description": "Updates the folder.", "operationId": "FoldersControllerV3_updateFolder_v3", "parameters": [ { "name": "folderId", "required": true, "in": "path", "schema": { "example": 501, "type": "number" } }, { "name": "x-organization-id", "in": "header", "description": "Fusion organization ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "New display name for the folder", "example": "Marketing automations" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Folder updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "example": 501 }, "name": { "type": "string", "example": "Marketing automations" }, "scenariosTotal": { "type": "number", "description": "Number of scenarios in the folder", "example": 0 } }, "required": [ "id", "name", "scenariosTotal" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Update folder", "tags": [ "Folders" ] } }, "/api/v3/activity-logs": { "get": { "description": "Returns a paged list of activity logs using cursor-based paging and property filters.", "operationId": "ActivityLogsV3Controller_getActivityLogsByHeader", "parameters": [ { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- timestamp\n- messageId\n- userId\n- userName\n- teamId\n- teamName\n- entity\n- entityId\n- action\n- message\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: timestamp.", "schema": { "example": "+id", "type": "string" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved paged activity logs", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of activity logs", "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp when the activity occurred (UTC)", "example": "2025-12-09T11:39:34.834Z", "format": "date-time" }, "messageId": { "type": "string", "description": "Unique message identifier", "example": "5833b3d8-1215-4dc0-aa51-423a1993f7d1" }, "userId": { "type": "number", "description": "User ID who triggered the activity", "example": 2555 }, "userName": { "type": "string", "description": "User display name", "example": "John Snow" }, "teamId": { "type": "number", "description": "Team ID associated with the activity", "example": 34 }, "teamName": { "type": "string", "description": "Team name", "example": "My Team" }, "orgId": { "type": "number", "description": "Organization ID", "example": 2245 }, "entity": { "type": "string", "description": "Entity type that was affected", "enum": [ "team", "scenario", "webhook", "connection", "data structure", "data store", "organization", "folder", "user", "key", "keys" ], "example": "scenario" }, "entityId": { "type": "number", "description": "Entity ID related to the activity", "example": 38641 }, "action": { "type": "string", "description": "Action performed on the entity", "enum": [ "created", "deleted", "renamed", "disabled", "enabled", "deactivated", "reauthorized", "activated", "updated", "moved", "cloned", "invited", "transferred ownership", "changed organization role", "changed team role" ], "example": "updated" }, "message": { "type": "string", "description": "Human-readable activity message", "example": "John Snow updated \"Update Project tasks (Data Store Project)\" scenario" } }, "required": [ "timestamp", "messageId", "userId", "userName", "teamName", "orgId", "entity", "action", "message" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Paging parameters require orderby to be specified", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get activity logs", "tags": [ "Activity Logs" ] } }, "/api/v3/activity-logs/export": { "get": { "description": "\nExports activity logs as CSV or XLSX based on the Accept header. Use this endpoint to download activity logs for offline analysis, compliance reporting, or integration with external tools.\n\n**Export Formats:**\n\n- **CSV**: Set `Accept: text/csv` (default)\n- **Excel**: Set `Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n\n**Note:** Large exports may take several seconds to generate.\n ", "operationId": "ActivityLogsV3Controller_exportActivityLogsByHeader", "parameters": [ { "name": "accept", "required": false, "in": "header", "description": "\nResponse media type for the exported file.\n\n**Supported values:**\n\n- CSV: Set Accept: text/csv (default)\n- Excel: Set Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\n ", "schema": { "type": "string" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- timestamp\n- messageId\n- userId\n- userName\n- teamId\n- teamName\n- entity\n- entityId\n- action\n- message\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: timestamp.", "schema": { "example": "+id", "type": "string" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "406": { "description": "Not acceptable", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "NotAcceptable", "status": 406, "title": "Supported formats: text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Export activity logs", "tags": [ "Activity Logs" ] } }, "/api/v3/operations": { "get": { "description": "Retrieves operation counts for an organization, optionally filtered by team, scenario, and/or package, with optional grouping by dimension.\n\n**Grouping:** Use the `groupby` parameter to break down operation counts by `team`, `scenario`, `package`, or `module`. When set, each time-period entry in the response includes a nested array broken down by the chosen group.\n\n**Date Range:** The `from` and `to` parameters define the time window. The maximum allowed range is 1 year. Results are automatically grouped by `day` or `month` depending on the range.", "operationId": "OperationsV3Controller_getOperations", "parameters": [ { "name": "from", "required": true, "in": "query", "description": "Start date in ISO 8601 format (UTC). Defines the beginning of the date range for operation counts.\n\n**Note:** Date range between `from` and `to` cannot exceed 1 year.", "schema": { "example": "2025-01-01T12:00:00.000Z", "type": "string" } }, { "name": "to", "required": true, "in": "query", "description": "End date in ISO 8601 format (UTC). Defines the end of the date range for operation counts.\n\n**Note:** Date range between `from` and `to` cannot exceed 1 year.", "schema": { "example": "2025-02-01T12:00:00.000Z", "type": "string" } }, { "name": "organizationId", "required": false, "in": "query", "deprecated": true, "description": "**Deprecated** — use the `x-organization-id` request header instead. Accepted for backward compatibility; will be removed in a future release.", "schema": { "example": 12345, "type": "number" } }, { "name": "teamId", "required": false, "in": "query", "description": "Filter results to a specific team. When provided, only operations for this team are returned.", "schema": { "example": 67890, "type": "number" } }, { "name": "scenarioId", "required": false, "in": "query", "description": "Filter results to a specific scenario.\n\n**Note:** Requires `teamId` to also be specified.", "schema": { "example": 11111, "type": "number" } }, { "name": "package", "required": false, "in": "query", "description": "Filter results to a specific package name.\n\n**Note:** Requires `scenarioId` to also be specified.", "schema": { "example": "workfront-workfront", "type": "string" } }, { "name": "groupby", "required": false, "in": "query", "description": "Group operation counts by a specific dimension. When set, each time-period entry in the response includes a nested array broken down by the chosen group.\n\n**Available Groups:**\n- `module` - Group by module name\n- `package` - Group by package name\n- `scenario` - Group by scenario ID\n- `team` - Group by team ID", "schema": { "enum": [ "module", "package", "scenario", "team" ], "type": "string" } }, { "name": "orderby", "required": false, "in": "query", "description": "Sort results by timestamp. Prefix with `+` for ascending or `-` for descending.\n\n**Values:**\n- `+timestamp` - Oldest first (ascending)\n- `-timestamp` - Newest first (descending)\n\n**Default:** Oldest first (`+timestamp`).", "schema": { "example": "-timestamp", "type": "string" } }, { "name": "property", "required": false, "in": "query", "description": "Filter results by operations count. When `groupby` is used, filters the nested arrays by their operations value.\n\n**Format:** `operations`\n\n**Operators:**\n- `==` equals\n- `!=` not equals\n- `>` greater than\n- `>=` greater than or equal to\n- `<` less than\n- `<=` less than or equal to", "schema": { "example": "operations>=100", "type": "string" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved operation counts", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "description": "Array of operation count data points, sorted by timestamp (see orderby when provided)", "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2025-01-15", "description": "Timestamp for this data point" }, "scenarios": { "description": "Operations grouped by scenario (present when grouped by scenario)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 12345, "description": "Scenario ID" }, "operations": { "type": "number", "example": 100, "description": "Number of operations for this scenario" } }, "required": [ "id", "operations" ] } }, "teams": { "description": "Operations grouped by team (present when grouped by team)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 200, "description": "Number of operations for this team" } }, "required": [ "id", "operations" ] } }, "packages": { "description": "Operations grouped by package (present when grouped by package)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "package-name", "description": "Package name" }, "operations": { "type": "number", "example": 50, "description": "Number of operations for this package" } }, "required": [ "name", "operations" ] } }, "modules": { "description": "Operations grouped by module (present when grouped by module)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "module-name", "description": "Module name" }, "operations": { "type": "number", "example": 75, "description": "Number of operations for this module" } }, "required": [ "name", "operations" ] } }, "operations": { "type": "number", "example": 500, "description": "Total operations count (present when no grouping is applied)" } }, "required": [ "timestamp" ] } }, "timeUnit": { "type": "string", "enum": [ "day", "month" ], "example": "day", "description": "Time unit used for grouping the results" }, "orderby": { "type": "string", "example": "-timestamp", "description": "Present when orderby was provided in the request; reflects how items are sorted by timestamp" } }, "required": [ "items", "timeUnit" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Validation failed", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg", "errors": [ "teamId must be a number conforming to the specified constraints" ] } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get operations count", "tags": [ "Operations" ] } }, "/api/v3/operations/summary": { "get": { "description": "Retrieves a summary of total operation counts for an organization, broken down by scenario and team. Use this endpoint to get a high-level overview of operation consumption without time-series data.\n\n**Date Range:** The `from` and `to` parameters define the time window for aggregation. The maximum allowed range is 1 year.", "operationId": "OperationsV3Controller_getSummaryByOrg", "parameters": [ { "name": "from", "required": true, "in": "query", "description": "Start date in ISO 8601 format (UTC). Defines the beginning of the date range for the summary.\n\n**Note:** Date range between `from` and `to` cannot exceed 1 year.", "schema": { "example": "2025-01-01T12:00:00.000Z", "type": "string" } }, { "name": "to", "required": true, "in": "query", "description": "End date in ISO 8601 format (UTC). Defines the end of the date range for the summary.\n\n**Note:** Date range between `from` and `to` cannot exceed 1 year.", "schema": { "example": "2025-02-01T12:00:00.000Z", "type": "string" } }, { "name": "organizationId", "required": false, "in": "query", "deprecated": true, "description": "**Deprecated** — use the `x-organization-id` request header instead. Accepted for backward compatibility; will be removed in a future release.", "schema": { "example": 12345, "type": "number" } }, { "name": "teamId", "required": false, "in": "query", "description": "Filter results to a specific team. When provided, only scenarios belonging to this team are included in the summary.", "schema": { "example": 67890, "type": "number" } }, { "name": "scenarioId", "required": false, "in": "query", "description": "Filter results to a specific scenario. Returns the operation count for this single scenario.", "schema": { "example": 11111, "type": "number" } }, { "name": "package", "required": false, "in": "query", "description": "Filter results to a specific package name.", "schema": { "example": "workfront-workfront", "type": "string" } }, { "name": "orderby", "required": false, "in": "query", "description": "Sort summary results by field. Prefix with `+` for ascending or `-` for descending.\n\n**Sortable Fields:**\n- `scenarioId` - Sort by scenario ID\n- `teamId` - Sort by team ID\n- `operations` - Sort by operation count\n\n**Default:** `-operations` (highest operation count first).", "schema": { "example": "-operations", "type": "string" } }, { "name": "property", "required": false, "in": "query", "description": "Filter scenarios by their total operations count within the specified date range.\n\n**Format:** `operations`\n\n**Operators:**\n- `==` equals\n- `!=` not equals\n- `>` greater than\n- `>=` greater than or equal to\n- `<` less than\n- `<=` less than or equal to", "schema": { "example": "operations>=100", "type": "string" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved operations summary", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "description": "Array of operation summaries by scenario and team", "type": "array", "items": { "type": "object", "properties": { "scenarioId": { "type": "number", "example": 12345, "description": "Scenario ID" }, "teamId": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 150, "description": "Number of operations for this scenario and team combination" } }, "required": [ "scenarioId", "teamId", "operations" ] } }, "totalOperations": { "type": "number", "example": 1500, "description": "Total sum of all operations across all scenarios and teams" }, "orderby": { "type": "string", "example": "-operations", "description": "Present when orderby was provided in the request; reflects how items are sorted" } }, "required": [ "items", "totalOperations" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Validation failed", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg", "errors": [ "teamId must be a number conforming to the specified constraints" ] } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get operations summary", "tags": [ "Operations" ] } }, "/api/v3/connections": { "get": { "description": "Returns a paginated, filterable list of scenarios in the organization. Supply `teamId` in the property query to restrict results to one team.", "operationId": "ConnectionsV3Controller_getConnections_v3", "parameters": [ { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- name\n- accountName\n- accountType\n- expire\n- teamId\n- scopesCount\n- editable\n- uid\n- environmentType\n- authenticationType\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, accountName, expire.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved paged connections", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of connection objects", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique connection ID.", "example": 10752 }, "name": { "type": "string", "description": "User-facing connection name.", "example": "My Workfront connection" }, "accountName": { "type": "string", "description": "Connector type identifier. Prefixed with `app#` for SDK-based connectors.", "example": "workfront-workfront" }, "accountLabel": { "type": "string", "description": "Human-readable connector label in the requested language.", "example": "Adobe Workfront auth" }, "accountType": { "type": "string", "description": "Auth mechanism of the connector (e.g. `oauth`, `basic`).", "example": "oauth" }, "expire": { "format": "date-time", "type": "string", "description": "OAuth token expiry timestamp. `null` for non-OAuth auth types.", "example": null, "nullable": true }, "metadata": { "type": "object", "description": "Arbitrary connection metadata stored at authorisation time.", "example": { "type": "text", "value": "John | my.workfront.com" }, "nullable": true }, "teamId": { "type": "number", "description": "ID of the team that owns this connection.", "example": 16496 }, "theme": { "type": "string", "description": "Hex colour used to render the connector icon.", "example": "#db492b" }, "scopesCount": { "type": "number", "description": "Number of OAuth scopes granted to this connection.", "example": 3 }, "scoped": { "type": "boolean", "description": "Whether the connection covers the requested OAuth scope set. Always `true` when no scope filter is applied.", "example": true }, "editable": { "type": "boolean", "description": "Whether the connector definition allows editing credentials.", "example": false }, "uid": { "type": "string", "description": "Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). `null` for non-OAuth connections.", "example": null, "nullable": true }, "environmentType": { "type": "string", "description": "Deployment environment of the connected account (e.g. `production`, `nonproduction`).", "example": "nonproduction", "nullable": true }, "authenticationType": { "type": "string", "description": "Authentication sub-type (e.g. `personalaccount`, `serviceaccount`).", "example": "personalaccount", "nullable": true }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the connection was first created.", "example": "2024-03-15T10:22:00.000Z" } }, "required": [ "id", "name", "accountName", "accountLabel", "teamId", "theme", "scopesCount", "scoped", "editable", "createdAt" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List connections", "tags": [ "Connections" ] } }, "/api/v3/connections/{connectionId}": { "get": { "description": "Returns the full details of a single connection", "operationId": "ConnectionsV3Controller_getConnectionDetails_v3", "parameters": [ { "name": "connectionId", "required": true, "in": "path", "description": "Connection ID", "schema": { "example": 12345, "type": "number" } } ], "responses": { "200": { "description": "Returns the connection details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique connection ID.", "example": 10752 }, "name": { "type": "string", "description": "User-facing connection name.", "example": "My Workfront connection" }, "accountName": { "type": "string", "description": "Connector type identifier. Prefixed with `app#` for SDK-based connectors.", "example": "workfront-workfront" }, "accountLabel": { "type": "string", "description": "Human-readable connector label in the requested language.", "example": "Adobe Workfront auth" }, "accountType": { "type": "string", "description": "Auth mechanism of the connector (e.g. `oauth`, `basic`).", "example": "oauth" }, "expire": { "format": "date-time", "type": "string", "description": "OAuth token expiry timestamp. `null` for non-OAuth auth types.", "example": null, "nullable": true }, "metadata": { "type": "object", "description": "Arbitrary connection metadata stored at authorisation time.", "example": { "type": "text", "value": "John | my.workfront.com" }, "nullable": true }, "teamId": { "type": "number", "description": "ID of the team that owns this connection.", "example": 16496 }, "theme": { "type": "string", "description": "Hex colour used to render the connector icon.", "example": "#db492b" }, "scopesCount": { "type": "number", "description": "Number of OAuth scopes granted to this connection.", "example": 3 }, "scoped": { "type": "boolean", "description": "Whether the connection covers the requested OAuth scope set. Always `true` when no scope filter is applied.", "example": true }, "editable": { "type": "boolean", "description": "Whether the connector definition allows editing credentials.", "example": false }, "uid": { "type": "string", "description": "Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). `null` for non-OAuth connections.", "example": null, "nullable": true }, "environmentType": { "type": "string", "description": "Deployment environment of the connected account (e.g. `production`, `nonproduction`).", "example": "nonproduction", "nullable": true }, "authenticationType": { "type": "string", "description": "Authentication sub-type (e.g. `personalaccount`, `serviceaccount`).", "example": "personalaccount", "nullable": true }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the connection was first created.", "example": "2024-03-15T10:22:00.000Z" }, "type": { "type": "string", "description": "Connector account type (e.g. `oauth`, `basic`, `apikey`).", "example": "oauth" }, "valid": { "type": "boolean", "description": "Whether the connection credentials are still valid (token not expired, not revoked).", "example": true }, "defaultScopes": { "description": "Default scope set defined by the connector, normalised to an array.", "example": [ "read:user" ], "type": "array", "items": { "type": "string" } }, "scopes": { "description": "Granted scopes for this connection: `id` matches the stored scope identifier; `name` comes from the connector manifest when defined.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Scope ID", "example": "offline_access" }, "name": { "type": "string", "description": "Display name from the scope", "example": "The app can access the data user has given permission to, even when user is not using the app\"", "nullable": true }, "account": { "type": "string", "description": "Account name for the connection", "example": "workfront-workfront" } }, "required": [ "id" ] } } }, "required": [ "id", "name", "accountName", "accountLabel", "teamId", "theme", "scopesCount", "scoped", "editable", "createdAt", "type", "valid", "defaultScopes", "scopes" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get connection by ID", "tags": [ "Connections" ] } }, "/api/v3/connections/{connectionId}/scenarios": { "get": { "description": "Returns a paginated list of scenarios that reference the given connection.", "operationId": "ConnectionsV3Controller_getConnectionScenarios_v3", "parameters": [ { "name": "connectionId", "required": true, "in": "path", "description": "Connection ID", "schema": { "example": 12345, "type": "number" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "Paginated list of scenarios that use this connection.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "description": "Array of scenario objects linked to the connection", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario ID.", "example": 123 } }, "required": [ "id" ] } }, "_page": { "description": "Page metadata for pagination control", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Links for pagination navigation", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] } }, "required": [ "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List scenarios for a connection", "tags": [ "Connections" ] } }, "/api/v3/hooks/{hookId}": { "get": { "description": "Returns the full details of a single hook, including its configuration data and external references. Use this endpoint when you need the complete hook payload — for example, to inspect event subscription data or verify the hook URL before triggering events.", "operationId": "HooksV3Controller_get_v3", "parameters": [ { "name": "hookId", "required": true, "in": "path", "description": "Numeric ID of the hook to retrieve.", "schema": { "example": 15473, "type": "number" } } ], "responses": { "200": { "description": "Hook details retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique numeric identifier for the hook.", "example": 15473 }, "name": { "type": "string", "description": "Display name of the hook, assigned when the hook is created.", "example": "My gateway-webhook webhook" }, "teamId": { "type": "number", "description": "ID of the team this hook belongs to.", "example": 12685 }, "udid": { "type": "string", "description": "Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.", "example": "e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "theme": { "type": "string", "description": "Hex color code used to visually identify the hook in the Fusion scenario builder.", "example": "#C73A63" }, "editable": { "type": "boolean", "description": "Indicates whether the hook configuration can be edited.", "example": false }, "queueCount": { "type": "number", "description": "Number of incoming events currently queued for processing.", "example": 0 }, "queueLimit": { "type": "number", "description": "Maximum number of events the queue can hold before new incoming events are rejected.", "example": 100000 }, "enabled": { "type": "boolean", "description": "Indicates whether the hook is active and accepting incoming events.", "example": true }, "gone": { "type": "boolean", "description": "When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.", "example": false }, "learning": { "type": "boolean", "description": "Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.", "example": false }, "typeName": { "type": "string", "description": "Type name that identifies the hook's integration. Workfront hooks begin with 'workfront-workfront' or 'workfront-maestro'.", "example": "gateway-webhook" }, "data": { "type": "object", "description": "Hook-specific configuration object. For Workfront hooks, this contains event subscription data. The shape varies by hook type.", "example": {} }, "scenarioId": { "type": "number", "description": "ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.", "example": 33723 }, "url": { "type": "string", "description": "The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.", "example": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "priority": { "type": "string", "description": "Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.", "example": "Low", "enum": [ "Low", "Medium", "High" ] }, "detached": { "type": "boolean", "description": "Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.", "example": false }, "connectionId": { "type": "number", "description": "ID of the connection associated with this hook. Present when the hook was created using a connection.", "example": 789, "nullable": true }, "automation": { "type": "object", "description": "Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.", "nullable": true } }, "required": [ "id", "name", "teamId", "udid", "theme", "editable", "queueCount", "queueLimit", "enabled", "gone", "learning", "typeName", "data", "priority", "detached" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get a hook by ID", "tags": [ "Hooks" ] } }, "/api/v3/hooks": { "get": { "description": "Returns a paginated list of hooks for the specified team.", "operationId": "HooksV3Controller_getWebhooks_v3", "parameters": [ { "name": "teamId", "required": true, "in": "query", "description": "ID of the team whose hooks you want to retrieve.", "schema": { "example": 12685, "type": "number" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- name\n- udid\n- type\n- enabled\n- gone\n- typeName\n- scenarioId\n- priority\n- detached\n- automationType\n- automationId\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, teamId, udid, type, priority.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "Paginated list of hooks matching the provided search criteria.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of hooks matching the search criteria.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique numeric identifier for the hook.", "example": 15473 }, "name": { "type": "string", "description": "Display name of the hook, assigned when the hook is created.", "example": "My gateway-webhook webhook" }, "teamId": { "type": "number", "description": "ID of the team this hook belongs to.", "example": 12685 }, "udid": { "type": "string", "description": "Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.", "example": "e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "theme": { "type": "string", "description": "Hex color code used to visually identify the hook in the Fusion scenario builder.", "example": "#C73A63" }, "editable": { "type": "boolean", "description": "Indicates whether the hook configuration can be edited.", "example": false }, "queueCount": { "type": "number", "description": "Number of incoming events currently queued for processing.", "example": 0 }, "queueLimit": { "type": "number", "description": "Maximum number of events the queue can hold before new incoming events are rejected.", "example": 100000 }, "enabled": { "type": "boolean", "description": "Indicates whether the hook is active and accepting incoming events.", "example": true }, "gone": { "type": "boolean", "description": "When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.", "example": false }, "learning": { "type": "boolean", "description": "Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.", "example": false }, "typeName": { "type": "string", "description": "Type name that identifies the hook's integration. Workfront hooks begin with 'workfront-workfront' or 'workfront-maestro'.", "example": "gateway-webhook" }, "scenarioId": { "type": "number", "description": "ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.", "example": 33723 }, "url": { "type": "string", "description": "The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.", "example": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "priority": { "type": "string", "description": "Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.", "example": "Low", "enum": [ "Low", "Medium", "High" ] }, "detached": { "type": "boolean", "description": "Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.", "example": false }, "connectionId": { "type": "number", "description": "ID of the connection associated with this hook. Present when the hook was created using a connection.", "example": 789, "nullable": true }, "automation": { "type": "object", "description": "Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.", "nullable": true } }, "required": [ "id", "name", "teamId", "udid", "theme", "editable", "queueCount", "queueLimit", "enabled", "gone", "learning", "typeName", "priority", "detached" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List and search hooks", "tags": [ "Hooks" ] } }, "/api/v3/data-stores": { "get": { "operationId": "DataStoresV3Controller_list_v3", "parameters": [ { "name": "teamId", "required": true, "in": "query", "description": "Team ID", "schema": { "minimum": 1, "example": 1, "type": "number" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- name\n- records\n- size\n- maxSize\n- datastructureId\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "example": "123", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, records, size, maxSize, datastructureId.", "schema": { "example": "+id", "type": "string" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Data stores for the requested team, including usage metrics per item", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 1, "description": "Unique numeric identifier of the data store" }, "name": { "type": "string", "example": "My Store", "description": "Name of the data store" }, "teamId": { "type": "number", "example": 100, "description": "ID of the team that owns this data store" }, "records": { "type": "number", "example": 42, "description": "Count of records stored in the data store" }, "size": { "type": "number", "example": 2097152, "description": "Current storage used by the data store, in bytes (e.g. 2097152 = 2 MiB)" }, "maxSize": { "type": "number", "example": 10485760, "description": "Maximum allowed storage capacity, in bytes (set via create/patch maxSizeMB × 1,048,576; e.g. 10485760 = 10 MiB)" }, "datastructureId": { "type": "number", "nullable": true, "example": 10, "description": "ID of the linked data structure (UDT); null when no structure is assigned" } } } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List data stores by team", "tags": [ "Data Stores" ] } }, "/api/v3/data-stores/{id}": { "get": { "description": "Returns data store metadata and usage metrics. Size fields are in bytes; record count is a unitless integer.", "operationId": "DataStoresV3Controller_getById_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Numeric ID of the data store to retrieve", "schema": { "example": 1, "type": "number" } }, { "name": "x-organization-id", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Data store metadata and usage metrics (records, size and maxSize in bytes)", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "example": 1, "description": "Unique numeric identifier of the data store" }, "name": { "type": "string", "example": "My Store", "description": "Name of the data store" }, "teamId": { "type": "number", "example": 100, "description": "ID of the team that owns this data store" }, "records": { "type": "number", "example": 42, "description": "Count of records stored in the data store" }, "size": { "type": "number", "example": 2097152, "description": "Current storage used by the data store, in bytes (e.g. 2097152 = 2 MiB)" }, "maxSize": { "type": "number", "example": 10485760, "description": "Maximum allowed storage capacity, in bytes (set via create/patch maxSizeMB × 1,048,576; e.g. 10485760 = 10 MiB)" }, "datastructureId": { "type": "number", "nullable": true, "example": 10, "description": "ID of the linked data structure (UDT); null when no structure is assigned" } } } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad request", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "ResourceNotFound", "status": 404, "title": "Resource not found", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get a single data store by ID", "tags": [ "Data Stores" ] } }, "/api/v3/logs": { "get": { "description": "Returns a paginated list of executions for the specified resource. To narrow results, filter by status — for example, use `property=status==3` to see failed executions or `property=status==2` to see executions that completed with warnings.", "operationId": "PublicLogController_getExecutions[1]_v3", "parameters": [ { "name": "scenarioId", "required": false, "in": "query", "description": "Scenario identifier. Mutually exclusive with dlqId.", "schema": { "type": "string" } }, { "name": "dlqId", "required": false, "in": "query", "description": "Incomplete execution (DLQ) identifier. Mutually exclusive with scenarioId.", "schema": { "type": "string" } }, { "name": "showCheckRuns", "required": false, "in": "query", "description": "Include small check-run executions", "schema": { "default": false, "type": "boolean" } }, { "name": "property", "required": false, "in": "query", "description": "```\nProperty filters. Can be repeated and are AND-ed together.\n\nAllowed fields:\n- id\n- status\n- timestamp\n- duration\n- bundles\n- operations\n- transfer\n\nSupported operators:\n- == (equals)\n- != (not equals)\n- > (greater than)\n- >= (greater than or equal)\n- < (less than)\n- <= (less than or equal)\n- ~ (case-insensitive regex match)\n\nSpecial cases:\n- field → field exists\n- !field → field does not exist\n```", "schema": { "example": [ "teamId==3849" ], "type": "array", "items": { "type": "string" } } }, { "name": "start", "required": false, "in": "query", "description": "Paging cursor. Must correspond to \"orderby\" field and used only when it is set.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of items to return. Must be a positive integer. Range 1–200." }, { "name": "orderby", "required": false, "in": "query", "description": "Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: timestamp, duration, bundles, operations.", "schema": { "example": "+id", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the execution. A 32-character lowercase string.", "example": "62672b87ce5a449dae743947962da8b7" }, "type": { "type": "string", "description": "How the execution was run. `auto` = scheduled/automatic run, `manual` = user-initiated run-once.", "enum": [ "auto", "manual" ], "example": "auto" }, "kind": { "type": "string", "description": "Type of entity this execution belongs to. `scenario` = automation scenario, `dlq` = incomplete execution.", "enum": [ "scenario", "dlq" ], "example": "scenario" }, "kindId": { "type": "string", "description": "Identifier of the parent entity referenced by `kind` (the scenario or DLQ id). Numeric id represented as a string.", "example": "87" }, "teamId": { "type": "number", "description": "Identifier of the team that owns the parent automation.", "example": 1 }, "organizationId": { "type": "number", "description": "Identifier of the organization that owns the execution.", "example": 1 }, "authorId": { "type": "number", "description": "Identifier of the user who authored/initiated the execution. Absent for fully automated runs with no acting user.", "example": 2555 }, "status": { "type": "number", "description": "Execution result status code: `0` running, `1` success, `2` warning, `3` error.", "enum": [ 0, 1, 2, 3 ], "example": 1 }, "timestamp": { "format": "date-time", "type": "string", "description": "Execution start time, as an ISO 8601 timestamp in UTC.", "example": "2024-02-14T21:08:51.961Z" }, "duration": { "type": "number", "description": "Total execution wall-clock time, in milliseconds.", "example": 233 }, "verifier": { "type": "boolean", "description": "True for manual runs, which are run to verify/test the automation; false for automatic runs.", "example": false }, "bundles": { "type": "number", "description": "Total number of data bundles processed across all modules during the execution.", "example": 1 }, "operations": { "type": "number", "description": "Total number of module operations performed during the execution.", "example": 2 }, "transfer": { "type": "number", "description": "Total amount of data transferred during the execution, in bytes.", "example": 17 }, "modules": { "description": "Per-module operation statistics. Each entry contains `package` (app/connector package), `module` (module name), and `operations` (operations performed by that module).", "example": [ { "package": "gateway", "module": "CustomWebHook", "operations": 1 }, { "package": "util", "module": "SetVariable2", "operations": 1 } ], "type": "array", "items": { "type": "array" } }, "processing": { "type": "boolean", "description": "True while the execution is still being processed; false once it has completed. Logs may be partial while this is true.", "example": false }, "config": { "type": "object", "description": "Scenario runtime configuration snapshot. Boolean flags: `dlq`, `instant`, `dataloss`, `listener`, `parallel`, `autoCommit`, `sequential`, `localAccess`, `confidential`. Numbers: `roundtrips`, `maxFileSize` (bytes), `timeout` (milliseconds).", "example": { "dlq": false, "instant": false, "dataloss": false, "listener": false, "parallel": true, "autoCommit": true, "roundtrips": 1, "sequential": false, "localAccess": false, "maxFileSize": 500000000, "confidential": false, "timeout": 2400000 } } }, "required": [ "id", "type", "kind", "kindId", "teamId", "organizationId", "authorId", "status", "timestamp", "duration", "verifier", "bundles", "operations", "transfer", "modules", "processing", "config" ] } } }, "required": [ "_page", "_links", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad Request: exactly one of scenarioId or dlqId is required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "List Executions", "tags": [ "Logs" ] } }, "/api/v3/logs/{executionId}": { "get": { "description": "Returns a summary of a single execution by its execution ID, including metadata about the object it belongs to.", "operationId": "PublicLogController_getExecutionById[1]_v3", "parameters": [ { "name": "executionId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "scenarioId", "required": false, "in": "query", "description": "Scenario identifier. Mutually exclusive with dlqId.", "schema": { "type": "string" } }, { "name": "dlqId", "required": false, "in": "query", "description": "Incomplete execution (DLQ) identifier. Mutually exclusive with scenarioId.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the Execution", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the execution. A 32-character lowercase string.", "example": "62672b87ce5a449dae743947962da8b7" }, "type": { "type": "string", "description": "How the execution was run. `auto` = scheduled/automatic run, `manual` = user-initiated run-once.", "enum": [ "auto", "manual" ], "example": "auto" }, "kind": { "type": "string", "description": "Type of entity this execution belongs to. `scenario` = automation scenario, `dlq` = incomplete execution.", "enum": [ "scenario", "dlq" ], "example": "scenario" }, "kindId": { "type": "string", "description": "Identifier of the parent entity referenced by `kind` (the scenario or DLQ id). Numeric id represented as a string.", "example": "87" }, "teamId": { "type": "number", "description": "Identifier of the team that owns the parent automation.", "example": 1 }, "organizationId": { "type": "number", "description": "Identifier of the organization that owns the execution.", "example": 1 }, "authorId": { "type": "number", "description": "Identifier of the user who authored/initiated the execution. Absent for fully automated runs with no acting user.", "example": 2555 }, "status": { "type": "number", "description": "Execution result status code: `0` running, `1` success, `2` warning, `3` error.", "enum": [ 0, 1, 2, 3 ], "example": 1 }, "timestamp": { "format": "date-time", "type": "string", "description": "Execution start time, as an ISO 8601 timestamp in UTC.", "example": "2024-02-14T21:08:51.961Z" }, "duration": { "type": "number", "description": "Total execution wall-clock time, in milliseconds.", "example": 233 }, "verifier": { "type": "boolean", "description": "True for manual runs, which are run to verify/test the automation; false for automatic runs.", "example": false }, "bundles": { "type": "number", "description": "Total number of data bundles processed across all modules during the execution.", "example": 1 }, "operations": { "type": "number", "description": "Total number of module operations performed during the execution.", "example": 2 }, "transfer": { "type": "number", "description": "Total amount of data transferred during the execution, in bytes.", "example": 17 }, "modules": { "description": "Per-module operation statistics. Each entry contains `package` (app/connector package), `module` (module name), and `operations` (operations performed by that module).", "example": [ { "package": "gateway", "module": "CustomWebHook", "operations": 1 }, { "package": "util", "module": "SetVariable2", "operations": 1 } ], "type": "array", "items": { "type": "array" } }, "processing": { "type": "boolean", "description": "True while the execution is still being processed; false once it has completed. Logs may be partial while this is true.", "example": false }, "config": { "type": "object", "description": "Scenario runtime configuration snapshot. Boolean flags: `dlq`, `instant`, `dataloss`, `listener`, `parallel`, `autoCommit`, `sequential`, `localAccess`, `confidential`. Numbers: `roundtrips`, `maxFileSize` (bytes), `timeout` (milliseconds).", "example": { "dlq": false, "instant": false, "dataloss": false, "listener": false, "parallel": true, "autoCommit": true, "roundtrips": 1, "sequential": false, "localAccess": false, "maxFileSize": 500000000, "confidential": false, "timeout": 2400000 } } }, "required": [ "id", "type", "kind", "kindId", "teamId", "organizationId", "authorId", "status", "timestamp", "duration", "verifier", "bundles", "operations", "transfer", "modules", "processing", "config" ] } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "BadRequest", "status": 400, "title": "Bad Request: exactly one of scenarioId or dlqId is required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "401": { "description": "Authentication required", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Unauthorized", "status": 401, "title": "Authentication required", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "403": { "description": "Access denied", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "Forbidden", "status": 403, "title": "Access denied", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } }, "500": { "description": "Server error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "example": { "type": "InternalServerError", "status": 500, "title": "Server error", "report": { "request-id": "abc-123-def-456", "x-gw-ims-org-id": "1234567890ABCDEF@AdobeOrg" } } } } } }, "security": [ { "Authorization": [], "API Key": [], "Organization ID": [], "Region": [] } ], "summary": "Get Execution", "tags": [ "Logs" ] } } }, "components": { "schemas": { "ErrorReportDto": { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] }, "ErrorResponseDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Error type based on HTTP status or validation error", "example": "BadRequest" }, "status": { "type": "number", "description": "HTTP status code", "example": 400, "minimum": 400, "maximum": 599 }, "title": { "type": "string", "description": "Human-readable error message", "examples": { "badRequest": { "value": "Invalid request" }, "unauthorized": { "value": "Authentication required" }, "forbidden": { "value": "Access denied" }, "notFound": { "value": "Resource not found" }, "serverError": { "value": "Server error" }, "validationError": { "value": "Validation failed" } } }, "report": { "description": "Error report with request tracking and additional details", "allOf": [ { "type": "object", "properties": { "request-id": { "type": "string", "description": "Request ID from headers or auto-generated UUID", "example": "req-123" }, "x-gw-ims-org-id": { "type": "string", "description": "Organization ID from headers", "example": "org-456" }, "errors": { "description": "Validation errors (only present for validation failures)", "example": [ "email must be a valid email address", "password must be at least 8 characters" ], "type": "array", "items": { "type": "object" } } }, "required": [ "request-id" ] } ] } }, "required": [ "type", "status", "title", "report" ] }, "ExportScenarioRecordDto": { "type": "object", "properties": { "scenarioId": { "type": "number", "description": "The ID of the exported scenario.", "example": 42 }, "name": { "type": "string", "description": "The name of the exported scenario.", "example": "My Firefly Scenario" }, "teamId": { "type": "number", "description": "The ID of the team that owns this scenario.", "example": 88 }, "folderId": { "type": "number", "description": "The ID of the folder the scenario belongs to, or `null` if it is not in any folder.", "example": null, "nullable": true }, "blueprint": { "type": "object", "description": "The full scenario blueprint — modules, connections, mappings, and settings exactly as configured.", "example": { "flow": [ { "id": 1, "mapper": { "n": "1", "style": { "imageReference": {} }, "locale": "en-US", "prompt": "ocean and pineapple cocktail", "extension": "default", "structure": { "imageReference": {} } }, "module": "adobe-firefly:generateAnImage2", "version": 1, "metadata": { "expect": [ { "name": "prompt", "type": "text", "label": "Prompt", "required": true }, { "name": "modelVersion", "type": "select", "label": "Model version", "validate": { "enum": [ "image3", "image3_custom", "image4_standard", "image4_ultra", "image4_custom" ] } }, { "name": "n", "type": "number", "label": "Number of variations" }, { "name": "extension", "type": "select", "label": "Generated image format", "required": true, "validate": { "enum": [ "jpeg", "png", "webp", "default" ] } }, { "name": "negativePrompt", "type": "text", "label": "Negative prompt" }, { "name": "contentClass", "type": "select", "label": "Content class", "validate": { "enum": [ "photo", "art" ] } }, { "name": "seeds", "type": "array", "label": "Seeds" }, { "name": "size", "type": "select", "label": "Size", "validate": { "enum": [ "2048,2048", "1024,1024", "2304,1792", "1792,2304", "2688,1536", "1344,768", "1152,896", "896,1152" ] } }, { "name": "visualIntensity", "type": "number", "label": "Visual intensity" }, { "name": "locale", "type": "text", "label": "Locale" }, { "name": "tileable", "type": "boolean", "label": "Tileable" }, { "name": "structure", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Structure" }, { "name": "style", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" }, { "name": "presets", "type": "array", "label": "Presets" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Style" } ], "restore": { "size": { "mode": "chose", "label": "" }, "seeds": { "mode": "chose", "items": [] }, "style": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" }, "presets": { "mode": "chose", "items": [] } } } } }, "tileable": { "mode": "chose" }, "extension": { "mode": "chose", "label": "Default" }, "structure": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" } } } } }, "connection": { "label": "My Adobe Firefly Connection connection" }, "contentClass": { "mode": "chose", "label": "" }, "modelVersion": { "mode": "chose", "label": "" } }, "designer": { "x": 0, "y": 0 }, "parameters": [ { "name": "connection", "type": "account", "label": "Connection", "required": true } ] }, "parameters": { "connection": 23252 } } ], "name": "Integration Adobe Firefly", "metadata": { "instant": false, "version": 1, "designer": { "orphans": [], "samples": { "1": { "data": "IMTBuffer(1032427, binary, 101231cde69182e66345b914ecf31f65d4141489): ffd8ffe000104a4649460001010000...", "details": { "url": "https://pre-signed-firefly-stage.s3-accelerate.amazonaws.com/images/ca17c73e-bf03-4c38-8a3d-29ac28f5...", "seed": 1663688808 }, "filename": "generated_result.jpeg..." } } }, "scenario": { "dlq": false, "dataloss": false, "maxErrors": 3, "autoCommit": true, "roundtrips": 1, "sequential": false, "confidential": false, "autoCommitTriggerLast": true } } } } }, "required": [ "scenarioId", "name", "teamId", "folderId", "blueprint" ] }, "ExportScenariosBodyDto": { "type": "object", "properties": { "scenarioIds": { "description": "One or more scenario IDs to export. Maximum 100 IDs per request.", "example": [ 1, 2, 3 ], "type": "array", "items": { "type": "number" } } }, "required": [ "scenarioIds" ] }, "ScenarioPublicBlueprintDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario identifier within the organization context.", "example": 123 }, "name": { "type": "string", "description": "Display name of the scenario.", "example": "Daily data sync" }, "teamId": { "type": "number", "description": "ID of the team that owns this scenario (maps to the team/company in Fusion).", "example": 88 }, "description": { "type": "string", "description": "Optional longer description shown in the UI.", "example": "Generate an image." }, "folderId": { "type": "number", "description": "Folder ID for organizing scenarios; omit if the scenario is not in a folder.", "example": 10 }, "usedPackages": { "description": "Identifiers of app packages or modules referenced by the scenario (for example integrations).", "example": [ "adobe-firefly" ], "type": "array", "items": { "type": "string" } }, "isInvalid": { "type": "boolean", "description": "True when the scenario is considered invalid (for example disabled after repeated errors).", "example": false }, "isActive": { "type": "boolean", "description": "Whether the scenario is linked and eligible to run.", "example": false }, "isLocked": { "type": "boolean", "description": "True while the scenario cannot be executed (for example still being configured).", "example": false }, "isPaused": { "type": "boolean", "description": "True when execution is paused after errors until the scenario is resumed.", "example": false }, "sequential": { "type": "boolean", "description": "Whether modules in the scenario run strictly in order (sequential execution).", "example": true }, "lastEdit": { "type": "string", "description": "ISO 8601 timestamp of the last modification to the scenario.", "example": "2026-03-05T15:20:00.000Z", "format": "date-time" }, "scheduling": { "type": "object", "description": "Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).", "example": { "time": "07:53", "type": "daily" } }, "hookId": { "type": "number", "description": "Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.", "example": 555 }, "blueprint": { "type": "object", "description": "Full automation blueprint: modules, flow, parameters, and metadata. Structure depends on the apps and modules in use.", "example": { "flow": [ { "id": 1, "mapper": { "n": "1", "style": { "imageReference": {} }, "locale": "en-US", "prompt": "ocean and pineapple cocktail", "extension": "default", "structure": { "imageReference": {} } }, "module": "adobe-firefly:generateAnImage2", "version": 1, "metadata": { "expect": [ { "name": "prompt", "type": "text", "label": "Prompt", "required": true }, { "name": "modelVersion", "type": "select", "label": "Model version", "validate": { "enum": [ "image3", "image3_custom", "image4_standard", "image4_ultra", "image4_custom" ] } }, { "name": "n", "type": "number", "label": "Number of variations" }, { "name": "extension", "type": "select", "label": "Generated image format", "required": true, "validate": { "enum": [ "jpeg", "png", "webp", "default" ] } }, { "name": "negativePrompt", "type": "text", "label": "Negative prompt" }, { "name": "contentClass", "type": "select", "label": "Content class", "validate": { "enum": [ "photo", "art" ] } }, { "name": "seeds", "type": "array", "label": "Seeds" }, { "name": "size", "type": "select", "label": "Size", "validate": { "enum": [ "2048,2048", "1024,1024", "2304,1792", "1792,2304", "2688,1536", "1344,768", "1152,896", "896,1152" ] } }, { "name": "visualIntensity", "type": "number", "label": "Visual intensity" }, { "name": "locale", "type": "text", "label": "Locale" }, { "name": "tileable", "type": "boolean", "label": "Tileable" }, { "name": "structure", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Structure" }, { "name": "style", "spec": [ { "name": "imageReference", "spec": [ { "name": "source", "type": "select", "label": "Source", "validate": { "enum": [ "file", "presignedUrl" ] } }, { "name": "strength", "type": "number", "label": "Strength" }, { "name": "presets", "type": "array", "label": "Presets" } ], "type": "collection", "label": "Image reference" } ], "type": "collection", "label": "Style" } ], "restore": { "size": { "mode": "chose", "label": "" }, "seeds": { "mode": "chose", "items": [] }, "style": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" }, "presets": { "mode": "chose", "items": [] } } } } }, "tileable": { "mode": "chose" }, "extension": { "mode": "chose", "label": "Default" }, "structure": { "nested": { "imageReference": { "nested": { "source": { "mode": "chose", "label": "" } } } } }, "connection": { "label": "My Adobe Firefly Connection connection" }, "contentClass": { "mode": "chose", "label": "" }, "modelVersion": { "mode": "chose", "label": "" } }, "designer": { "x": 0, "y": 0 }, "parameters": [ { "name": "connection", "type": "account", "label": "Connection", "required": true } ] }, "parameters": { "connection": 23252 } } ], "name": "Integration Adobe Firefly", "metadata": { "instant": false, "version": 1, "designer": { "orphans": [], "samples": { "1": { "data": "IMTBuffer(1032427, binary, 101231cde69182e66345b914ecf31f65d4141489): ffd8ffe000104a4649460001010000...", "details": { "url": "https://pre-signed-firefly-stage.s3-accelerate.amazonaws.com/images/ca17c73e-bf03-4c38-8a3d-29ac28f5...", "seed": 1663688808 }, "filename": "generated_result.jpeg..." } } }, "scenario": { "dlq": false, "dataloss": false, "maxErrors": 3, "autoCommit": true, "roundtrips": 1, "sequential": false, "confidential": false, "autoCommitTriggerLast": true } } } } }, "required": [ "id", "name", "teamId", "isInvalid", "isActive", "isLocked", "isPaused", "sequential", "blueprint" ] }, "PageMetadataDto": { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] }, "PageLinksDto": { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] }, "ScenarioBaseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario identifier within the organization context.", "example": 123 }, "name": { "type": "string", "description": "Display name of the scenario.", "example": "Daily data sync" }, "teamId": { "type": "number", "description": "ID of the team that owns this scenario (maps to the team/company in Fusion).", "example": 88 }, "description": { "type": "string", "description": "Optional longer description shown in the UI.", "example": "Generate an image." }, "folderId": { "type": "number", "description": "Folder ID for organizing scenarios; omit if the scenario is not in a folder.", "example": 10 }, "usedPackages": { "description": "Identifiers of app packages or modules referenced by the scenario (for example integrations).", "example": [ "adobe-firefly" ], "type": "array", "items": { "type": "string" } }, "isInvalid": { "type": "boolean", "description": "True when the scenario is considered invalid (for example disabled after repeated errors).", "example": false }, "isActive": { "type": "boolean", "description": "Whether the scenario is linked and eligible to run.", "example": false }, "isLocked": { "type": "boolean", "description": "True while the scenario cannot be executed (for example still being configured).", "example": false }, "isPaused": { "type": "boolean", "description": "True when execution is paused after errors until the scenario is resumed.", "example": false }, "sequential": { "type": "boolean", "description": "Whether modules in the scenario run strictly in order (sequential execution).", "example": true }, "lastEdit": { "type": "string", "description": "ISO 8601 timestamp of the last modification to the scenario.", "example": "2026-03-05T15:20:00.000Z", "format": "date-time" }, "scheduling": { "type": "object", "description": "Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).", "example": { "time": "07:53", "type": "daily" } }, "hookId": { "type": "number", "description": "Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.", "example": 555 } }, "required": [ "id", "name", "teamId", "isInvalid", "isActive", "isLocked", "isPaused", "sequential" ] }, "GetScenariosListResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of scenarios", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario identifier within the organization context.", "example": 123 }, "name": { "type": "string", "description": "Display name of the scenario.", "example": "Daily data sync" }, "teamId": { "type": "number", "description": "ID of the team that owns this scenario (maps to the team/company in Fusion).", "example": 88 }, "description": { "type": "string", "description": "Optional longer description shown in the UI.", "example": "Generate an image." }, "folderId": { "type": "number", "description": "Folder ID for organizing scenarios; omit if the scenario is not in a folder.", "example": 10 }, "usedPackages": { "description": "Identifiers of app packages or modules referenced by the scenario (for example integrations).", "example": [ "adobe-firefly" ], "type": "array", "items": { "type": "string" } }, "isInvalid": { "type": "boolean", "description": "True when the scenario is considered invalid (for example disabled after repeated errors).", "example": false }, "isActive": { "type": "boolean", "description": "Whether the scenario is linked and eligible to run.", "example": false }, "isLocked": { "type": "boolean", "description": "True while the scenario cannot be executed (for example still being configured).", "example": false }, "isPaused": { "type": "boolean", "description": "True when execution is paused after errors until the scenario is resumed.", "example": false }, "sequential": { "type": "boolean", "description": "Whether modules in the scenario run strictly in order (sequential execution).", "example": true }, "lastEdit": { "type": "string", "description": "ISO 8601 timestamp of the last modification to the scenario.", "example": "2026-03-05T15:20:00.000Z", "format": "date-time" }, "scheduling": { "type": "object", "description": "Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).", "example": { "time": "07:53", "type": "daily" } }, "hookId": { "type": "number", "description": "Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.", "example": 555 } }, "required": [ "id", "name", "teamId", "isInvalid", "isActive", "isLocked", "isPaused", "sequential" ] } } }, "required": [ "_page", "_links", "items" ] }, "ScenarioDependencyItemDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Dependency ID", "example": 1 }, "name": { "type": "string", "description": "Dependency name", "example": "Firefly connection" }, "kind": { "type": "string", "description": "Type of dependency", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ], "example": "connection" }, "type": { "type": "string", "description": "Optional subtype for hook, connection, and key", "example": "workfront-workfront" } }, "required": [ "id", "name", "kind" ] }, "ScenarioDependenciesResponseDto": { "type": "object", "properties": { "items": { "description": "List of scenario dependencies (connections, keys, data stores, hooks, and data structures)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Dependency ID", "example": 1 }, "name": { "type": "string", "description": "Dependency name", "example": "Firefly connection" }, "kind": { "type": "string", "description": "Type of dependency", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ], "example": "connection" }, "type": { "type": "string", "description": "Optional subtype for hook, connection, and key", "example": "workfront-workfront" } }, "required": [ "id", "name", "kind" ] } } }, "required": [ "items" ] }, "ReplacementDto": { "type": "object", "properties": { "kind": { "type": "string", "description": "Type of dependency to replace", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ] }, "sourceId": { "type": "number", "description": "Source dependency id (in the original scenario)", "example": 100 }, "targetId": { "type": "number", "description": "Target dependency id (replacement in the clone)", "example": 200 } }, "required": [ "kind", "sourceId", "targetId" ] }, "CloneScenarioRequestDto": { "type": "object", "properties": { "teamId": { "type": "number", "description": "Team ID where the cloned scenario will be created", "example": 88 }, "folderId": { "type": "number", "description": "Folder ID where the cloned scenario will be created", "example": 88 }, "name": { "type": "string", "description": "Name for the cloned scenario", "example": "My copied scenario", "maxLength": 255 }, "replacements": { "description": "Maps source dependencies to target resources in the new team", "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "description": "Type of dependency to replace", "enum": [ "hook", "dataStore", "dataStructure", "connection", "key" ] }, "sourceId": { "type": "number", "description": "Source dependency id (in the original scenario)", "example": 100 }, "targetId": { "type": "number", "description": "Target dependency id (replacement in the clone)", "example": 200 } }, "required": [ "kind", "sourceId", "targetId" ] } } }, "required": [ "teamId", "replacements" ] }, "CloneScenarioResponseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the newly created (cloned) scenario", "example": 456 } }, "required": [ "id" ] }, "FolderDto": { "type": "object", "properties": { "id": { "type": "number", "example": 501 }, "name": { "type": "string", "example": "Marketing automations" }, "scenariosTotal": { "type": "number", "description": "Number of scenarios in the folder", "example": 0 } }, "required": [ "id", "name", "scenariosTotal" ] }, "FoldersSearchResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 501 }, "name": { "type": "string", "example": "Marketing automations" }, "scenariosTotal": { "type": "number", "description": "Number of scenarios in the folder", "example": 0 } }, "required": [ "id", "name", "scenariosTotal" ] } } }, "required": [ "_page", "_links", "items" ] }, "CreateFolderRequestDto": { "type": "object", "properties": { "teamId": { "type": "number", "description": "Team that will own the folder", "example": 88 }, "name": { "type": "string", "description": "Display name of the folder", "example": "Marketing automations" } }, "required": [ "teamId", "name" ] }, "CreateFolderResponseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "ID of the created folder", "example": 501 } }, "required": [ "id" ] }, "UpdateFolderRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "New display name for the folder", "example": "Marketing automations" } }, "required": [ "name" ] }, "ActivityLog": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp when the activity occurred (UTC)", "example": "2025-12-09T11:39:34.834Z", "format": "date-time" }, "messageId": { "type": "string", "description": "Unique message identifier", "example": "5833b3d8-1215-4dc0-aa51-423a1993f7d1" }, "userId": { "type": "number", "description": "User ID who triggered the activity", "example": 2555 }, "userName": { "type": "string", "description": "User display name", "example": "John Snow" }, "teamId": { "type": "number", "description": "Team ID associated with the activity", "example": 34 }, "teamName": { "type": "string", "description": "Team name", "example": "My Team" }, "orgId": { "type": "number", "description": "Organization ID", "example": 2245 }, "entity": { "type": "string", "description": "Entity type that was affected", "enum": [ "team", "scenario", "webhook", "connection", "data structure", "data store", "organization", "folder", "user", "key", "keys" ], "example": "scenario" }, "entityId": { "type": "number", "description": "Entity ID related to the activity", "example": 38641 }, "action": { "type": "string", "description": "Action performed on the entity", "enum": [ "created", "deleted", "renamed", "disabled", "enabled", "deactivated", "reauthorized", "activated", "updated", "moved", "cloned", "invited", "transferred ownership", "changed organization role", "changed team role" ], "example": "updated" }, "message": { "type": "string", "description": "Human-readable activity message", "example": "John Snow updated \"Update Project tasks (Data Store Project)\" scenario" } }, "required": [ "timestamp", "messageId", "userId", "userName", "teamName", "orgId", "entity", "action", "message" ] }, "ActivityLogsResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of activity logs", "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp when the activity occurred (UTC)", "example": "2025-12-09T11:39:34.834Z", "format": "date-time" }, "messageId": { "type": "string", "description": "Unique message identifier", "example": "5833b3d8-1215-4dc0-aa51-423a1993f7d1" }, "userId": { "type": "number", "description": "User ID who triggered the activity", "example": 2555 }, "userName": { "type": "string", "description": "User display name", "example": "John Snow" }, "teamId": { "type": "number", "description": "Team ID associated with the activity", "example": 34 }, "teamName": { "type": "string", "description": "Team name", "example": "My Team" }, "orgId": { "type": "number", "description": "Organization ID", "example": 2245 }, "entity": { "type": "string", "description": "Entity type that was affected", "enum": [ "team", "scenario", "webhook", "connection", "data structure", "data store", "organization", "folder", "user", "key", "keys" ], "example": "scenario" }, "entityId": { "type": "number", "description": "Entity ID related to the activity", "example": 38641 }, "action": { "type": "string", "description": "Action performed on the entity", "enum": [ "created", "deleted", "renamed", "disabled", "enabled", "deactivated", "reauthorized", "activated", "updated", "moved", "cloned", "invited", "transferred ownership", "changed organization role", "changed team role" ], "example": "updated" }, "message": { "type": "string", "description": "Human-readable activity message", "example": "John Snow updated \"Update Project tasks (Data Store Project)\" scenario" } }, "required": [ "timestamp", "messageId", "userId", "userName", "teamName", "orgId", "entity", "action", "message" ] } } }, "required": [ "_page", "_links", "items" ] }, "ScenarioItemDto": { "type": "object", "properties": { "id": { "type": "number", "example": 12345, "description": "Scenario ID" }, "operations": { "type": "number", "example": 100, "description": "Number of operations for this scenario" } }, "required": [ "id", "operations" ] }, "TeamItemDto": { "type": "object", "properties": { "id": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 200, "description": "Number of operations for this team" } }, "required": [ "id", "operations" ] }, "PackageItemDto": { "type": "object", "properties": { "name": { "type": "string", "example": "package-name", "description": "Package name" }, "operations": { "type": "number", "example": 50, "description": "Number of operations for this package" } }, "required": [ "name", "operations" ] }, "ModuleItemDto": { "type": "object", "properties": { "name": { "type": "string", "example": "module-name", "description": "Module name" }, "operations": { "type": "number", "example": 75, "description": "Number of operations for this module" } }, "required": [ "name", "operations" ] }, "OperationsV3ItemDto": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2025-01-15", "description": "Timestamp for this data point" }, "scenarios": { "description": "Operations grouped by scenario (present when grouped by scenario)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 12345, "description": "Scenario ID" }, "operations": { "type": "number", "example": 100, "description": "Number of operations for this scenario" } }, "required": [ "id", "operations" ] } }, "teams": { "description": "Operations grouped by team (present when grouped by team)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 200, "description": "Number of operations for this team" } }, "required": [ "id", "operations" ] } }, "packages": { "description": "Operations grouped by package (present when grouped by package)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "package-name", "description": "Package name" }, "operations": { "type": "number", "example": 50, "description": "Number of operations for this package" } }, "required": [ "name", "operations" ] } }, "modules": { "description": "Operations grouped by module (present when grouped by module)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "module-name", "description": "Module name" }, "operations": { "type": "number", "example": 75, "description": "Number of operations for this module" } }, "required": [ "name", "operations" ] } }, "operations": { "type": "number", "example": 500, "description": "Total operations count (present when no grouping is applied)" } }, "required": [ "timestamp" ] }, "OperationsResponseV3Dto": { "type": "object", "properties": { "items": { "description": "Array of operation count data points, sorted by timestamp (see orderby when provided)", "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2025-01-15", "description": "Timestamp for this data point" }, "scenarios": { "description": "Operations grouped by scenario (present when grouped by scenario)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 12345, "description": "Scenario ID" }, "operations": { "type": "number", "example": 100, "description": "Number of operations for this scenario" } }, "required": [ "id", "operations" ] } }, "teams": { "description": "Operations grouped by team (present when grouped by team)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 200, "description": "Number of operations for this team" } }, "required": [ "id", "operations" ] } }, "packages": { "description": "Operations grouped by package (present when grouped by package)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "package-name", "description": "Package name" }, "operations": { "type": "number", "example": 50, "description": "Number of operations for this package" } }, "required": [ "name", "operations" ] } }, "modules": { "description": "Operations grouped by module (present when grouped by module)", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "module-name", "description": "Module name" }, "operations": { "type": "number", "example": 75, "description": "Number of operations for this module" } }, "required": [ "name", "operations" ] } }, "operations": { "type": "number", "example": 500, "description": "Total operations count (present when no grouping is applied)" } }, "required": [ "timestamp" ] } }, "timeUnit": { "type": "string", "enum": [ "day", "month" ], "example": "day", "description": "Time unit used for grouping the results" }, "orderby": { "type": "string", "example": "-timestamp", "description": "Present when orderby was provided in the request; reflects how items are sorted by timestamp" } }, "required": [ "items", "timeUnit" ] }, "OperationsV3SummaryItemDto": { "type": "object", "properties": { "scenarioId": { "type": "number", "example": 12345, "description": "Scenario ID" }, "teamId": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 150, "description": "Number of operations for this scenario and team combination" } }, "required": [ "scenarioId", "teamId", "operations" ] }, "OperationsV3SummaryResponseDto": { "type": "object", "properties": { "items": { "description": "Array of operation summaries by scenario and team", "type": "array", "items": { "type": "object", "properties": { "scenarioId": { "type": "number", "example": 12345, "description": "Scenario ID" }, "teamId": { "type": "number", "example": 67890, "description": "Team ID" }, "operations": { "type": "number", "example": 150, "description": "Number of operations for this scenario and team combination" } }, "required": [ "scenarioId", "teamId", "operations" ] } }, "totalOperations": { "type": "number", "example": 1500, "description": "Total sum of all operations across all scenarios and teams" }, "orderby": { "type": "string", "example": "-operations", "description": "Present when orderby was provided in the request; reflects how items are sorted" } }, "required": [ "items", "totalOperations" ] }, "ConnectionsV3ListItemDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique connection ID.", "example": 10752 }, "name": { "type": "string", "description": "User-facing connection name.", "example": "My Workfront connection" }, "accountName": { "type": "string", "description": "Connector type identifier. Prefixed with `app#` for SDK-based connectors.", "example": "workfront-workfront" }, "accountLabel": { "type": "string", "description": "Human-readable connector label in the requested language.", "example": "Adobe Workfront auth" }, "accountType": { "type": "string", "description": "Auth mechanism of the connector (e.g. `oauth`, `basic`).", "example": "oauth" }, "expire": { "format": "date-time", "type": "string", "description": "OAuth token expiry timestamp. `null` for non-OAuth auth types.", "example": null, "nullable": true }, "metadata": { "type": "object", "description": "Arbitrary connection metadata stored at authorisation time.", "example": { "type": "text", "value": "John | my.workfront.com" }, "nullable": true }, "teamId": { "type": "number", "description": "ID of the team that owns this connection.", "example": 16496 }, "theme": { "type": "string", "description": "Hex colour used to render the connector icon.", "example": "#db492b" }, "scopesCount": { "type": "number", "description": "Number of OAuth scopes granted to this connection.", "example": 3 }, "scoped": { "type": "boolean", "description": "Whether the connection covers the requested OAuth scope set. Always `true` when no scope filter is applied.", "example": true }, "editable": { "type": "boolean", "description": "Whether the connector definition allows editing credentials.", "example": false }, "uid": { "type": "string", "description": "Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). `null` for non-OAuth connections.", "example": null, "nullable": true }, "environmentType": { "type": "string", "description": "Deployment environment of the connected account (e.g. `production`, `nonproduction`).", "example": "nonproduction", "nullable": true }, "authenticationType": { "type": "string", "description": "Authentication sub-type (e.g. `personalaccount`, `serviceaccount`).", "example": "personalaccount", "nullable": true }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the connection was first created.", "example": "2024-03-15T10:22:00.000Z" } }, "required": [ "id", "name", "accountName", "accountLabel", "teamId", "theme", "scopesCount", "scoped", "editable", "createdAt" ] }, "GetConnectionsListResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of connection objects", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique connection ID.", "example": 10752 }, "name": { "type": "string", "description": "User-facing connection name.", "example": "My Workfront connection" }, "accountName": { "type": "string", "description": "Connector type identifier. Prefixed with `app#` for SDK-based connectors.", "example": "workfront-workfront" }, "accountLabel": { "type": "string", "description": "Human-readable connector label in the requested language.", "example": "Adobe Workfront auth" }, "accountType": { "type": "string", "description": "Auth mechanism of the connector (e.g. `oauth`, `basic`).", "example": "oauth" }, "expire": { "format": "date-time", "type": "string", "description": "OAuth token expiry timestamp. `null` for non-OAuth auth types.", "example": null, "nullable": true }, "metadata": { "type": "object", "description": "Arbitrary connection metadata stored at authorisation time.", "example": { "type": "text", "value": "John | my.workfront.com" }, "nullable": true }, "teamId": { "type": "number", "description": "ID of the team that owns this connection.", "example": 16496 }, "theme": { "type": "string", "description": "Hex colour used to render the connector icon.", "example": "#db492b" }, "scopesCount": { "type": "number", "description": "Number of OAuth scopes granted to this connection.", "example": 3 }, "scoped": { "type": "boolean", "description": "Whether the connection covers the requested OAuth scope set. Always `true` when no scope filter is applied.", "example": true }, "editable": { "type": "boolean", "description": "Whether the connector definition allows editing credentials.", "example": false }, "uid": { "type": "string", "description": "Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). `null` for non-OAuth connections.", "example": null, "nullable": true }, "environmentType": { "type": "string", "description": "Deployment environment of the connected account (e.g. `production`, `nonproduction`).", "example": "nonproduction", "nullable": true }, "authenticationType": { "type": "string", "description": "Authentication sub-type (e.g. `personalaccount`, `serviceaccount`).", "example": "personalaccount", "nullable": true }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the connection was first created.", "example": "2024-03-15T10:22:00.000Z" } }, "required": [ "id", "name", "accountName", "accountLabel", "teamId", "theme", "scopesCount", "scoped", "editable", "createdAt" ] } } }, "required": [ "_page", "_links", "items" ] }, "TeamAccountScopesDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Scope ID", "example": "offline_access" }, "name": { "type": "string", "description": "Display name from the scope", "example": "The app can access the data user has given permission to, even when user is not using the app\"", "nullable": true }, "account": { "type": "string", "description": "Account name for the connection", "example": "workfront-workfront" } }, "required": [ "id" ] }, "ConnectionDetailsV3Response": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique connection ID.", "example": 10752 }, "name": { "type": "string", "description": "User-facing connection name.", "example": "My Workfront connection" }, "accountName": { "type": "string", "description": "Connector type identifier. Prefixed with `app#` for SDK-based connectors.", "example": "workfront-workfront" }, "accountLabel": { "type": "string", "description": "Human-readable connector label in the requested language.", "example": "Adobe Workfront auth" }, "accountType": { "type": "string", "description": "Auth mechanism of the connector (e.g. `oauth`, `basic`).", "example": "oauth" }, "expire": { "format": "date-time", "type": "string", "description": "OAuth token expiry timestamp. `null` for non-OAuth auth types.", "example": null, "nullable": true }, "metadata": { "type": "object", "description": "Arbitrary connection metadata stored at authorisation time.", "example": { "type": "text", "value": "John | my.workfront.com" }, "nullable": true }, "teamId": { "type": "number", "description": "ID of the team that owns this connection.", "example": 16496 }, "theme": { "type": "string", "description": "Hex colour used to render the connector icon.", "example": "#db492b" }, "scopesCount": { "type": "number", "description": "Number of OAuth scopes granted to this connection.", "example": 3 }, "scoped": { "type": "boolean", "description": "Whether the connection covers the requested OAuth scope set. Always `true` when no scope filter is applied.", "example": true }, "editable": { "type": "boolean", "description": "Whether the connector definition allows editing credentials.", "example": false }, "uid": { "type": "string", "description": "Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). `null` for non-OAuth connections.", "example": null, "nullable": true }, "environmentType": { "type": "string", "description": "Deployment environment of the connected account (e.g. `production`, `nonproduction`).", "example": "nonproduction", "nullable": true }, "authenticationType": { "type": "string", "description": "Authentication sub-type (e.g. `personalaccount`, `serviceaccount`).", "example": "personalaccount", "nullable": true }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the connection was first created.", "example": "2024-03-15T10:22:00.000Z" }, "type": { "type": "string", "description": "Connector account type (e.g. `oauth`, `basic`, `apikey`).", "example": "oauth" }, "valid": { "type": "boolean", "description": "Whether the connection credentials are still valid (token not expired, not revoked).", "example": true }, "defaultScopes": { "description": "Default scope set defined by the connector, normalised to an array.", "example": [ "read:user" ], "type": "array", "items": { "type": "string" } }, "scopes": { "description": "Granted scopes for this connection: `id` matches the stored scope identifier; `name` comes from the connector manifest when defined.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Scope ID", "example": "offline_access" }, "name": { "type": "string", "description": "Display name from the scope", "example": "The app can access the data user has given permission to, even when user is not using the app\"", "nullable": true }, "account": { "type": "string", "description": "Account name for the connection", "example": "workfront-workfront" } }, "required": [ "id" ] } } }, "required": [ "id", "name", "accountName", "accountLabel", "teamId", "theme", "scopesCount", "scoped", "editable", "createdAt", "type", "valid", "defaultScopes", "scopes" ] }, "ConnectionScenarioV3Dto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario ID.", "example": 123 } }, "required": [ "id" ] }, "ConnectionScenariosV3Response": { "type": "object", "properties": { "items": { "description": "Array of scenario objects linked to the connection", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique scenario ID.", "example": 123 } }, "required": [ "id" ] } }, "_page": { "description": "Page metadata for pagination control", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Links for pagination navigation", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] } }, "required": [ "items" ] }, "HookV3Dto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique numeric identifier for the hook.", "example": 15473 }, "name": { "type": "string", "description": "Display name of the hook, assigned when the hook is created.", "example": "My gateway-webhook webhook" }, "teamId": { "type": "number", "description": "ID of the team this hook belongs to.", "example": 12685 }, "udid": { "type": "string", "description": "Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.", "example": "e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "theme": { "type": "string", "description": "Hex color code used to visually identify the hook in the Fusion scenario builder.", "example": "#C73A63" }, "editable": { "type": "boolean", "description": "Indicates whether the hook configuration can be edited.", "example": false }, "queueCount": { "type": "number", "description": "Number of incoming events currently queued for processing.", "example": 0 }, "queueLimit": { "type": "number", "description": "Maximum number of events the queue can hold before new incoming events are rejected.", "example": 100000 }, "enabled": { "type": "boolean", "description": "Indicates whether the hook is active and accepting incoming events.", "example": true }, "gone": { "type": "boolean", "description": "When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.", "example": false }, "learning": { "type": "boolean", "description": "Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.", "example": false }, "typeName": { "type": "string", "description": "Type name that identifies the hook's integration. Workfront hooks begin with 'workfront-workfront' or 'workfront-maestro'.", "example": "gateway-webhook" }, "data": { "type": "object", "description": "Hook-specific configuration object. For Workfront hooks, this contains event subscription data. The shape varies by hook type.", "example": {} }, "scenarioId": { "type": "number", "description": "ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.", "example": 33723 }, "url": { "type": "string", "description": "The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.", "example": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "priority": { "type": "string", "description": "Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.", "example": "Low", "enum": [ "Low", "Medium", "High" ] }, "detached": { "type": "boolean", "description": "Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.", "example": false }, "connectionId": { "type": "number", "description": "ID of the connection associated with this hook. Present when the hook was created using a connection.", "example": 789, "nullable": true }, "automation": { "type": "object", "description": "Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.", "nullable": true } }, "required": [ "id", "name", "teamId", "udid", "theme", "editable", "queueCount", "queueLimit", "enabled", "gone", "learning", "typeName", "data", "priority", "detached" ] }, "HookV3ListDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique numeric identifier for the hook.", "example": 15473 }, "name": { "type": "string", "description": "Display name of the hook, assigned when the hook is created.", "example": "My gateway-webhook webhook" }, "teamId": { "type": "number", "description": "ID of the team this hook belongs to.", "example": 12685 }, "udid": { "type": "string", "description": "Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.", "example": "e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "theme": { "type": "string", "description": "Hex color code used to visually identify the hook in the Fusion scenario builder.", "example": "#C73A63" }, "editable": { "type": "boolean", "description": "Indicates whether the hook configuration can be edited.", "example": false }, "queueCount": { "type": "number", "description": "Number of incoming events currently queued for processing.", "example": 0 }, "queueLimit": { "type": "number", "description": "Maximum number of events the queue can hold before new incoming events are rejected.", "example": 100000 }, "enabled": { "type": "boolean", "description": "Indicates whether the hook is active and accepting incoming events.", "example": true }, "gone": { "type": "boolean", "description": "When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.", "example": false }, "learning": { "type": "boolean", "description": "Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.", "example": false }, "typeName": { "type": "string", "description": "Type name that identifies the hook's integration. Workfront hooks begin with 'workfront-workfront' or 'workfront-maestro'.", "example": "gateway-webhook" }, "scenarioId": { "type": "number", "description": "ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.", "example": 33723 }, "url": { "type": "string", "description": "The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.", "example": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "priority": { "type": "string", "description": "Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.", "example": "Low", "enum": [ "Low", "Medium", "High" ] }, "detached": { "type": "boolean", "description": "Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.", "example": false }, "connectionId": { "type": "number", "description": "ID of the connection associated with this hook. Present when the hook was created using a connection.", "example": 789, "nullable": true }, "automation": { "type": "object", "description": "Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.", "nullable": true } }, "required": [ "id", "name", "teamId", "udid", "theme", "editable", "queueCount", "queueLimit", "enabled", "gone", "learning", "typeName", "priority", "detached" ] }, "GetHooksListResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Array of hooks matching the search criteria.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique numeric identifier for the hook.", "example": 15473 }, "name": { "type": "string", "description": "Display name of the hook, assigned when the hook is created.", "example": "My gateway-webhook webhook" }, "teamId": { "type": "number", "description": "ID of the team this hook belongs to.", "example": 12685 }, "udid": { "type": "string", "description": "Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.", "example": "e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "theme": { "type": "string", "description": "Hex color code used to visually identify the hook in the Fusion scenario builder.", "example": "#C73A63" }, "editable": { "type": "boolean", "description": "Indicates whether the hook configuration can be edited.", "example": false }, "queueCount": { "type": "number", "description": "Number of incoming events currently queued for processing.", "example": 0 }, "queueLimit": { "type": "number", "description": "Maximum number of events the queue can hold before new incoming events are rejected.", "example": 100000 }, "enabled": { "type": "boolean", "description": "Indicates whether the hook is active and accepting incoming events.", "example": true }, "gone": { "type": "boolean", "description": "When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.", "example": false }, "learning": { "type": "boolean", "description": "Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.", "example": false }, "typeName": { "type": "string", "description": "Type name that identifies the hook's integration. Workfront hooks begin with 'workfront-workfront' or 'workfront-maestro'.", "example": "gateway-webhook" }, "scenarioId": { "type": "number", "description": "ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.", "example": 33723 }, "url": { "type": "string", "description": "The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.", "example": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20" }, "priority": { "type": "string", "description": "Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.", "example": "Low", "enum": [ "Low", "Medium", "High" ] }, "detached": { "type": "boolean", "description": "Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.", "example": false }, "connectionId": { "type": "number", "description": "ID of the connection associated with this hook. Present when the hook was created using a connection.", "example": 789, "nullable": true }, "automation": { "type": "object", "description": "Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.", "nullable": true } }, "required": [ "id", "name", "teamId", "udid", "theme", "editable", "queueCount", "queueLimit", "enabled", "gone", "learning", "typeName", "priority", "detached" ] } } }, "required": [ "_page", "_links", "items" ] }, "DataStoreListItemResponseV3Dto": { "type": "object", "properties": { "id": { "type": "number", "example": 1, "description": "Unique numeric identifier of the data store" }, "name": { "type": "string", "example": "My Store", "description": "Name of the data store" }, "teamId": { "type": "number", "example": 100, "description": "ID of the team that owns this data store" }, "records": { "type": "number", "example": 42, "description": "Count of records stored in the data store" }, "size": { "type": "number", "example": 2097152, "description": "Current storage used by the data store, in bytes (e.g. 2097152 = 2 MiB)" }, "maxSize": { "type": "number", "example": 10485760, "description": "Maximum allowed storage capacity, in bytes (set via create/patch maxSizeMB × 1,048,576; e.g. 10485760 = 10 MiB)" }, "datastructureId": { "type": "number", "nullable": true, "example": 10, "description": "ID of the linked data structure (UDT); null when no structure is assigned" } } }, "DataStoreListSearchResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "description": "Data stores for the requested team, including usage metrics per item", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "example": 1, "description": "Unique numeric identifier of the data store" }, "name": { "type": "string", "example": "My Store", "description": "Name of the data store" }, "teamId": { "type": "number", "example": 100, "description": "ID of the team that owns this data store" }, "records": { "type": "number", "example": 42, "description": "Count of records stored in the data store" }, "size": { "type": "number", "example": 2097152, "description": "Current storage used by the data store, in bytes (e.g. 2097152 = 2 MiB)" }, "maxSize": { "type": "number", "example": 10485760, "description": "Maximum allowed storage capacity, in bytes (set via create/patch maxSizeMB × 1,048,576; e.g. 10485760 = 10 MiB)" }, "datastructureId": { "type": "number", "nullable": true, "example": 10, "description": "ID of the linked data structure (UDT); null when no structure is assigned" } } } } }, "required": [ "_page", "_links", "items" ] }, "ExecutionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the execution. A 32-character lowercase string.", "example": "62672b87ce5a449dae743947962da8b7" }, "type": { "type": "string", "description": "How the execution was run. `auto` = scheduled/automatic run, `manual` = user-initiated run-once.", "enum": [ "auto", "manual" ], "example": "auto" }, "kind": { "type": "string", "description": "Type of entity this execution belongs to. `scenario` = automation scenario, `dlq` = incomplete execution.", "enum": [ "scenario", "dlq" ], "example": "scenario" }, "kindId": { "type": "string", "description": "Identifier of the parent entity referenced by `kind` (the scenario or DLQ id). Numeric id represented as a string.", "example": "87" }, "teamId": { "type": "number", "description": "Identifier of the team that owns the parent automation.", "example": 1 }, "organizationId": { "type": "number", "description": "Identifier of the organization that owns the execution.", "example": 1 }, "authorId": { "type": "number", "description": "Identifier of the user who authored/initiated the execution. Absent for fully automated runs with no acting user.", "example": 2555 }, "status": { "type": "number", "description": "Execution result status code: `0` running, `1` success, `2` warning, `3` error.", "enum": [ 0, 1, 2, 3 ], "example": 1 }, "timestamp": { "format": "date-time", "type": "string", "description": "Execution start time, as an ISO 8601 timestamp in UTC.", "example": "2024-02-14T21:08:51.961Z" }, "duration": { "type": "number", "description": "Total execution wall-clock time, in milliseconds.", "example": 233 }, "verifier": { "type": "boolean", "description": "True for manual runs, which are run to verify/test the automation; false for automatic runs.", "example": false }, "bundles": { "type": "number", "description": "Total number of data bundles processed across all modules during the execution.", "example": 1 }, "operations": { "type": "number", "description": "Total number of module operations performed during the execution.", "example": 2 }, "transfer": { "type": "number", "description": "Total amount of data transferred during the execution, in bytes.", "example": 17 }, "modules": { "description": "Per-module operation statistics. Each entry contains `package` (app/connector package), `module` (module name), and `operations` (operations performed by that module).", "example": [ { "package": "gateway", "module": "CustomWebHook", "operations": 1 }, { "package": "util", "module": "SetVariable2", "operations": 1 } ], "type": "array", "items": { "type": "array" } }, "processing": { "type": "boolean", "description": "True while the execution is still being processed; false once it has completed. Logs may be partial while this is true.", "example": false }, "config": { "type": "object", "description": "Scenario runtime configuration snapshot. Boolean flags: `dlq`, `instant`, `dataloss`, `listener`, `parallel`, `autoCommit`, `sequential`, `localAccess`, `confidential`. Numbers: `roundtrips`, `maxFileSize` (bytes), `timeout` (milliseconds).", "example": { "dlq": false, "instant": false, "dataloss": false, "listener": false, "parallel": true, "autoCommit": true, "roundtrips": 1, "sequential": false, "localAccess": false, "maxFileSize": 500000000, "confidential": false, "timeout": 2400000 } } }, "required": [ "id", "type", "kind", "kindId", "teamId", "organizationId", "authorId", "status", "timestamp", "duration", "verifier", "bundles", "operations", "transfer", "modules", "processing", "config" ] }, "ExecutionSearchResponseDto": { "type": "object", "properties": { "_page": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "orderby": { "type": "string", "description": "Sort order expression", "example": "+id" }, "start": { "type": "string", "description": "Cursor value of the first item in the current page", "example": "123" }, "next": { "type": "string", "description": "Cursor value for retrieving the next page", "example": "124" }, "property": { "description": "Applied `property` filter expression(s) from the request", "example": [ "teamId==304" ], "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "description": "Resource type filter" }, "count": { "type": "number", "description": "Number of items in the current page", "example": 100 } }, "required": [ "count" ] } ] }, "_links": { "description": "Pagination links", "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "URL to the next page of results", "example": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304" }, "page": { "type": "string", "description": "URI template for pagination", "example": "/v3/{{resource}}{?orderby,start,limit,property,type}" } }, "required": [ "page" ] } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the execution. A 32-character lowercase string.", "example": "62672b87ce5a449dae743947962da8b7" }, "type": { "type": "string", "description": "How the execution was run. `auto` = scheduled/automatic run, `manual` = user-initiated run-once.", "enum": [ "auto", "manual" ], "example": "auto" }, "kind": { "type": "string", "description": "Type of entity this execution belongs to. `scenario` = automation scenario, `dlq` = incomplete execution.", "enum": [ "scenario", "dlq" ], "example": "scenario" }, "kindId": { "type": "string", "description": "Identifier of the parent entity referenced by `kind` (the scenario or DLQ id). Numeric id represented as a string.", "example": "87" }, "teamId": { "type": "number", "description": "Identifier of the team that owns the parent automation.", "example": 1 }, "organizationId": { "type": "number", "description": "Identifier of the organization that owns the execution.", "example": 1 }, "authorId": { "type": "number", "description": "Identifier of the user who authored/initiated the execution. Absent for fully automated runs with no acting user.", "example": 2555 }, "status": { "type": "number", "description": "Execution result status code: `0` running, `1` success, `2` warning, `3` error.", "enum": [ 0, 1, 2, 3 ], "example": 1 }, "timestamp": { "format": "date-time", "type": "string", "description": "Execution start time, as an ISO 8601 timestamp in UTC.", "example": "2024-02-14T21:08:51.961Z" }, "duration": { "type": "number", "description": "Total execution wall-clock time, in milliseconds.", "example": 233 }, "verifier": { "type": "boolean", "description": "True for manual runs, which are run to verify/test the automation; false for automatic runs.", "example": false }, "bundles": { "type": "number", "description": "Total number of data bundles processed across all modules during the execution.", "example": 1 }, "operations": { "type": "number", "description": "Total number of module operations performed during the execution.", "example": 2 }, "transfer": { "type": "number", "description": "Total amount of data transferred during the execution, in bytes.", "example": 17 }, "modules": { "description": "Per-module operation statistics. Each entry contains `package` (app/connector package), `module` (module name), and `operations` (operations performed by that module).", "example": [ { "package": "gateway", "module": "CustomWebHook", "operations": 1 }, { "package": "util", "module": "SetVariable2", "operations": 1 } ], "type": "array", "items": { "type": "array" } }, "processing": { "type": "boolean", "description": "True while the execution is still being processed; false once it has completed. Logs may be partial while this is true.", "example": false }, "config": { "type": "object", "description": "Scenario runtime configuration snapshot. Boolean flags: `dlq`, `instant`, `dataloss`, `listener`, `parallel`, `autoCommit`, `sequential`, `localAccess`, `confidential`. Numbers: `roundtrips`, `maxFileSize` (bytes), `timeout` (milliseconds).", "example": { "dlq": false, "instant": false, "dataloss": false, "listener": false, "parallel": true, "autoCommit": true, "roundtrips": 1, "sequential": false, "localAccess": false, "maxFileSize": 500000000, "confidential": false, "timeout": 2400000 } } }, "required": [ "id", "type", "kind", "kindId", "teamId", "organizationId", "authorId", "status", "timestamp", "duration", "verifier", "bundles", "operations", "transfer", "modules", "processing", "config" ] } } }, "required": [ "_page", "_links", "items" ] } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "**Required.** IMS access token for authenticating the user or technical account making the request.\n\nSee the [Authentication guide](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/authentication/) for detailed instructions on obtaining access tokens.\n\n[API Headers Documentation](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/api_headers/)\n" }, "Organization ID": { "type": "apiKey", "in": "header", "name": "x-organization-id", "description": "**Required.** Your Fusion Organization ID. Must be a number. Scopes all requests to your specific Fusion organization. You can find this ID in the Fusion Org Overview page URL: `/organization/{organizationId}/dashboard`.\n\n**Example:** `12345`\n\n[API Headers Documentation](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/api_headers/)\n" }, "API Key": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "**Required.** Your application's Client ID from Adobe Developer Console. This identifies your application and is the same value used for IMS authentication.\n\n[API Headers Documentation](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/api_headers/)\n" }, "Region": { "type": "apiKey", "in": "header", "name": "x-gw-region", "description": "**Required.** Routes requests to the correct Fusion regional instance.\n\n**Example:** `or2`\n\n[API Headers Documentation](https://developer-stage.adobe.com/workfront-fusion-apis/getting-started/api_headers/)\n" } } }, "x-tagGroups": [ { "name": "Public", "tags": [ "Public Logs Endpoint" ] } ] }