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
Query Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : EventFieldSearchResponse
Type:
object
Title:
Show Source
EventFieldSearchResponse
-
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
Nested Schema : items
Type:
array
Title:
Show Source
items
-
Array of:
object EventField
Title:
EventField
Nested Schema : EventField
Type:
object
Title:
Show Source
EventField
-
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
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
}