Jump to

• Request
• Response
• Examples

Retrieve an external asset

get

/api/rest/2.0/assets/external/{id}

Retrieves the external asset specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Id of the external asset.

Query Parameters

• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ExternalAsset

Type: object

Title: ExternalAsset

Show Source

• 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.
• 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, and complete. Any other values passed are reset to complete 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.

{
    "title":"ExternalAsset",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the external asset. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The external asset's current status."
        },
        "description":{
            "type":"string",
            "description":"The description of the external asset."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the external asset granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the external asset."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the external asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the external asset."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the external asset was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the external asset."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the external asset was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the external asset is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "externalAssetTypeId":{
            "type":"string",
            "description":"Id of the external asset type."
        },
        "name":{
            "type":"string",
            "description":"The name of 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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the external asset granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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.

Back to Top

Examples

Retrieve the external asset with Id #1:

GET /api/REST/2.0/assets/external/1?depth=complete
			

Response:

{
    "type":"ExternalAsset",
    "id":"1",
    "createdAt":"1436209794",
    "createdBy":"19",
    "depth":"complete",
    "name":"Mega External Extraordinaire",
    "updatedAt":"1436209794",
    "updatedBy":"19",
    "externalAssetTypeId":"0"
}
			

Back to Top