Extension / Attribute

What can you do with ExtensionAttribute?


Properties

Property Details
id
"id": 882
Type: Number
This is the unique numeric identifier for the ExtensionAttribute
ownerId
"ownerId": 584
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
hint
"hint": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
columnName
"columnName": "Hello World"
Type: String
defaultValue
"defaultValue": "Hello World"
Type: String
isRequired
"isRequired": true
Type: Boolean
isActive
"isActive": true
Type: Boolean
dataSourceColumnDataTypeId
"dataSourceColumnDataTypeId": 300
Type: Number
Unique identifier for the associated DataSourceColumnDataType object.
multiSelectDataSourceColumnDataTypeId
"multiSelectDataSourceColumnDataTypeId": 676
Type: Number
Unique identifier for the associated DataSourceColumnDataType object.
extensionAttributeEntityId
"extensionAttributeEntityId": 81
Type: Number
Unique identifier for the associated ExtensionAttributeEntity object.
isUnique
"isUnique": true
Type: Boolean
minValue
"minValue": "Hello World"
Type: String
maxValue
"maxValue": "Hello World"
Type: String
validationDataTypeId
"validationDataTypeId": 439
Type: Number
Unique identifier for the associated DataType object.
validationRegEx
"validationRegEx": "Hello World"
Type: String
formula
"formula": "Hello World"
Type: String
extensionAttributeListTypeId
"extensionAttributeListTypeId": 976
Type: Number
Unique identifier for the associated ExtensionAttributeListType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • hint
  • description
  • isActive
  • multiSelectDataSourceColumnDataTypeId
  • minValue
  • maxValue
  • validationDataTypeId
  • validationRegEx
  • formula
  • extensionAttributeListTypeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the ExtensionAttribute object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Extension/Attribute/{id:int}
Delete an instance of the ExtensionAttribute object.
GETapi/v1/Extension/Attribute
Retrieve all of the ExtensionAttribute objects.
GETapi/v1/Extension/Attribute/Metadata
Retrieve all of the meta data details of the ExtensionAttribute object.
GETapi/v1/Extension/Attribute/Metadata/{option}
Retrieve all the meta data details of the ExtensionAttribute object based on provided options.
{option}Metadata options for the ExtensionAttribute object.
GETapi/v1/Extension/Attribute/Paged
Retreive all of the ExtensionAttribute objects in a paged fashion.
GETapi/v1/Extension/Attribute/Paged/Detail
Retreive all of the ExtensionAttribute objects in a paged fashion with all object details.
GETapi/v1/Extension/Attribute/{id:int}
Retrieve an instance of the ExtensionAttribute object by it's ID.
{id:int}Unique identifier for the ExtensionAttribute object.
GETapi/v1/Extension/Attribute/{id:int}/Detail
Retreive all of the Detail objects for the specified ExtensionAttribute.
{id:int}Unique identifier for the ExtensionAttribute object.
PATCHapi/v1/Extension/Attribute/{id:int}
Update the ExtensionAttribute object and optionally make changes to any child objects.
POSTapi/v1/Extension/Attribute
Create a new instance of the ExtensionAttribute object.
PUTapi/v1/Extension/Attribute/{id:int}
Update an existing instance of the ExtensionAttribute object.