Retrieve a list of external asset types
get
/api/rest/2.0/assets/external/types
Retrieves all external assets type that match the criteria specified by the request parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
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 tominimal
by default. -
lastUpdatedAt: integer
Unix timestamp for the date and time the external asset was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
page: integer
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : QueryResultExternalAssetType
Type:
object
Title:
Show Source
QueryResultExternalAssetType
-
elements:
array elements
Array of account group fields.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of account group fields.
Show Source
-
Array of:
object ExternalAssetType
Title:
ExternalAssetType
Nested Schema : ExternalAssetType
Type:
object
Title:
Show Source
ExternalAssetType
-
activityTypes:
array activityTypes
A list of the external activity types associated with the external asset type.
-
createdAt:
string
Read Only:
true
The date and time the external asset type was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the external asset type. -
createdByName:
string
The name of the user who created the external asset type.
-
currentStatus:
string
The external asset type'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 external asset type.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the external asset type. -
id:
string
Read Only:
true
Id of the external asset type. -
image:
object ImageFile
Title:
ImageFile
-
name:
string
The name of the external asset type.
-
permissions:
array permissions
The permissions for the external asset type granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the external asset type is scheduled. -
sourceTemplateId:
string
Id of the template used to create the external asset type.
-
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 external asset type was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the external asset type. -
updatedByName:
string
The name of the user who last updated the external asset type.
Nested Schema : activityTypes
Type:
array
A list of the external activity types associated with the external asset type.
Show Source
-
Array of:
object ExternalActivityType
Title:
ExternalActivityType
Nested 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. -
createdByName:
string
The name 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.
-
folderId:
string
Read Only:
true
Id of the folder. -
fullImageUrl:
string
The image's complete URL. This is a read-only property.
-
id:
string
Read Only:
true
Id of the image. -
name:
string
The name of the image.
-
permissions:
array permissions
The permissions for the image granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the image is scheduled. -
size:
object Size
Title:
Size
-
source:
string
The image's source location.
-
sourceTemplateId:
string
Id of the source template.
-
syncDate:
string
The date and time the image was last synced, expressed in Unix time. This is a read-only property.
-
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. -
updatedByName:
string
The name of the user who last updated the image.
Nested Schema : permissions
Type:
array
The permissions for the external asset type granted to your current instance. This is a read-only property.
Show Source
Nested Schema : ExternalActivityType
Type:
object
Title:
Show Source
ExternalActivityType
-
createdAt:
string
Read Only:
true
The date and time the external activity type was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the external activity type. -
createdByName:
string
The name of the user who created the external activity type.
-
currentStatus:
string
The external activity type'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 external activity type.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the external activity type. -
id:
string
Read Only:
true
Id of the external activity type. -
name:
string
The name of the external activity type.
-
permissions:
array permissions
The permissions for the external activity type granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the external activity type is scheduled. -
sourceTemplateId:
string
Id of the template used to create the external activity type.
-
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 external activity type was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the external activity type. -
updatedByName:
string
The name of the user who last updated the external activity type.
Nested Schema : permissions
Type:
array
The permissions for the external activity type granted to your current instance. This is a read-only property.
Show Source
Nested Schema : permissions
Type:
array
The permissions for the image granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Size
Type:
object
Title:
Show Source
Size
-
height:
string
The height dimensions of the asset expressed in pixels.
-
type:
string
The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
-
width:
string
The width dimensions of the asset expressed in pixels.
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 first 2 external types in your database:
GET /api/REST/2.0/assets/external/types?count=2
Response:
{
"elements":[
{
"type":"ExternalAssetType",
"id":"1",
"createdAt":"1256486517",
"depth":"minimal",
"name":"Webinar",
"updatedAt":"1256486517"
},
{
"type":"ExternalAssetType",
"id":"2",
"createdAt":"1256486517",
"depth":"minimal",
"name":"Tradeshow",
"updatedAt":"1256486517"
}
],
"page":1,
"pageSize":1000,
"total":2
}