Jump to

• Request
• Response
• Examples

Retrieve a custom object field definition

get

/api/bulk/2.0/customObjects/{parentId}/fields/{id}

Retrieves a custom object field definition for the custom object and field ids provided.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  The custom object's resource identification number.
• parentId(required): integer
  The custom object's resource identification number.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CustomObjectFieldIndividualResponse

Type: object

Title: CustomObjectFieldIndividualResponse

The response body contains information about the custom object field definition.

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 custom object 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":"CustomObjectFieldIndividualResponse",
    "description":"The response body contains information about the custom object field definition.",
    "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 custom object 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 custom object field for a custom object using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the custom object field with id #91 for the custom object with id #6:

GET /customObjects/6/fields/91
			

Response:

{
    "name":"Purchase ID",
    "internalName":"Purchase_ID1",
    "dataType":"string",
    "hasReadOnlyConstraint":false,
    "hasNotNullConstraint":false,
    "hasUniquenessConstraint":true,
    "statement":"{{CustomObject[6].Field[91]}}",
    "uri":"/customObjects/6/fields/91"
}
			

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

Back to Top