GET api/v2.0/ResourceLibrary/GetDocumentAttachment?documentAttachmentKey={documentAttachmentKey}

Returns Document Attachment Details for the specified Document Attachment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentAttachmentKey

DocumentAttachmentKey or DocumentFileKey for the document attachment that you would like to retrieve.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

DocumentAttachment
NameDescriptionTypeAdditional 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": "47dca9a0-043f-45de-bd00-64ea6ad73df1",
  "DocumentKey": "1b950b60-0b68-4666-9fd4-ebd96573b28f",
  "FileName": "sample string 3",
  "UploadedByContact": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "993d2c4c-e550-4679-ae75-bc21bb9c1371",
    "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": "2019-05-25T19:20:53.5390654Z",
    "UpdatedByContactKey": "839be49d-cde2-4787-b8ee-ea036464323c",
    "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": "2019-05-25T19:20:53.5390654Z"
  },
  "CreatedOn": "2019-05-25T19:20:53.5390654Z",
  "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:
<DocumentAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <CreatedOn>2019-05-25T15:20:53.5390654-04:00</CreatedOn>
  <DocumentAttachmentKey>47dca9a0-043f-45de-bd00-64ea6ad73df1</DocumentAttachmentKey>
  <DocumentKey>1b950b60-0b68-4666-9fd4-ebd96573b28f</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:d2p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
    <d2p1:AMSDirectoryOptOut>true</d2p1:AMSDirectoryOptOut>
    <d2p1:AgreedToTermsDateTime>2019-05-25T15:20:53.5390654-04:00</d2p1:AgreedToTermsDateTime>
    <d2p1:CompanyLegacyContactKey>sample string 20</d2p1:CompanyLegacyContactKey>
    <d2p1:CompanyName>sample string 12</d2p1:CompanyName>
    <d2p1:CompanyTitle>sample string 13</d2p1:CompanyTitle>
    <d2p1:ContactKey>993d2c4c-e550-4679-ae75-bc21bb9c1371</d2p1:ContactKey>
    <d2p1:ContactStatusCode>sample string 8</d2p1:ContactStatusCode>
    <d2p1:Designation>sample string 15</d2p1:Designation>
    <d2p1:DisplayName>sample string 6</d2p1:DisplayName>
    <d2p1:EmailAddress>sample string 7</d2p1:EmailAddress>
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:HLContactMeOptOut>true</d2p1:HLContactMeOptOut>
    <d2p1:HLDirectoryOptOut>true</d2p1:HLDirectoryOptOut>
    <d2p1:InformalName>sample string 17</d2p1:InformalName>
    <d2p1:IsCompany>true</d2p1:IsCompany>
    <d2p1:LargePictureUrl>sample string 24</d2p1:LargePictureUrl>
    <d2p1:LastName>sample string 5</d2p1:LastName>
    <d2p1:LegacyContactKey>sample string 16</d2p1:LegacyContactKey>
    <d2p1:LinkToProfile>sample string 1</d2p1:LinkToProfile>
    <d2p1:MiddleName>sample string 18</d2p1:MiddleName>
    <d2p1:PictureUrl>sample string 2</d2p1:PictureUrl>
    <d2p1:PrefixCode>sample string 9</d2p1:PrefixCode>
    <d2p1:SuffixCode>sample string 14</d2p1:SuffixCode>
    <d2p1:UpdatedByContactKey>839be49d-cde2-4787-b8ee-ea036464323c</d2p1:UpdatedByContactKey>
    <d2p1:UpdatedOn>2019-05-25T15:20:53.5390654-04:00</d2p1:UpdatedOn>
  </UploadedByContact>
  <Width>1</Width>
</DocumentAttachment>