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
-
activityType: string
The activity type to filter results. Possible values include:
EmailOpen,EmailClickthrough,EmailSend,Subscribe,Unsubscribe,Bounceback,WebVisit,PageView, andFormSubmit. Refer to Activity Fields for a list of activity fields for each activity type. -
limit: integer
A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example:
?limit=5. -
links: string
The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
-
offset: integer
Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example:
?offset=1000. -
orderBy: string
Specifies the name of the property to order the results by. The
orderByformat istermASC | DESC. Example:?orderBy=name ASC. -
q: string
A URL parameter that specifies query criteria used to filter results. The
qformat istermoperatorvalue. Use "*" for wildcard values. Example:?q="name=*Test*"will find all the entities where the "name" field contains the string "Test". -
totalResults: boolean
Whether or not the total results are shown, and factored into the
hasMoreproperty in the response. When set tofalse, thetotalResultsproperty will not be returned, and thehasMoreproperty will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default istrue.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ActivityFieldSearchResponse
Type:
objectTitle:
ActivityFieldSearchResponseThe response body contains information about the activity field definitions.
Show Source
-
count:
integer
Title:
countThe number of results returned in the request. -
hasMore:
boolean
Title:
hasMoreIndicates if there are more results. -
items:
array items
Title:
itemsThe collection of items that match the search. -
limit:
integer
Title:
limitThe maximum number of records returned. Set with thelimitURL parameter, and defaults to 1000 if not specified. -
offset:
integer
Title:
offsetThe requested index from which records are returned. Set with theoffsetURL parameter, and defaults to 0 if not specified. -
totalResults:
integer(int64)
Title:
totalResultsNumber of total results. Returned when thetotalResultsURL parameter is not set tofalse.
Nested Schema : items
Type:
arrayTitle:
itemsThe collection of items that match the search.
Show Source
-
Array of:
object ActivityField
Title:
ActivityFieldThe definition of a activity field in the system.
Nested Schema : ActivityField
Type:
objectTitle:
ActivityFieldThe definition of a activity field in the system.
Show Source
-
activityTypes:
array activityTypes
Title:
activityTypesThe activity types associated with the activity field. The possible activity types are:EmailSend,EmailOpen,EmailClickthrough,Subscribe,Unsubscribe,Bounceback,WebVisit,PageView, andFormSubmit. See Activity Fields for more information about activity fields. -
createdAt:
string(date-time)
Title:
createdAtThe date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. -
createdBy:
string
Title:
createdByThe login id of the user who created the entity. This is a read-only property. -
dataType:
string
Title:
DataTypeDefault Value:numberAllowed Values:[ "number", "string", "boolean", "date", "emailAddress" ]The type of data, used for field definitions. -
defaultValue:
string
Title:
defaultValueThe field's default value. -
hasNotNullConstraint:
boolean
Title:
hasNotNullConstraintIndicates whether the field can have null values (i.e. empty). -
hasReadOnlyConstraint:
boolean
Title:
hasReadOnlyConstraintIndicates whether the field can be written to. -
hasUniquenessConstraint:
boolean
Title:
hasUniquenessConstraintIndicates whether the field must have a unique value. -
internalName:
string
Title:
internalNameThe field's internal name (used to uniquely identify it). -
name:
string
Title:
nameThe name of the activity definition. -
statement:
string
Title:
statementThe markup language statement used to reference the field in an import or export mapping. -
updatedAt:
string(date-time)
Title:
updatedAtThe date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. -
updatedBy:
string
Title:
updatedByThe login id of the user that last updated the entity. This is a read-only property. -
uri:
string
Title:
uriSystem-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : activityTypes
Type:
arrayTitle:
activityTypesThe activity types associated with the activity field. The possible activity types are:
Show Source
EmailSend, EmailOpen, EmailClickthrough, Subscribe, Unsubscribe, Bounceback, WebVisit, PageView, and FormSubmit. See Activity Fields for more information about activity fields.-
Array of:
string
Title:
ActivityFilterTypeDefault Value:EmailSendAllowed Values:[ "EmailSend", "EmailOpen", "EmailClickthrough", "Subscribe", "Unsubscribe", "Bounceback", "FormSubmit", "PageView", "WebVisit", "ExternalActivity", "SmsSend", "SmsReply", "SmsClickthrough" ]The activity types available for the activity field.
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