Retrieve a list of the fields for a custom object
get
/api/bulk/2.0/customObjects/{parentId}/fields
Retrieves a custom object field definition for the custom object and field ids provided.
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 : CustomObjectFieldSearchResponse
Type:
object
Title:
Show Source
CustomObjectFieldSearchResponse
-
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 CustomObjectField
Title:
CustomObjectField
Nested Schema : CustomObjectField
Type:
object
Title:
Show Source
CustomObjectField
-
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
The following examples demonstrate how to retrieve custom object fields for a custom object using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve a list of the first 5 custom object fields for the custom object with id #6:
GET /customObjects/6/fields?limit=5
Response:
{
"items":[
{
"name":"Email Address",
"internalName":"Email_Address1",
"dataType":"string",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":false,
"statement":"{{CustomObject[6].Field[45]}}",
"uri":"/customObjects/6/fields/45"
},
{
"name":"Product Name",
"internalName":"Product_Name1",
"dataType":"string",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":false,
"statement":"{{CustomObject[6].Field[46]}}",
"uri":"/customObjects/6/fields/46"
},
{
"name":"Renewal Date",
"internalName":"Renewal_Date1",
"dataType":"date",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":false,
"statement":"{{CustomObject[6].Field[47]}}",
"uri":"/customObjects/6/fields/47"
},
{
"name":"Product Renewed?",
"internalName":"Product_Renewed_1",
"dataType":"string",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":false,
"statement":"{{CustomObject[6].Field[48]}}",
"uri":"/customObjects/6/fields/48"
},
{
"name":"Purchase ID",
"internalName":"Purchase_ID1",
"dataType":"string",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":true,
"statement":"{{CustomObject[6].Field[91]}}",
"uri":"/customObjects/6/fields/91"
}
],
"totalResults":15,
"limit":5,
"offset":0,
"count":5,
"hasMore":true
}
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/customObjects/6/fields?limit=5