Adobe Suite

Adobe Suite Externaldocument API

The Externaldocument API from Adobe Suite — 10 operation(s) for externaldocument.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /externaldocument/search Search external document records with filters · Search of externaldocument #
Ask an LLM
“How do I query Workfront's external document records using filter conditions?”
“Can I page and pick fields when searching external document objects?”
Tell an agent
Search external document records where {filters}.
Find external document objects matching {filters} returning {fields}.
PUT /externaldocument/browseListWithLinkAction Browse a document provider with a link action · External document browse list with link action #
Ask an LLM
“Can I browse a connected document provider's files while preparing a link action?”
“How do I load breadcrumbs while browsing an external provider for linking?”
Tell an agent
Browse provider {documentProviderID} of type {providerType} for link action {linkAction}.
Browse {providerType} with {searchParams} and loadBreadcrumbs={loadBreadcrumbs} for linking.
PUT /externaldocument/getDocumentDownloadUrl Get a download URL for an external document · External document get document download url #
Ask an LLM
“How do I get a download link for a file stored in a connected document provider?”
“Can I get a URL to open an external document rather than download it?”
Tell an agent
Get the download URL for document {documentID} in provider {documentProviderID}.
Get an open link (isOpen={isOpen}) for {providerType} document {documentID}.
PUT /externaldocument/getRootFolderID Get the root folder ID from a document provider · External document get root folder ID #
Ask an LLM
“How do I find the root folder of a connected external document provider?”
“What is the top-level folder ID for my linked storage provider?”
Tell an agent
Get the root folder ID for provider {documentProviderID} of type {providerType}.
Look up the top folder in {providerType} storage.
PUT /externaldocument/getRootFolderIDFromDB Get a provider's stored root folder ID · External document get root folder ID from DB #
Ask an LLM
“Can I read the root folder ID Workfront already has saved for a document provider?”
“Where is the cached root folder for a provider stored?”
Tell an agent
Get the saved root folder ID for provider {documentProviderID} from the database.
Read the stored root folder of document provider {documentProviderID}.
PUT /externaldocument/linkExternalDocumentObjects Link external documents to a Workfront object · External document link external document objects #
Ask an LLM
“How do I attach files from a connected storage provider to a project or task?”
“Can I link external documents into a specific destination folder with proofing options?”
Tell an agent
Link {objects} from provider {documentProviderID} to {refObjCode} {refObjID}.
Link external documents to {refObjCode} {refObjID} into folder {destFolderID}.
PUT /externaldocument/setLinkedFolderMetadata Set metadata for a linked external folder · External document set linked folder metadata #
Ask an LLM
“How do I tie an external storage folder to a project as its linked folder?”
“Can I update the linked folder metadata for a document provider?”
Tell an agent
Set linked folder {externalStorageID} for project {projectID} on provider {documentProviderID}.
Save linked folder metadata for {providerType} folder {externalStorageID}.
GET /externaldocument/browseList Browse files in an external document provider · Get external document browse list #
Ask an LLM
“How do I list the files and folders in a connected storage provider?”
“Can I filter what shows up when browsing an external provider?”
Tell an agent
Browse files in provider {documentProviderID}.
Browse {providerType} with search params {searchParams}.
GET /externaldocument/getFolderMetaData Get metadata for an external folder · Get external document get folder meta data #
Ask an LLM
“How do I get details about a specific folder in a connected document provider?”
“Can I check folder metadata for a folder linked to a project?”
Tell an agent
Get metadata for folder {folderID} in provider {documentProviderID}.
Show linked-folder metadata for {providerType} folder {folderID} (isForLinkedFolder={isForLinkedFolder}).
GET /externaldocument/searchExternalDocuments Search files inside an external storage provider · Get external document search external documents #
Ask an LLM
“How do I search for a file by name inside my connected cloud storage?”
“Can I limit a provider file search to one folder?”
Tell an agent
Search provider {documentProviderID} for files named {searchString}.
Search {providerType} folder {searchInFolder} for {searchString}, {limit} at a time.

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-externaldocument-api-openapi.yml

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/adobe-suite:adobe-suite-externaldocument-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-suite-externaldocument-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Adobe Workfront Externaldocument API
  version: v19.0
servers:
- url: https://{domain}.my.workfront.com/attask/api/v19.0
  description: Production environment
- url: https://{domain}.preview.workfront.com/attask/api/v19.0
  description: Preview environment
