Autodesk BIM 360 · Schema

attachment

A list of attachments to add to the issue.

ConstructionProject ManagementBIMDocument ManagementField ManagementIssues TrackingCost ManagementModel CoordinationRFIsChecklists

Properties

Name Type Description
attachmentId string The unique identifier for the attachment, set by the client when creating the attachment reference. This can be any unique GUID, but it is recommended to use the OSS storage GUID. For more information
displayName string The human-readable display name for the attachment, including the file extension (for example, .pdf, .jpg, .dwg). This name appears in the ACC web UI and is used when downloading the file from the iss
fileName string The unique filename of the attachment, typically formatted as {attachmentId}.{fileExtension}. This value must exactly match the name of the file stored in Autodesk Docs (OSS) that you uploaded via the
attachmentType object The type of attachment to create. Set to issue-attachment. Will always be: issue-attachment
storageUrn string The Object Storage Service (OSS) URN that uniquely identifies where the file is stored in Autodesk’s cloud infrastructure. You obtain this value after uploading the file to OSS (see the Upload Issue A
fileSize integer The size of the file in bytes.
fileType string The file extension (without the dot), for example pdf or jpg.
domainEntityId string The ID of the issue that owns the attachment.
lineageUrn string The document lineage URN for the attachment’s source file.
version integer The document version number.
versionUrn string The URN for the specific file version that was attached to the issue. This may differ from the latest version URN (tipVersionUrn) if a newer version of the file exists in Autodesk Docs.
tipVersionUrn string The URN for the latest (tip) version of the file.
bubbleUrn string Not relevant
createdBy string The ID of the user who created the issue attachment. For details about the user, call GET users.
createdOn string The date and time when the issue attachment was created, in ISO8601 format.
modifiedBy string Not relevant
modifiedOn string Not relevant
deletedBy string The ID of the user who deleted the issue attachment, if applicable. For details about the user, call GET users.
deletedOn string The date and time when the issue attachment was deleted, if applicable.
isDeleted boolean true: The attachment has been deleted. false: (default) The attachment has not been deleted.
View JSON Schema on GitHub

JSON Schema

autodesk-bim360-attachment-schema.json Raw ↑
{
  "title": "attachment",
  "x-stoplight": {
    "id": "3qdhrtrx0wbin"
  },
  "type": "object",
  "description": "A list of attachments to add to the issue.",
  "properties": {
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment, set by the client when creating the attachment reference. This can be any unique GUID, but it is recommended to use the OSS storage GUID. For more information, see the Upload Issue Attachment tutorial."
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable display name for the attachment, including the file extension (for example, .pdf, .jpg, .dwg). This name appears in the ACC web UI and is used when downloading the file from the issue."
    },
    "fileName": {
      "type": "string",
      "description": "The unique filename of the attachment, typically formatted as {attachmentId}.{fileExtension}.\r\nThis value must exactly match the name of the file stored in Autodesk Docs (OSS) that you uploaded via the OSS process.\r\n\r\nFor more information, see the Upload Issue Attachment tutorial."
    },
    "attachmentType": {
      "enum": [
        "issue-attachment"
      ],
      "description": "The type of attachment to create. Set to issue-attachment. Will always be: issue-attachment"
    },
    "storageUrn": {
      "type": "string",
      "description": "The Object Storage Service (OSS) URN that uniquely identifies where the file is stored in Autodesk\u2019s cloud infrastructure. You obtain this value after uploading the file to OSS (see the Upload Issue Attachment tutorial) or by retrieving it from an existing attachment (see the Downloading Issue Attachments tutorial)."
    },
    "fileSize": {
      "type": "integer",
      "x-stoplight": {
        "id": "i2y7b0tq011zn"
      },
      "description": "The size of the file in bytes."
    },
    "fileType": {
      "type": "string",
      "x-stoplight": {
        "id": "3fiywa72cdk1v"
      },
      "description": "The file extension (without the dot), for example pdf or jpg."
    },
    "domainEntityId": {
      "type": "string",
      "x-stoplight": {
        "id": "06tlcacip3ju0"
      },
      "description": "The ID of the issue that owns the attachment."
    },
    "lineageUrn": {
      "type": "string",
      "x-stoplight": {
        "id": "zh6ah270gg1sg"
      },
      "description": "The document lineage URN for the attachment\u2019s source file."
    },
    "version": {
      "type": "integer",
      "x-stoplight": {
        "id": "yrcq7yz9pj0ci"
      },
      "description": "The document version number."
    },
    "versionUrn": {
      "type": "string",
      "x-stoplight": {
        "id": "wt91zzho7mutk"
      },
      "description": "The URN for the specific file version that was attached to the issue. This may differ from the latest version URN (tipVersionUrn) if a newer version of the file exists in Autodesk Docs."
    },
    "tipVersionUrn": {
      "type": "string",
      "x-stoplight": {
        "id": "77op4l2u7dwlg"
      },
      "description": "The URN for the latest (tip) version of the file."
    },
    "bubbleUrn": {
      "type": "string",
      "x-stoplight": {
        "id": "2wne4s9okswp3"
      },
      "description": "Not relevant"
    },
    "createdBy": {
      "type": "string",
      "x-stoplight": {
        "id": "41lfd9bvtxsgo"
      },
      "description": "The ID of the user who created the issue attachment. For details about the user, call GET users."
    },
    "createdOn": {
      "type": "string",
      "x-stoplight": {
        "id": "giliv7dulj0kn"
      },
      "description": "The date and time when the issue attachment was created, in ISO8601 format."
    },
    "modifiedBy": {
      "type": "string",
      "x-stoplight": {
        "id": "kpnqt4sj2kp5s"
      },
      "description": "Not relevant"
    },
    "modifiedOn": {
      "type": "string",
      "x-stoplight": {
        "id": "0zddjbh06gb0v"
      },
      "description": "Not relevant"
    },
    "deletedBy": {
      "type": "string",
      "x-stoplight": {
        "id": "cv67vkbjf3nxl"
      },
      "description": "The ID of the user who deleted the issue attachment, if applicable. For details about the user, call GET users."
    },
    "deletedOn": {
      "type": "string",
      "x-stoplight": {
        "id": "40nkce3nxqb48"
      },
      "description": "The date and time when the issue attachment was deleted, if applicable."
    },
    "isDeleted": {
      "type": "boolean",
      "x-stoplight": {
        "id": "6dfy2pf5wjpmu"
      },
      "description": "true: The attachment has been deleted.\r\nfalse: (default) The attachment has not been deleted."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}