Get information about an attachment

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/attachments/{attachmentId}

Get detailed information about an attachment, such as type, mime type, size or creation date.

Path Parameters

clientIdstringrequired
Description
Client ID
attachmentIdinteger<int64>required
Description
Attachment ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Responses

200The attachment was retrieved successfully.

RestAttachment
- idinteger<int64>
  Description
  Attachment ID
  Format
  int64
- ownerinteger<int64>
  Description
  Client ID
  Format
  int64
- namestring
  Description
  Attachment name
- uploadedboolean
  Description
  If true, the attachment was successfully uploaded
- fileNamestring
  Description
  File name
- typestring
  Description
  File type of the attachment
- mimeTypestring
  Description
  Mime type of the attachment
- sizeinteger<int64>
  Description
  Attachment size
  Format
  int64
- createdstring<date-time>
  Description
  Date and time of creation
  Format
  date-time
- modifiedstring<date-time>
  Description
  Date and time of modification
  Format
  date-time
- linksobject[]
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

curl

curl --request GET \
     --url https://api.campaign.episerver.net/rest/{clientId}/attachments/{attachmentId} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/attachments/{attachmentId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/attachments/{attachmentId}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.campaign.episerver.net/rest/{clientId}/attachments/{attachmentId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// The attachment was retrieved successfully.
{
  "id": "",
  "owner": "",
  "name": "",
  "uploaded": false,
  "fileName": "",
  "type": "",
  "mimeType": "",
  "size": "",
  "created": "",
  "modified": "",
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}