TAG LINE
TAG LINE
SMALL TITLE
This entity represents different properties of a Custom Field.
identity READ-ONLY | "identity": 24 Type: Number This is the unique numeric identifier for the ExtensionAttribute |
ownerId READ-ONLY | "ownerId": 25 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": 8 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": 6 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": 0 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": 3 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": 12 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": 10 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. |
| GET | api/v5/Extension/Attribute/ |
| Retrieve all of the ExtensionAttribute objects. | |
Retrieve all of the ExtensionAttribute objects. GET api/v5/Extension/Attribute/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 14,
"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": 25,
"dataSourceColumnDataTypeName": "Sample Text Data",
"multiSelectDataSourceColumnDataTypeId": 13,
"multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
"extensionAttributeEntityId": 21,
"extensionAttributeEntityName": "Sample Text Data",
"isUnique": true,
"minValue": "5",
"maxValue": "500",
"validationDataTypeId": 19,
"validationDataTypeName": "Sample Text Data",
"validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
"formula": "Sample Text Data",
"extensionAttributeListTypeId": 1,
"extensionAttributeListTypeName": "Sample Text Data",
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z"
}
]
} | |
| GET | api/v5/Extension/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 api/v5/Extension/Attribute/Paged 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": 16,
"dataSourceColumnDataTypeName": "Sample Text Data",
"multiSelectDataSourceColumnDataTypeId": 16,
"multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
"extensionAttributeEntityId": 10,
"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": 4,
"extensionAttributeListTypeName": "Sample Text Data",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z"
}
]
}
} | |
| GET | api/v5/Extension/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 api/v5/Extension/Attribute/Paged/Detail 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": 2,
"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": 25,
"dataSourceColumnDataTypeName": "Sample Text Data",
"multiSelectDataSourceColumnDataTypeId": 23,
"multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
"extensionAttributeEntityId": 15,
"extensionAttributeEntityName": "Sample Text Data",
"isUnique": true,
"minValue": "5",
"maxValue": "500",
"validationDataTypeId": 14,
"validationDataTypeName": "Sample Text Data",
"validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
"formula": "Sample Text Data",
"extensionAttributeListTypeId": 17,
"extensionAttributeListTypeName": "Sample Text Data",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v5/Extension/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 api/v5/Extension/Attribute/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 14,
"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": 13,
"dataSourceColumnDataTypeName": "Sample Text Data",
"multiSelectDataSourceColumnDataTypeId": 18,
"multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
"extensionAttributeEntityId": 24,
"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": 22,
"extensionAttributeListTypeName": "Sample Text Data",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z"
}
} | |
| GET | api/v5/Extension/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 api/v5/Extension/Attribute/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 8,
"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": 15,
"dataSourceColumnDataTypeName": "Sample Text Data",
"multiSelectDataSourceColumnDataTypeId": 11,
"multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
"extensionAttributeEntityId": 17,
"extensionAttributeEntityName": "Sample Text Data",
"isUnique": true,
"minValue": "5",
"maxValue": "500",
"validationDataTypeId": 16,
"validationDataTypeName": "Sample Text Data",
"validationRegEx": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
"formula": "Sample Text Data",
"extensionAttributeListTypeId": 22,
"extensionAttributeListTypeName": "Sample Text Data",
"createdByUserId": 15,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |