Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : QueryResultExternalAssetType

Type: object

Title: QueryResultExternalAssetType

Show Source

• 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.

{
    "title":"QueryResultExternalAssetType",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of account group fields.",
            "items":{
                "$ref":"#/definitions/ExternalAssetTypeRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of account group fields.

Show Source

• Array of: object ExternalAssetType
  Title: ExternalAssetType

{
    "type":"array",
    "description":"Array of account group fields.",
    "items":{
        "$ref":"#/definitions/ExternalAssetTypeRest20"
    }
}

Nested Schema : ExternalAssetType

Type: object

Title: ExternalAssetType

Show Source

• 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.
• 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, 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 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.

{
    "title":"ExternalAssetType",
    "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 type."
        },
        "currentStatus":{
            "type":"string",
            "description":"The external asset type's current status."
        },
        "description":{
            "type":"string",
            "description":"The description of the external asset type."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the external asset type 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 type."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the external asset type."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the external asset type."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the external asset type was created, expressed in Unix time. "
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the external asset type."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the external asset type was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the external asset type 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>."
        },
        "activityTypes":{
            "type":"array",
            "description":"A list of the external activity types associated with the external asset type.",
            "items":{
                "$ref":"#/definitions/ExternalActivityTypeRest20"
            }
        },
        "name":{
            "type":"string",
            "description":"The name of the external asset type."
        },
        "image":{
            "$ref":"#/definitions/ImageFileRest20",
            "description":"A list of associated Image assets."
        }
    }
}

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

{
    "type":"array",
    "description":"A list of the external activity types associated with the external asset type.",
    "items":{
        "$ref":"#/definitions/ExternalActivityTypeRest20"
    }
}

Nested Schema : ImageFile

Type: object

Title: ImageFile

Show Source

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

{
    "title":"ImageFile",
    "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 image."
        },
        "currentStatus":{
            "type":"string",
            "description":"The image's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the image."
        },
        "description":{
            "type":"string",
            "description":"The description of the image."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the image granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the image."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the image."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the image was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image 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>."
        },
        "fullImageUrl":{
            "type":"string",
            "description":"The image's complete URL. This is a read-only property."
        },
        "size":{
            "$ref":"#/definitions/SizeRest20",
            "description":"The size of the image."
        },
        "thumbnailUrl":{
            "type":"string",
            "description":"The image's thumbnail URL. This is a read-only property."
        },
        "source":{
            "type":"string",
            "description":"The image's source location."
        },
        "syncDate":{
            "type":"string",
            "description":"The date and time the image was last synced, expressed in Unix time. This is a read-only property."
        }
    }
}

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

• Array of: string

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

Nested Schema : ExternalActivityType

Type: object

Title: ExternalActivityType

Show Source

• 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.
• 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, 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 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.

{
    "title":"ExternalActivityType",
    "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 activity type."
        },
        "currentStatus":{
            "type":"string",
            "description":"The external activity type's current status."
        },
        "description":{
            "type":"string",
            "description":"The description of the external activity type."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the external activity type 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 activity type."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the external activity type."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the external activity type."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the external activity type was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the external activity type."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the external activity type was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the external activity type 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>."
        },
        "name":{
            "type":"string",
            "description":"The name of 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

• Array of: string

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

Nested Schema : permissions

Type: array

The permissions for the image granted to your current instance. This is a read-only property.

Show Source

• Array of: string

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

Nested Schema : Size

Type: object

Title: Size

Show Source

• 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.

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'."
        },
        "width":{
            "type":"string",
            "description":"The width dimensions of the asset expressed in pixels."
        },
        "height":{
            "type":"string",
            "description":"The height 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.

Back to Top

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
}
			

Back to Top