Asana · Schema

AttachmentRequest

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name Type Description
resource_subtype string The type of the attachment. Must be one of the given values. If not specified, a file attachment of type `asana` will be assumed. Note that if the value of `resource_subtype` is `external`, a `parent`
file string Required for `asana` attachments.
parent string Required identifier of the parent task, project, or project_brief, as a string.
url string The URL of the external resource being attached. Required for attachments of type `external`.
name string The name of the external resource being attached. Required for attachments of type `external`.
connect_to_app boolean *Optional*. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app component
View JSON Schema on GitHub

JSON Schema

asana-attachmentrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AttachmentRequest",
  "title": "AttachmentRequest",
  "type": "object",
  "required": [
    "parent"
  ],
  "properties": {
    "resource_subtype": {
      "description": "The type of the attachment. Must be one of the given values. If not specified, a file attachment of type `asana` will be assumed. Note that if the value of `resource_subtype` is `external`, a `parent`, `name`, and `url` must also be provided.\n",
      "type": "string",
      "example": "external",
      "enum": [
        "asana",
        "dropbox",
        "gdrive",
        "onedrive",
        "box",
        "vimeo",
        "external"
      ]
    },
    "file": {
      "description": "Required for `asana` attachments.\n",
      "type": "string",
      "format": "binary"
    },
    "parent": {
      "description": "Required identifier of the parent task, project, or project_brief, as a string.\n",
      "type": "string"
    },
    "url": {
      "description": "The URL of the external resource being attached. Required for attachments of type `external`.\n",
      "type": "string"
    },
    "name": {
      "description": "The name of the external resource being attached. Required for attachments of type `external`.\n",
      "type": "string"
    },
    "connect_to_app": {
      "description": "*Optional*. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in.\n",
      "type": "boolean"
    }
  }
}