REST API for Oracle Eloqua Marketing Cloud Service

Retrieve an external activity

get

/api/rest/2.0/data/activity/{id}

Retrieves the external activity data specified by the id parameter. Ids are not consecutive.

Request

Supported Media Types

application/json

Path Parameters

id(required): integer

Id of the external activity to retrieve.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : ExternalActivities

Type: object

Title: ExternalActivities

Show Source

activityDate: string

The date the external activity was performed by the associated contact.
activityType: string

The activity's type.
assetName: string

The name of the associated asset.
assetType: string

The type of the associated asset.
campaignId: integer

Id of the associated campaign. This value must correspond to a valid campaign.
contactId: integer

The id of the contact who performed the activity. This value must correspond to a valid contact.
createdAt: string

Read Only: true

The date and time the external activity was created, expressed in Unix time.
createdBy: string

Read Only: true

The login id of the user who created the external activity.
currentStatus: string

The external activity'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.
fieldValues: array fieldValues

Array containing type and id values for all of the activity fields associated with a given external activity
folderId: string

Read Only: true

The folder id of the folder which contains the external activity.
id: string

Read Only: true

Id of the external activity. This is a read-only property.
name: string

The name of the external activity.
permissions: array permissions

The permissions for the external activity granted to your current instance. This is a read-only property.
scheduledFor: string

Read Only: true

The date the external activity is scheduled.
sourceTemplateId: string

Id of the template used to create the external activity.
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 was last updated.
updatedBy: string

Read Only: true

The login id of the user that last updated the external activity.

{
    "title":"ExternalActivities",
    "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. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The external activity's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the external activity."
        },
        "description":{
            "type":"string",
            "description":"The description of the external activity."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the external activity 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."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the external activity."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the external activity."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the external activity was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the external activity."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the external activity was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the external activity 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>."
        },
        "campaignId":{
            "type":"integer",
            "description":"Id of the associated campaign. This value must correspond to a valid campaign."
        },
        "assetName":{
            "type":"string",
            "description":"The name of the associated asset."
        },
        "assetType":{
            "type":"string",
            "description":"The type of the associated asset."
        },
        "activityType":{
            "type":"string",
            "description":"The activity's type."
        },
        "activityDate":{
            "type":"string",
            "description":"The date the external activity was performed by the associated contact."
        },
        "contactId":{
            "type":"integer",
            "description":"The id of the contact who performed the activity. This value must correspond to a valid contact."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the activity fields associated with a given external activity",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : fieldValues

Type: array

Array containing type and id values for all of the activity fields associated with a given external activity

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the activity fields associated with a given external activity",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the external activity 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 granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "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.

Examples

The following examples demonstrate how to retrieve an external activity using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the external activity data with Id #34:


GET /api/REST/2.0/data/activity/34

Response:


{
  "type": "ExternalActivities",
  "id": "34",
  "depth": "complete",
  "name": "Tradeshow 2016",
  "activityDate": "0",
  "activityType": "Viewed a Demo",
  "assetName": "Tradeshow 2016",
  "assetType": "Tradeshow",
  "contactId": 6
}

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/REST/2.0/data/activity/34?depth=complete