GET api/v2.0/ResourceLibrary/GetDocumentAttachments?documentKey={documentKey}

Returns Document Attachment Details for the specified Document.

Request Information

URI Parameters

Name	Description	Type	Additional information
documentKey	DocumentKey of the Document from which to retrieve the associated Attachments.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

List of Document Attachments.

Collection of DocumentAttachment

Name	Type	Additional information
DocumentAttachmentKey	globally unique identifier	None.
DocumentKey	globally unique identifier	None.
FileName	string	None.
UploadedByContact	ContactConcise	None.
CreatedOn	date	None.
FileExtension	string	None.
FileSizeInBytes	integer	None.
Width	integer	None.
Height	integer	None.
DurationSeconds	integer	None.
DownloadUrl	string	None.
IconUrl	string	None.
Status	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentAttachmentKey": "a35e53ac-325b-49a4-a0c7-7e9cca766d01",
    "DocumentKey": "2512effc-5017-4e5a-931e-5c1cfd18b3bf",
    "FileName": "sample string 3",
    "UploadedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "5c3aa769-089d-44e5-a5e6-676b05c6e027",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "DisplayName": "sample string 6",
      "EmailAddress": "sample string 7",
      "ContactStatusCode": "sample string 8",
      "PrefixCode": "sample string 9",
      "UpdatedOn": "2023-03-28T06:39:39.7332489Z",
      "UpdatedByContactKey": "e6c60797-73c0-41e2-9c65-0da2f5afd3c0",
      "CompanyName": "sample string 12",
      "CompanyTitle": "sample string 13",
      "SuffixCode": "sample string 14",
      "Designation": "sample string 15",
      "LegacyContactKey": "sample string 16",
      "InformalName": "sample string 17",
      "MiddleName": "sample string 18",
      "IsCompany": true,
      "CompanyLegacyContactKey": "sample string 20",
      "AMSDirectoryOptOut": true,
      "HLDirectoryOptOut": true,
      "HLContactMeOptOut": true,
      "LargePictureUrl": "sample string 24",
      "AgreedToTermsDateTime": "2023-03-28T06:39:39.7332489Z"
    },
    "CreatedOn": "2023-03-28T06:39:39.7332489Z",
    "FileExtension": "sample string 5",
    "FileSizeInBytes": 1,
    "Width": 1,
    "Height": 1,
    "DurationSeconds": 1,
    "DownloadUrl": "sample string 6",
    "IconUrl": "sample string 7",
    "Status": "sample string 8"
  },
  {
    "DocumentAttachmentKey": "a35e53ac-325b-49a4-a0c7-7e9cca766d01",
    "DocumentKey": "2512effc-5017-4e5a-931e-5c1cfd18b3bf",
    "FileName": "sample string 3",
    "UploadedByContact": {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "5c3aa769-089d-44e5-a5e6-676b05c6e027",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "DisplayName": "sample string 6",
      "EmailAddress": "sample string 7",
      "ContactStatusCode": "sample string 8",
      "PrefixCode": "sample string 9",
      "UpdatedOn": "2023-03-28T06:39:39.7332489Z",
      "UpdatedByContactKey": "e6c60797-73c0-41e2-9c65-0da2f5afd3c0",
      "CompanyName": "sample string 12",
      "CompanyTitle": "sample string 13",
      "SuffixCode": "sample string 14",
      "Designation": "sample string 15",
      "LegacyContactKey": "sample string 16",
      "InformalName": "sample string 17",
      "MiddleName": "sample string 18",
      "IsCompany": true,
      "CompanyLegacyContactKey": "sample string 20",
      "AMSDirectoryOptOut": true,
      "HLDirectoryOptOut": true,
      "HLContactMeOptOut": true,
      "LargePictureUrl": "sample string 24",
      "AgreedToTermsDateTime": "2023-03-28T06:39:39.7332489Z"
    },
    "CreatedOn": "2023-03-28T06:39:39.7332489Z",
    "FileExtension": "sample string 5",
    "FileSizeInBytes": 1,
    "Width": 1,
    "Height": 1,
    "DurationSeconds": 1,
    "DownloadUrl": "sample string 6",
    "IconUrl": "sample string 7",
    "Status": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocumentAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <DocumentAttachment>
    <CreatedOn>2023-03-28T02:39:39.7332489-04:00</CreatedOn>
    <DocumentAttachmentKey>a35e53ac-325b-49a4-a0c7-7e9cca766d01</DocumentAttachmentKey>
    <DocumentKey>2512effc-5017-4e5a-931e-5c1cfd18b3bf</DocumentKey>
    <DownloadUrl>sample string 6</DownloadUrl>
    <DurationSeconds>1</DurationSeconds>
    <FileExtension>sample string 5</FileExtension>
    <FileName>sample string 3</FileName>
    <FileSizeInBytes>1</FileSizeInBytes>
    <Height>1</Height>
    <IconUrl>sample string 7</IconUrl>
    <Status>sample string 8</Status>
    <UploadedByContact xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
      <d3p1:AMSDirectoryOptOut>true</d3p1:AMSDirectoryOptOut>
      <d3p1:AgreedToTermsDateTime>2023-03-28T02:39:39.7332489-04:00</d3p1:AgreedToTermsDateTime>
      <d3p1:CompanyLegacyContactKey>sample string 20</d3p1:CompanyLegacyContactKey>
      <d3p1:CompanyName>sample string 12</d3p1:CompanyName>
      <d3p1:CompanyTitle>sample string 13</d3p1:CompanyTitle>
      <d3p1:ContactKey>5c3aa769-089d-44e5-a5e6-676b05c6e027</d3p1:ContactKey>
      <d3p1:ContactStatusCode>sample string 8</d3p1:ContactStatusCode>
      <d3p1:Designation>sample string 15</d3p1:Designation>
      <d3p1:DisplayName>sample string 6</d3p1:DisplayName>
      <d3p1:EmailAddress>sample string 7</d3p1:EmailAddress>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:HLContactMeOptOut>true</d3p1:HLContactMeOptOut>
      <d3p1:HLDirectoryOptOut>true</d3p1:HLDirectoryOptOut>
      <d3p1:InformalName>sample string 17</d3p1:InformalName>
      <d3p1:IsCompany>true</d3p1:IsCompany>
      <d3p1:LargePictureUrl>sample string 24</d3p1:LargePictureUrl>
      <d3p1:LastName>sample string 5</d3p1:LastName>
      <d3p1:LegacyContactKey>sample string 16</d3p1:LegacyContactKey>
      <d3p1:LinkToProfile>sample string 1</d3p1:LinkToProfile>
      <d3p1:MiddleName>sample string 18</d3p1:MiddleName>
      <d3p1:PictureUrl>sample string 2</d3p1:PictureUrl>
      <d3p1:PrefixCode>sample string 9</d3p1:PrefixCode>
      <d3p1:SuffixCode>sample string 14</d3p1:SuffixCode>
      <d3p1:UpdatedByContactKey>e6c60797-73c0-41e2-9c65-0da2f5afd3c0</d3p1:UpdatedByContactKey>
      <d3p1:UpdatedOn>2023-03-28T02:39:39.7332489-04:00</d3p1:UpdatedOn>
    </UploadedByContact>
    <Width>1</Width>
  </DocumentAttachment>
  <DocumentAttachment>
    <CreatedOn>2023-03-28T02:39:39.7332489-04:00</CreatedOn>
    <DocumentAttachmentKey>a35e53ac-325b-49a4-a0c7-7e9cca766d01</DocumentAttachmentKey>
    <DocumentKey>2512effc-5017-4e5a-931e-5c1cfd18b3bf</DocumentKey>
    <DownloadUrl>sample string 6</DownloadUrl>
    <DurationSeconds>1</DurationSeconds>
    <FileExtension>sample string 5</FileExtension>
    <FileName>sample string 3</FileName>
    <FileSizeInBytes>1</FileSizeInBytes>
    <Height>1</Height>
    <IconUrl>sample string 7</IconUrl>
    <Status>sample string 8</Status>
    <UploadedByContact xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
      <d3p1:AMSDirectoryOptOut>true</d3p1:AMSDirectoryOptOut>
      <d3p1:AgreedToTermsDateTime>2023-03-28T02:39:39.7332489-04:00</d3p1:AgreedToTermsDateTime>
      <d3p1:CompanyLegacyContactKey>sample string 20</d3p1:CompanyLegacyContactKey>
      <d3p1:CompanyName>sample string 12</d3p1:CompanyName>
      <d3p1:CompanyTitle>sample string 13</d3p1:CompanyTitle>
      <d3p1:ContactKey>5c3aa769-089d-44e5-a5e6-676b05c6e027</d3p1:ContactKey>
      <d3p1:ContactStatusCode>sample string 8</d3p1:ContactStatusCode>
      <d3p1:Designation>sample string 15</d3p1:Designation>
      <d3p1:DisplayName>sample string 6</d3p1:DisplayName>
      <d3p1:EmailAddress>sample string 7</d3p1:EmailAddress>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:HLContactMeOptOut>true</d3p1:HLContactMeOptOut>
      <d3p1:HLDirectoryOptOut>true</d3p1:HLDirectoryOptOut>
      <d3p1:InformalName>sample string 17</d3p1:InformalName>
      <d3p1:IsCompany>true</d3p1:IsCompany>
      <d3p1:LargePictureUrl>sample string 24</d3p1:LargePictureUrl>
      <d3p1:LastName>sample string 5</d3p1:LastName>
      <d3p1:LegacyContactKey>sample string 16</d3p1:LegacyContactKey>
      <d3p1:LinkToProfile>sample string 1</d3p1:LinkToProfile>
      <d3p1:MiddleName>sample string 18</d3p1:MiddleName>
      <d3p1:PictureUrl>sample string 2</d3p1:PictureUrl>
      <d3p1:PrefixCode>sample string 9</d3p1:PrefixCode>
      <d3p1:SuffixCode>sample string 14</d3p1:SuffixCode>
      <d3p1:UpdatedByContactKey>e6c60797-73c0-41e2-9c65-0da2f5afd3c0</d3p1:UpdatedByContactKey>
      <d3p1:UpdatedOn>2023-03-28T02:39:39.7332489-04:00</d3p1:UpdatedOn>
    </UploadedByContact>
    <Width>1</Width>
  </DocumentAttachment>
</ArrayOfDocumentAttachment>