Retrieve an image
get
/api/REST/1.0/assets/image/{id}
Retrieves the image specified by the
id
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the image.
Query Parameters
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ImageFile
Type:
object
Title:
Show Source
ImageFile
-
createdAt:
string
Read Only:
true
The date and time the image was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the image. -
currentStatus:
string
The image's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the image.
-
fullImageUrl:
string
The image's complete URL. This is a read-only property.
-
id:
string
Read Only:
true
Id of the image. This is a read-only property. -
name:
string
The name of the image.
-
permissions:
string
The permissions for the image granted to your current instance. This is a read-only property.
-
size:
object Size
Title:
Size
-
thumbnailUrl:
string
The image's thumbnail URL. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the image was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the image.
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Retrieve the image asset with Id #122:
GET /api/REST/1.0/assets/image/122?depth=complete
Response:
{
"type":"ImageFile",
"id":"122",
"createdAt":"1422481688",
"createdBy":"19",
"depth":"complete",
"folderId":"375",
"name":"radio.png",
"updatedAt":"1422481690",
"updatedBy":"19",
"fullImageUrl":"/EloquaImages/clients/PlatformTeamPod1/{829f1576-b9df-43c3-a6ab-cc96386befae}_radio.png",
"size":{
"type":"Size",
"width":"386",
"height":"387"
},
"thumbnailUrl":"/EloquaImages/clients/PlatformTeamPod1/imagethumbnails/{829f1576-b9df-43c3-a6ab-cc96386befae}_radio.png"
}