Jump to

• Request
• Response
• Examples

Retrieve a list of campaign fields

get

/api/bulk/2.0/campaigns/fields

Retrieves a list of campaign fields.

Request

Supported Media Types

• application/json
• text/csv

Query Parameters

• 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 orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.
• q: string
  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".
• totalResults: boolean
  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.
• type: string
  The value of this query parameter is sourceCampaign, activity, or campaignResponse. Used to return source campaign field statements and what fields are available depending on export type

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CampaignFieldSearchResponse

Type: object

Title: CampaignFieldSearchResponse

The response body contains information about the campaign fields.

Show Source

• count: integer
  Title: count

  Number of results returned in the request.
• hasMore: boolean
  Title: hasMore

  Indicates if there are more results.
• items: array items
  Title: items

  The collection of items returned.
• limit: integer
  Title: limit

  The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.
• offset: integer
  Title: offset

  The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.
• totalResults: integer(int64)
  Title: totalResults

  Number of total results. Returned when the totalResults URL parameter is not set to false.

{
    "title":"CampaignFieldSearchResponse",
    "description":"The response body contains information about the campaign fields.",
    "properties":{
        "count":{
            "title":"count",
            "description":"Number of results returned in the request.",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"Indicates if there are more results.",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"The collection of items returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CampaignField"
            }
        },
        "limit":{
            "title":"limit",
            "description":"The maximum number of records returned. Set with the <code>limit</code> URL parameter, and defaults to 1000 if not specified.",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"The requested index from which records are returned. Set with the <code>offset</code> URL parameter, and defaults to 0 if not specified.",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"Number of total results. Returned when the <code>totalResults</code> URL parameter is not set to <code>false</code>.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

The collection of items returned.

Show Source

• Array of: object CampaignField
  Title: CampaignField

  The definition of a campaign field in the system.

{
    "title":"items",
    "description":"The collection of items returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CampaignField"
    }
}

Nested Schema : CampaignField

Type: object

Title: CampaignField

The definition of a campaign field in the system.

Show Source

• createdAt: string(date-time)
  Title: createdAt

  The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• dataType: string
  Title: DataType

  Default Value: number

  Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]

  The type of data, used for field definitions.
• defaultValue: string
  Title: defaultValue

  The field's default value.
• hasNotNullConstraint: boolean
  Title: hasNotNullConstraint

  Indicates whether the field can have null values (i.e. empty).
• hasReadOnlyConstraint: boolean
  Title: hasReadOnlyConstraint

  Indicates whether the field can be written to.
• hasUniquenessConstraint: boolean
  Title: hasUniquenessConstraint

  Indicates whether the field must have a unique value.
• internalName: string
  Title: internalName

  The field's internal name (used to uniquely identify it).
• name: string
  Title: name

  The name of the campaign field definition.
• statement: string
  Title: statement

  The markup language statement used to reference the field in an import or export mapping.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"CampaignField",
    "description":"The definition of a campaign field in the system.",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"The field's default value.",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"Indicates whether the field can have null values (i.e. empty).",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"Indicates whether the field can be written to.",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"Indicates whether the field must have a unique value.",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"The field's internal name (used to uniquely identify it).",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the campaign field definition.",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"The markup language statement used to reference the field in an import or export mapping.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "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.

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

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

Response:

{
  "items": [
    {
      "name": "Campaign Id",
      "internalName": "CampaignId",
      "dataType": "number",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Campaign.Id}}",
      "uri": ""
    },
    {
      "name": "CRM Campaign Id",
      "internalName": "CRMCampaignId",
      "dataType": "string",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Campaign.Field(CRMCampaignId)}}",
      "uri": ""
    },
    {
      "name": "Campaign Name",
      "internalName": "CampaignName",
      "dataType": "string",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Campaign.Field(CampaignName)}}",
      "uri": ""
    }
  ],
  "totalResults": 3,
  "limit": 1000,
  "offset": 0,
  "count": 3,
  "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/campaigns/fields
			

Back to Top