TAG LINE
TAG LINE
SMALL TITLE

Extension / Attribute

(API Version v6)


This entity represents different properties of a Custom Field.


What can you do with ExtensionAttribute?


Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the ExtensionAttribute
ownerId
READ-ONLY
"ownerId": 5
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "CPQ Order Number"
Type: String
The user defined name of the Custom Field.
hint
"hint": "The number from your CPQ system"
Type: String
A user defined hint to show in the input field.
description
"description": "This is the linking order number from our CPQ system"
Type: String
A user defined description for the Custom Field
columnName
"columnName": "cpqOrderNumber"
Type: String
A user defined name for the column that will be returned from an API.
defaultValue
"defaultValue": "00000"
Type: String
A default value to be used if no input is supplied
isRequired
"isRequired": true
Type: Boolean
Whether or not this field is required to be entered.
isActive
"isActive": true
Type: Boolean
Whether or not this field is available to be shown on a layout for a screen.
dataSourceColumnDataTypeId
"dataSourceColumnDataTypeId": 19
Type: Number
Unique identifier for the associated DataSourceColumnDataType object.
dataSourceColumnDataTypeName
"dataSourceColumnDataTypeName": "Sample Name"
Type: String
The name of the object associated with the dataSourceColumnDataTypeId property.
multiSelectDataSourceColumnDataTypeId
"multiSelectDataSourceColumnDataTypeId": 21
Type: Number
Unique identifier for the associated DataSourceColumnDataType object.
multiSelectDataSourceColumnDataTypeName
"multiSelectDataSourceColumnDataTypeName": "Sample Name"
Type: String
The name of the object associated with the multiSelectDataSourceColumnDataTypeId property.
extensionAttributeEntityId
"extensionAttributeEntityId": 15
Type: Number
Unique identifier for the associated ExtensionAttributeEntity object.
extensionAttributeEntityName
"extensionAttributeEntityName": "Sample Name"
Type: String
The name of the object associated with the extensionAttributeEntityId property.
isUnique
"isUnique": true
Type: Boolean
Whether or not to enforce a uniqueness rule on this field.
minValue
"minValue": "5"
Type: String
Minimum value allowed in this field.
maxValue
"maxValue": "500"
Type: String
Maximum value allowed in this field.
validationDataTypeId
"validationDataTypeId": 13
Type: Number
Unique identifier for the associated DataType object.
validationDataTypeName
"validationDataTypeName": "Sample Name"
Type: String
The name of the object associated with the validationDataTypeId property.
validationRegEx
"validationRegEx": "^[1-9]\d{2}-\d{3}-\d{4}"
Type: String
Regular expression to be applied for validation.
formula
"formula": "Hello World"
Type: String
Unused
extensionAttributeListTypeId
"extensionAttributeListTypeId": 27
Type: Number
Unique identifier for the associated ExtensionAttributeListType object.
extensionAttributeListTypeName
"extensionAttributeListTypeName": "Sample Name"
Type: String
The name of the object associated with the extensionAttributeListTypeId property.
createdByUserId
"createdByUserId": 27
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.


End Points

GETExtension/Attribute/
Retrieve all of the ExtensionAttribute objects.
Retrieve all of the ExtensionAttribute objects.
GET Extension/Attribute/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 0,
            "ownerName": "Sample Text Data",
            "name": "CPQ Order Number",
            "hint": "The number from your CPQ system",
            "description": "This is the linking order number from our CPQ system",
            "columnName": "cpqOrderNumber",
            "defaultValue": "00000",
            "isRequired": true,
            "isActive": true,
            "dataSourceColumnDataTypeId": 10,
            "dataSourceColumnDataTypeName": "Sample Text Data",
            "multiSelectDataSourceColumnDataTypeId": 23,
            "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
            "extensionAttributeEntityId": 20,
            "extensionAttributeEntityName": "Sample Text Data",
            "isUnique": true,
            "minValue": "5",
            "maxValue": "500",
            "validationDataTypeId": 23,
            "validationDataTypeName": "Sample Text Data",
            "validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
            "formula": "Sample Text Data",
            "extensionAttributeListTypeId": 6,
            "extensionAttributeListTypeName": "Sample Text Data",
            "createdByUserId": 22,
            "createdByUserName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETExtension/Attribute/Paged