security:
- ApiKeyHeader: []
- SessionIDHeader: []
- AtTaskCookie: []
- WFAuthCookie: []
tags:
- name: Externaldocument
paths:
  /externaldocument/search:
    get:
      summary: Search of externaldocument
      operationId: searchExternalDocuments
      parameters:
      - name: filters
        in: query
        description: JSON representing the filtering conditions
        required: false
        content:
          application/json:
            schema:
              type: object
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      - name: listOptions
        in: query
        description: JSON object defining the list options
        required: false
        content:
          application/json:
            schema:
              $ref: ./ListOptions.json
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: ./ExternalDocument.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
  /externaldocument/browseListWithLinkAction:
    summary: browseListWithLinkAction
    put:
      operationId: externalDocumentBrowseListWithLinkAction
      parameters:
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: searchParams
        in: query
        description: searchParams
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
      - name: loadBreadcrumbs
        in: query
        description: loadBreadcrumbs
        required: false
        schema:
          type: boolean
      - name: linkAction
        in: query
        description: linkAction
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document browse list with link action
      x-summary-source: derived
  /externaldocument/getDocumentDownloadUrl:
    summary: getDocumentDownloadUrl
    put:
      operationId: externalDocumentGetDocumentDownloadUrl
      parameters:
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: documentID
        in: query
        description: documentID
        required: false
        schema:
          type: string
      - name: isOpen
        in: query
        description: isOpen
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: string
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document get document download url
      x-summary-source: derived
  /externaldocument/getRootFolderID:
    summary: getRootFolderID
    put:
      operationId: externalDocumentGetRootFolderID
      parameters:
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: string
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document get root folder ID
      x-summary-source: derived
  /externaldocument/getRootFolderIDFromDB:
    summary: getRootFolderIDFromDB
    put:
      operationId: externalDocumentGetRootFolderIDFromDB
      parameters:
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: string
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document get root folder ID from DB
      x-summary-source: derived
  /externaldocument/linkExternalDocumentObjects:
    summary: linkExternalDocumentObjects
    put:
      operationId: externalDocumentLinkExternalDocumentObjects
      parameters:
      - name: refObjCode
        in: query
        description: refObjCode
        required: false
        schema:
          type: string
      - name: refObjID
        in: query
        description: refObjID
        required: false
        schema:
          type: string
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: objects
        in: query
        description: objects
        required: false
        schema:
          type: string
      - name: destFolderID
        in: query
        description: destFolderID
        required: false
        schema:
          type: string
      - name: advancedProofingOptions
        in: query
        description: advancedProofingOptions
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document link external document objects
      x-summary-source: derived
  /externaldocument/setLinkedFolderMetadata:
    summary: setLinkedFolderMetadata
    put:
      operationId: externalDocumentSetLinkedFolderMetadata
      parameters:
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: externalStorageID
        in: query
        description: externalStorageID
        required: false
        schema:
          type: string
      - name: projectID
        in: query
        description: projectID
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: External document set linked folder metadata
      x-summary-source: derived
  /externaldocument/browseList:
    summary: browseList
    get:
      operationId: getExternalDocumentBrowseList
      parameters:
      - name: filters
        in: query
        description: JSON representing the filtering conditions
        required: false
        content:
          application/json:
            schema:
              type: object
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: searchParams
        in: query
        description: searchParams
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: ./ExternalDocument.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: Get external document browse list
      x-summary-source: derived
  /externaldocument/getFolderMetaData:
    summary: getFolderMetaData
    get:
      operationId: getExternalDocumentGetFolderMetaData
      parameters:
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: folderID
        in: query
        description: folderID
        required: false
        schema:
          type: string
      - name: isForLinkedFolder
        in: query
        description: isForLinkedFolder
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: ./ExternalDocument.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: Get external document get folder meta data
      x-summary-source: derived
  /externaldocument/searchExternalDocuments:
    summary: searchExternalDocuments
    get:
      operationId: getExternalDocumentSearchExternalDocuments
      parameters:
      - name: providerType
        in: query
        description: providerType
        required: false
        schema:
          type: string
      - name: documentProviderID
        in: query
        description: documentProviderID
        required: false
        schema:
          type: string
      - name: searchString
        in: query
        description: searchString
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: limit
        required: false
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: offset
        required: false
        schema:
          type: integer
          format: int32
      - name: searchInFolder
        in: query
        description: searchInFolder
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: ./ExternalDocument.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Externaldocument
      summary: Get external document search external documents
      x-summary-source: derived
components:
  responses:
    422_UNPROCESSABLE_ENTITY:
      description: The request contains invalid data.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    404_NOT_FOUND:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    429_TOO_MANY_REQUESTS:
      description: Too many concurrent API requests for the given customer.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    500_INTERNAL_SERVER_ERROR:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    400_BAD_REQUEST:
      description: The operation is not supported.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    401_UNAUTHORIZED:
      description: The request is not authenticated.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    410_GONE:
      description: The requested resource is no longer available in this API version.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    403_FORBIDDEN:
      description: The user does not have permission to perform the operation.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
  securitySchemes:
    SessionIDHeader:
      type: apiKey
      name: sessionID
      in: header
    AtTaskCookie:
      type: apiKey
      name: attask
      in: cookie
    WFAuthCookie:
      type: apiKey
      name: wf-auth
      in: cookie
    ApiKeyHeader:
      type: apiKey
      name: apiKey
      in: header