REST API for Oracle Eloqua Marketing Cloud Service

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

application/json
text/csv

Query Parameters

limit: integer
links: string
offset: integer
orderBy: string
q: string
totalResults: boolean

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : CampaignResponseFieldSearchResponse

Type: object

Title: CampaignResponseFieldSearchResponse

Show Source

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

{
    "title":"CampaignResponseFieldSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CampaignResponseField"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

Array of: object CampaignResponseField

Title: CampaignResponseField

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CampaignResponseField"
    }
}

Nested Schema : CampaignResponseField

Type: object

Title: CampaignResponseField

Show Source

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

{
    "title":"CampaignResponseField",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "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.

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 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