1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Bulk
  4. 2.0
  5. campaignResponses

Retrieve all campaign response fields

get

/api/bulk/2.0/campaignResponses/fields

Retrieves all campaign response fields that could be included in an campaign response import or export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.

Request

Supported Media Types
Query Parameters
  • 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.
  • 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.
  • 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.
  • Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.
  • A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".
  • Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : CampaignResponseFieldSearchResponse
Type: object
Title: CampaignResponseFieldSearchResponse
The response body contains information about the campaign response field definitions.
Show Source
  • Title: count
    Number of results returned in the request.
  • Title: hasMore
    Indicates if there are more results.
  • items
    Title: items
    The collection of items returned.
  • Title: limit
    The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.
  • Title: offset
    The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.
  • Title: totalResults
    Number of total results. Returned when the totalResults URL parameter is not set to false.
Nested Schema : items
Type: array
Title: items
The collection of items returned.
Show Source
Nested Schema : CampaignResponseField
Type: object
Title: CampaignResponseField
The definition of a campaign response field in the system.
Show Source
  • Title: createdAt
    The date and time the campaign response field was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the campaign response field. This is a read-only property.
  • Title: DataType
    Default Value: number
    Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]
    The type of data, used for field definitions.
  • Title: defaultValue
    The campaign response field's default value.
  • Title: hasNotNullConstraint
    Indicates whether the campaign response field can have null values (i.e. empty).
  • Title: hasReadOnlyConstraint
    Indicates whether the field can be written to.
  • Title: hasUniquenessConstraint
    Indicates whether the field must have a unique value.
  • Title: internalName
    The field's internal name (used to uniquely identify it).
  • Title: name
    The name of the campaign response field definition.
  • Title: statement
    The markup language statement used to reference the field in an import or export mapping.
  • Title: updatedAt
    The date and time the campaign response field was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

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 a list of campaign response fields using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve all campaign response fields that could be included in a campaign response import or export definition :


GET /campaignResponses/fields
Content-Type: application/json

Response:


{
  "items": [
    {
      "name": "Id",
      "internalName": "Id",
      "dataType": "number",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{CampaignResponse.Id}}",
      "uri": ""
    },
    {
      "name": "Created At",
      "internalName": "CreatedAt",
      "dataType": "date",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{CampaignResponse.CreatedAt}}",
      "uri": ""
    },
    {
      "name": "Member Status",
      "internalName": "MemberStatus",
      "dataType": "string",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{CampaignResponse.Field(MemberStatus)}}",
      "uri": ""
    },
    {
      "name": "Integration Return Value",
      "internalName": "IntegrationReturnValue",
      "dataType": "string",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{CampaignResponse.Field(IntegrationReturnValue)}}",
      "uri": ""
    }
  ],
  "totalResults": 4,
  "limit": 1000,
  "offset": 0,
  "count": 4,
  "hasMore": false
}

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