Retrieve all of the ExtensionAttribute objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the ExtensionAttribute objects in a paged fashion.
GET Extension/Attribute/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "name": "CPQ Order Number",
                "hint": "The number from your CPQ system",
                "description": "This is the linking order number from our CPQ system",
                "columnName": "cpqOrderNumber",
                "defaultValue": "00000",
                "isRequired": true,
                "isActive": true,
                "dataSourceColumnDataTypeId": 4,
                "dataSourceColumnDataTypeName": "Sample Text Data",
                "multiSelectDataSourceColumnDataTypeId": 7,
                "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
                "extensionAttributeEntityId": 27,
                "extensionAttributeEntityName": "Sample Text Data",
                "isUnique": true,
                "minValue": "5",
                "maxValue": "500",
                "validationDataTypeId": 4,
                "validationDataTypeName": "Sample Text Data",
                "validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
                "formula": "Sample Text Data",
                "extensionAttributeListTypeId": 7,
                "extensionAttributeListTypeName": "Sample Text Data",
                "createdByUserId": 22,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETExtension/Attribute/Paged/Detail
Retrieve all of the ExtensionAttribute objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the ExtensionAttribute objects in a paged fashion with all object details.
GET Extension/Attribute/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "name": "CPQ Order Number",
                "hint": "The number from your CPQ system",
                "description": "This is the linking order number from our CPQ system",
                "columnName": "cpqOrderNumber",
                "defaultValue": "00000",
                "isRequired": true,
                "isActive": true,
                "dataSourceColumnDataTypeId": 18,
                "dataSourceColumnDataTypeName": "Sample Text Data",
                "multiSelectDataSourceColumnDataTypeId": 23,
                "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
                "extensionAttributeEntityId": 3,
                "extensionAttributeEntityName": "Sample Text Data",
                "isUnique": true,
                "minValue": "5",
                "maxValue": "500",
                "validationDataTypeId": 3,
                "validationDataTypeName": "Sample Text Data",
                "validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
                "formula": "Sample Text Data",
                "extensionAttributeListTypeId": 0,
                "extensionAttributeListTypeName": "Sample Text Data",
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "details": {
                    "listItems": [
                        {
                            "identity": 49,
                            "extensionAttributeId": 29,
                            "extensionAttributeName": "Sample Text Data",
                            "value": "Sample Text Data",
                            "sortOrder": 51
                        }
                    ],
                    "lookup": {
                        "identity": 26,
                        "extensionAttributeId": 91,
                        "extensionAttributeName": "Sample Text Data",
                        "resourceName": "Sample Text Data",
                        "columnName": "Sample Text Data"
                    },
                    "dataSourceColumnDataType": {
                        "identity": 88,
                        "name": "Sample Text Data",
                        "databaseTypeId": 28,
                        "databaseTypeName": "Sample Text Data",
                        "dataType": "Sample Text Data",
                        "maxLength": 49,
                        "dataSourceColumnBaseDataTypeId": 12,
                        "dataSourceColumnBaseDataTypeName": "Sample Text Data",
                        "defaultAlignment": 64,
                        "isInternal": true
                    },
                    "multiSelectDataSourceColumnDataType": {
                        "identity": 39,
                        "name": "Sample Text Data",
                        "databaseTypeId": 34,
                        "databaseTypeName": "Sample Text Data",
                        "dataType": "Sample Text Data",
                        "maxLength": 53,
                        "dataSourceColumnBaseDataTypeId": 71,
                        "dataSourceColumnBaseDataTypeName": "Sample Text Data",
                        "defaultAlignment": 38,
                        "isInternal": true
                    }
                }
            }
        ]
    }
}
GETExtension/Attribute/{id}
Retrieve an instance of the ExtensionAttribute object by its ID.
{id}Unique identifier for the ExtensionAttribute object.
Retrieve an instance of the ExtensionAttribute object by its ID.
GET Extension/Attribute/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 20,
        "ownerName": "Sample Text Data",
        "name": "CPQ Order Number",
        "hint": "The number from your CPQ system",
        "description": "This is the linking order number from our CPQ system",
        "columnName": "cpqOrderNumber",
        "defaultValue": "00000",
        "isRequired": true,
        "isActive": true,
        "dataSourceColumnDataTypeId": 18,
        "dataSourceColumnDataTypeName": "Sample Text Data",
        "multiSelectDataSourceColumnDataTypeId": 18,
        "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
        "extensionAttributeEntityId": 17,
        "extensionAttributeEntityName": "Sample Text Data",
        "isUnique": true,
        "minValue": "5",
        "maxValue": "500",
        "validationDataTypeId": 21,
        "validationDataTypeName": "Sample Text Data",
        "validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
        "formula": "Sample Text Data",
        "extensionAttributeListTypeId": 12,
        "extensionAttributeListTypeName": "Sample Text Data",
        "createdByUserId": 3,
        "createdByUserName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z"
    }
}
GETExtension/Attribute/{id}/Detail
Retrieve deep detail of the ExtensionAttribute object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the ExtensionAttribute object.
Retrieve deep detail of the ExtensionAttribute object by its ID.
GET Extension/Attribute/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 9,
        "ownerName": "Sample Text Data",
        "name": "CPQ Order Number",
        "hint": "The number from your CPQ system",
        "description": "This is the linking order number from our CPQ system",
        "columnName": "cpqOrderNumber",
        "defaultValue": "00000",
        "isRequired": true,
        "isActive": true,
        "dataSourceColumnDataTypeId": 18,
        "dataSourceColumnDataTypeName": "Sample Text Data",
        "multiSelectDataSourceColumnDataTypeId": 12,
        "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
        "extensionAttributeEntityId": 5,
        "extensionAttributeEntityName": "Sample Text Data",
        "isUnique": true,
        "minValue": "5",
        "maxValue": "500",
        "validationDataTypeId": 20,
        "validationDataTypeName": "Sample Text Data",
        "validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
        "formula": "Sample Text Data",
        "extensionAttributeListTypeId": 25,
        "extensionAttributeListTypeName": "Sample Text Data",
        "createdByUserId": 3,
        "createdByUserName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "details": {
            "listItems": [
                {
                    "identity": 49,
                    "extensionAttributeId": 29,
                    "extensionAttributeName": "Sample Text Data",
                    "value": "Sample Text Data",
                    "sortOrder": 51
                }
            ],
            "lookup": {
                "identity": 26,
                "extensionAttributeId": 91,
                "extensionAttributeName": "Sample Text Data",
                "resourceName": "Sample Text Data",
                "columnName": "Sample Text Data"
            },
            "dataSourceColumnDataType": {
                "identity": 88,
                "name": "Sample Text Data",
                "databaseTypeId": 28,
                "databaseTypeName": "Sample Text Data",
                "dataType": "Sample Text Data",
                "maxLength": 49,
                "dataSourceColumnBaseDataTypeId": 12,
                "dataSourceColumnBaseDataTypeName": "Sample Text Data",
                "defaultAlignment": 64,
                "isInternal": true
            },
            "multiSelectDataSourceColumnDataType": {
                "identity": 39,
                "name": "Sample Text Data",
                "databaseTypeId": 34,
                "databaseTypeName": "Sample Text Data",
                "dataType": "Sample Text Data",
                "maxLength": 53,
                "dataSourceColumnBaseDataTypeId": 71,
                "dataSourceColumnBaseDataTypeName": "Sample Text Data",
                "defaultAlignment": 38,
                "isInternal": true
            }
        }
    }
}