REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of the fields for an event

get

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

Retrieves a list of the fields for the event with the given id.

Request

Supported Media Types

application/json
text/csv

Path Parameters

id: integer

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

Type: object

Title: EventFieldSearchResponse

Show Source

count(optional): integer

Title: count
hasMore(optional): boolean

Title: hasMore
items(optional): array items

Title: items
limit(optional): integer

Title: limit
offset(optional): integer

Title: offset
totalResults(optional): integer(int64)

Title: totalResults

{
    "title":"EventFieldSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EventField"
            }
        },
        "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 EventField

Title: EventField

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

Nested Schema : EventField

Type: object

Title: EventField

Show Source

createdAt(optional): string(date-time)

Title: createdAt
createdBy(optional): string

Title: createdBy
dataType(optional): string

Title: DataType

Default Value: number

Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]
defaultValue(optional): string

Title: defaultValue
hasNotNullConstraint(optional): boolean

Title: hasNotNullConstraint
hasReadOnlyConstraint(optional): boolean

Title: hasReadOnlyConstraint
hasUniquenessConstraint(optional): boolean

Title: hasUniquenessConstraint
internalName(optional): string

Title: internalName
name(optional): string

Title: name
statement(optional): string

Title: statement
updatedAt(optional): string(date-time)

Title: updatedAt
updatedBy(optional): string

Title: updatedBy
uri(optional): string

Title: uri

{
    "title":"EventField",
    "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

Retrieve a list of the first 5 event fields for the event with id # 8:


GET /events/8/fields?limit=5

Response:


{
  "items": [
    {
      "name": "First Name",
      "internalName": "First_Name1",
      "dataType": "string",
      "defaultValue": "Name",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Event[12].Field[55]}}",
      "uri": "/events/12/fields/55"
    },
    {
      "name": "Last Name",
      "internalName": "Last_Name1",
      "dataType": "string",
      "defaultValue": "Last Name",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Event[12].Field[56]}}",
      "uri": "/events/12/fields/56"
    },
    {
      "name": "Email Address",
      "internalName": "Email_Address1",
      "dataType": "string",
      "defaultValue": "Email Address",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Event[12].Field[57]}}",
      "uri": "/events/12/fields/57"
    },
    {
      "name": "Job Role",
      "internalName": "Job_Role1",
      "dataType": "string",
      "defaultValue": "Job Role",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Event[12].Field[58]}}",
      "uri": "/events/12/fields/58"
    },
    {
      "name": "Industry",
      "internalName": "Industry1",
      "dataType": "string",
      "defaultValue": "Industry",
      "hasReadOnlyConstraint": false,
      "hasNotNullConstraint": false,
      "hasUniquenessConstraint": false,
      "statement": "{{Event[12].Field[59]}}",
      "uri": "/events/12/fields/59"
    }
  ],
  "totalResults": 8,
  "limit": 5,
  "offset": 0,
  "count": 5,
  "hasMore": true
}