Retrieve an activity field definition

get

/api/bulk/2.0/activities/fields/{id}

Retrieves an activity field definition.

Request

Supported Media Types
Path Parameters
  • Part of the uri used to identify the activity field.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ActivityFieldIndividualResponse
Type: object
Title: ActivityFieldIndividualResponse
The response body contains information about the activity field definition.
Show Source
Nested Schema : activityTypes
Type: array
Title: activityTypes
The activity types associated with the activity field. The possible activity types are: EmailSend, EmailOpen, EmailClickthrough, Subscribe, Unsubscribe, Bounceback, WebVisit, PageView, and FormSubmit. See Activity Fields for more information about activity fields.
Show Source

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.
Back to Top

Examples

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

HTTP Request Example

Retrieve the activity field definition with id #4:


GET /api/bulk/2.0/activities/fields/4
			

Response:


{
  "name": "Email Address",
  "internalName": "EmailAddress",
  "dataType": "string",
  "hasReadOnlyConstraint": false,
  "hasNotNullConstraint": false,
  "hasUniquenessConstraint": false,
  "statement": "{{Activity.Field(EmailAddress)}}",
  "activityTypes": [
    "EmailSend",
    "EmailOpen",
    "EmailClickthrough",
    "Subscribe",
    "Unsubscribe",
    "Bounceback"
  ],
  "uri": ""
}
			

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/4
			
Back to Top