Retrieve a list of activity field definitions
get
/api/bulk/2.0/activities/fields
Retrieves a list of activity field definitions.
Request
Supported Media Types
- application/json
- text/csv
Query Parameters
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ActivityFieldSearchResponse
Type:
object
Title:
Show Source
ActivityFieldSearchResponse
-
count:
integer
Title:
count
-
hasMore:
boolean
Title:
hasMore
-
items:
array items
Title:
items
-
limit:
integer
Title:
limit
-
offset:
integer
Title:
offset
-
totalResults:
integer(int64)
Title:
totalResults
Nested Schema : items
Type:
array
Title:
Show Source
items
-
Array of:
object ActivityField
Title:
ActivityField
Nested Schema : ActivityField
Type:
object
Title:
Show Source
ActivityField
-
activityTypes:
array activityTypes
Title:
activityTypes
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
dataType:
string
Title:
DataType
Default Value:number
Allowed Values:[ "number", "string", "boolean", "date", "emailAddress" ]
-
defaultValue:
string
Title:
defaultValue
-
hasNotNullConstraint:
boolean
Title:
hasNotNullConstraint
-
hasReadOnlyConstraint:
boolean
Title:
hasReadOnlyConstraint
-
hasUniquenessConstraint:
boolean
Title:
hasUniquenessConstraint
-
internalName:
string
Title:
internalName
-
name:
string
Title:
name
-
statement:
string
Title:
statement
-
updatedAt:
string(date-time)
Title:
updatedAt
-
updatedBy:
string
Title:
updatedBy
-
uri:
string
Title:
uri
Nested Schema : activityTypes
Type:
array
Title:
Show Source
activityTypes
-
Array of:
string
Title:
ActivityFilterType
Default Value:EmailSend
Allowed Values:[ "EmailSend", "EmailOpen", "EmailClickthrough", "Subscribe", "Unsubscribe", "Bounceback", "FormSubmit", "PageView", "WebVisit", "ExternalActivity", "SmsSend", "SmsReply", "SmsClickthrough" ]
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. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to retrieve a list of activity field definitions using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve a list of the first 2 activity field definitions in your database:
GET /api/bulk/2.0/activities/fields?limit=2
Response:
{
"items": [
{
"name": "Activity Type",
"internalName": "ActivityType",
"dataType": "string",
"hasReadOnlyConstraint": true,
"hasNotNullConstraint": true,
"hasUniquenessConstraint": false,
"statement": "{{Activity.Type}}",
"activityTypes": [
"EmailSend",
"EmailOpen",
"EmailClickthrough",
"Subscribe",
"Unsubscribe",
"Bounceback",
"FormSubmit",
"PageView",
"WebVisit"
],
"uri": ""
},
{
"name": "Id",
"internalName": "Id",
"dataType": "number",
"hasReadOnlyConstraint": true,
"hasNotNullConstraint": true,
"hasUniquenessConstraint": false,
"statement": "{{Activity.Id}}",
"activityTypes": [
"WebVisit",
"PageView",
"FormSubmit",
"Bounceback",
"Unsubscribe",
"Subscribe",
"EmailClickthrough",
"EmailOpen",
"EmailSend"
],
"uri": ""
}
],
"totalResults": 32,
"limit": 2,
"offset": 0,
"count": 2,
"hasMore": true
}
Retreive the first 2 EmailSend
activity fields in your database:
GET /api/bulk/2.0/activities/fields?activityType=EmailSend&limit=2
Response:
{
"items": [
{
"name": "Activity Type",
"internalName": "ActivityType",
"dataType": "string",
"hasReadOnlyConstraint": true,
"hasNotNullConstraint": true,
"hasUniquenessConstraint": false,
"statement": "{{Activity.Type}}",
"activityTypes": [
"EmailSend",
"EmailOpen",
"EmailClickthrough",
"Subscribe",
"Unsubscribe",
"Bounceback",
"FormSubmit",
"PageView",
"WebVisit"
],
"uri": ""
},
{
"name": "Id",
"internalName": "Id",
"dataType": "number",
"hasReadOnlyConstraint": true,
"hasNotNullConstraint": true,
"hasUniquenessConstraint": false,
"statement": "{{Activity.Id}}",
"activityTypes": [
"WebVisit",
"PageView",
"FormSubmit",
"Bounceback",
"Unsubscribe",
"Subscribe",
"EmailClickthrough",
"EmailOpen",
"EmailSend"
],
"uri": ""
}
],
"totalResults": 17,
"limit": 2,
"offset": 0,
"count": 2,
"hasMore": true
}
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/bulk/2.0/activities/fields?limit=2