Adobe Suite

Adobe Suite Externaldocument API

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

Documentation GitHub OpenAPI

Operations 10

GET /externaldocument/search Search of externaldocument #

PUT /externaldocument/browseListWithLinkAction #

PUT /externaldocument/getDocumentDownloadUrl #

PUT /externaldocument/getRootFolderID #

PUT /externaldocument/getRootFolderIDFromDB #

PUT /externaldocument/linkExternalDocumentObjects #

PUT /externaldocument/setLinkedFolderMetadata #

GET /externaldocument/browseList #

GET /externaldocument/getFolderMetaData #

GET /externaldocument/searchExternalDocuments #

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-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

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
  /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
  /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
  /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
  /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
  /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
  /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
  /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
  /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
components:
  responses:
    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
    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
    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
    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
    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
    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
    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
  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