Create an external asset
post
/api/rest/2.0/assets/external
Creates an external asset that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the external asset to be created.
Root Schema : ExternalAsset
Type:
object
Title:
Show Source
ExternalAsset
-
createdAt:
string
Read Only:
true
The date and time the external asset was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the external asset. -
createdByName:
string
The name of the user who created the external asset.
-
currentStatus:
string
The external asset'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.
-
externalAssetTypeId:
string
Id of the external asset type.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the external asset. -
id:
string
Read Only:
true
Id of the external asset. This is a read-only property. -
name:
string
The name of the external asset.
-
permissions:
array permissions
The permissions for the external asset granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the external asset is scheduled. -
sourceTemplateId:
string
Id of the template used to create the external asset.
-
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 was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the external asset. -
updatedByName:
string
The name of the user who last updated the external asset.
Nested Schema : permissions
Type:
array
The permissions for the external asset granted to your current instance. This is a read-only property.
Show Source
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : ExternalAsset
Type:
object
Title:
Show Source
ExternalAsset
-
createdAt:
string
Read Only:
true
The date and time the external asset was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the external asset. -
createdByName:
string
The name of the user who created the external asset.
-
currentStatus:
string
The external asset'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.
-
externalAssetTypeId:
string
Id of the external asset type.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the external asset. -
id:
string
Read Only:
true
Id of the external asset. This is a read-only property. -
name:
string
The name of the external asset.
-
permissions:
array permissions
The permissions for the external asset granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the external asset is scheduled. -
sourceTemplateId:
string
Id of the template used to create the external asset.
-
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 was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the external asset. -
updatedByName:
string
The name of the user who last updated the external asset.
Nested Schema : permissions
Type:
array
The permissions for the external asset granted to your current instance. This is a read-only property.
Show Source
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.
409 Response
There was a conflict. This name is used by another asset.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Create a new external asset:
POST /api/REST/2.0/assets/external
Content-Type: application/json
Request body:
{
"name": "Mega External Extraordinaire",
"externalAssetTypeId": "3"
}
Response:
{
"type": "ExternalAsset",
"id": "1",
"createdAt": "1436209794",
"createdBy": "19",
"depth": "complete",
"name": "Mega External Extraordinaire",
"updatedAt": "1436209794",
"updatedBy": "19",
"externalAssetTypeId": "3"
}