Extension / Attribute

(API Version v1)

What can you do with ExtensionAttribute?

DELETE api/v1/Extension/Attribute/{id:int}
GET api/v1/Extension/Attribute
GET api/v1/Extension/Attribute/Paged
GET api/v1/Extension/Attribute/Paged/Detail
GET api/v1/Extension/Attribute/{id:int}
GET api/v1/Extension/Attribute/{id:int}/Detail
PATCH api/v1/Extension/Attribute/{id:int}
POST api/v1/Extension/Attribute
PUT api/v1/Extension/Attribute/{id:int}

Properties

Property Details

id	"id": 10 Type: Number This is the unique numeric identifier for the ExtensionAttribute
ownerId	"ownerId": 26 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": 18 Type: Number Unique identifier for the associated DataSourceColumnDataType object.
multiSelectDataSourceColumnDataTypeId	"multiSelectDataSourceColumnDataTypeId": 14 Type: Number Unique identifier for the associated DataSourceColumnDataType object.
extensionAttributeEntityId	"extensionAttributeEntityId": 9 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": 25 Type: Number Unique identifier for the associated DataType object.
validationRegEx	"validationRegEx": "Hello World" Type: String
formula	"formula": "Hello World" Type: String
extensionAttributeListTypeId	"extensionAttributeListTypeId": 23 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:

extensionAttributeListItem - create, update, delete
extensionAttributeLookup - create, update, delete

DataFlow PATCH objects:

extensionAttribute - create, update, delete
extensionAttributeListItem - create, update, delete
extensionAttributeLookup - create, update, delete

End Points

DELETE	api/v1/Extension/Attribute/{id:int}
Delete an instance of the ExtensionAttribute object.

GET	api/v1/Extension/Attribute
Retrieve all of the ExtensionAttribute objects.

GET	api/v1/Extension/Attribute/Paged
Retreive all of the ExtensionAttribute objects in a paged fashion.

GET	api/v1/Extension/Attribute/Paged/Detail
Retreive all of the ExtensionAttribute objects in a paged fashion with all object details.

GET	api/v1/Extension/Attribute/{id:int}
Retrieve an instance of the ExtensionAttribute object by it's ID.
{id:int}	Unique identifier for the ExtensionAttribute object.

GET	api/v1/Extension/Attribute/{id:int}/Detail
Retreive all of the Detail objects for the specified ExtensionAttribute.
{id:int}	Unique identifier for the ExtensionAttribute object.

PATCH	api/v1/Extension/Attribute/{id:int}
Update the ExtensionAttribute object and optionally make changes to any child objects.

POST	api/v1/Extension/Attribute
Create a new instance of the ExtensionAttribute object.

PUT	api/v1/Extension/Attribute/{id:int}
Update an existing instance of the ExtensionAttribute object.