TAG LINE
SMALL TITLE

Extension / Attribute

(API Version v3)


What can you do with ExtensionAttribute?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the ExtensionAttribute
ownerId
READ-ONLY
"ownerId": 15
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": "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": 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": 26
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": 16
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
minValue
"minValue": "Hello World"
Type: String
maxValue
"maxValue": "Hello World"
Type: String
validationDataTypeId
"validationDataTypeId": 15
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": "Hello World"
Type: String
formula
"formula": "Hello World"
Type: String
extensionAttributeListTypeId
"extensionAttributeListTypeId": 8
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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

End Points

GETapi/v3/Extension/Attribute/
Retrieve all of the ExtensionAttribute objects.
Retrieve all of the ExtensionAttribute objects.
GET api/v3/Extension/Attribute/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 15,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "hint": "Sample Text Data",
            "description": "Sample Text Data",
            "columnName": "Sample Text Data",
            "defaultValue": "Sample Text Data",
            "isRequired": true,
            "isActive": true,
            "dataSourceColumnDataTypeId": 18,
            "dataSourceColumnDataTypeName": "Sample Text Data",
            "multiSelectDataSourceColumnDataTypeId": 6,
            "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
            "extensionAttributeEntityId": 8,
            "extensionAttributeEntityName": "Sample Text Data",
            "isUnique": true,
            "minValue": "Sample Text Data",
            "maxValue": "Sample Text Data",
            "validationDataTypeId": 26,
            "validationDataTypeName": "Sample Text Data",
            "validationRegEx": "Sample Text Data",
            "formula": "Sample Text Data",
            "extensionAttributeListTypeId": 15,
            "extensionAttributeListTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v3/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/v3/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": "Sample Text Data",
                "hint": "Sample Text Data",
                "description": "Sample Text Data",
                "columnName": "Sample Text Data",
                "defaultValue": "Sample Text Data",
                "isRequired": true,
                "isActive": true,
                "dataSourceColumnDataTypeId": 25,
                "dataSourceColumnDataTypeName": "Sample Text Data",
                "multiSelectDataSourceColumnDataTypeId": 10,
                "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
                "extensionAttributeEntityId": 12,
                "extensionAttributeEntityName": "Sample Text Data",
                "isUnique": true,
                "minValue": "Sample Text Data",
                "maxValue": "Sample Text Data",
                "validationDataTypeId": 21,
                "validationDataTypeName": "Sample Text Data",
                "validationRegEx": "Sample Text Data",
                "formula": "Sample Text Data",
                "extensionAttributeListTypeId": 19,
                "extensionAttributeListTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/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/v3/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": 21,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "hint": "Sample Text Data",
                "description": "Sample Text Data",
                "columnName": "Sample Text Data",
                "defaultValue": "Sample Text Data",
                "isRequired": true,
                "isActive": true,
                "dataSourceColumnDataTypeId": 25,
                "dataSourceColumnDataTypeName": "Sample Text Data",
                "multiSelectDataSourceColumnDataTypeId": 0,
                "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
                "extensionAttributeEntityId": 2,
                "extensionAttributeEntityName": "Sample Text Data",
                "isUnique": true,
                "minValue": "Sample Text Data",
                "maxValue": "Sample Text Data",
                "validationDataTypeId": 23,
                "validationDataTypeName": "Sample Text Data",
                "validationRegEx": "Sample Text Data",
                "formula": "Sample Text Data",
                "extensionAttributeListTypeId": 17,
                "extensionAttributeListTypeName": "Sample Text Data",
                "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v3/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/v3/Extension/Attribute/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 5,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "hint": "Sample Text Data",
        "description": "Sample Text Data",
        "columnName": "Sample Text Data",
        "defaultValue": "Sample Text Data",
        "isRequired": true,
        "isActive": true,
        "dataSourceColumnDataTypeId": 5,
        "dataSourceColumnDataTypeName": "Sample Text Data",
        "multiSelectDataSourceColumnDataTypeId": 18,
        "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
        "extensionAttributeEntityId": 15,
        "extensionAttributeEntityName": "Sample Text Data",
        "isUnique": true,
        "minValue": "Sample Text Data",
        "maxValue": "Sample Text Data",
        "validationDataTypeId": 21,
        "validationDataTypeName": "Sample Text Data",
        "validationRegEx": "Sample Text Data",
        "formula": "Sample Text Data",
        "extensionAttributeListTypeId": 12,
        "extensionAttributeListTypeName": "Sample Text Data"
    }
}
GETapi/v3/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/v3/Extension/Attribute/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 13,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "hint": "Sample Text Data",
        "description": "Sample Text Data",
        "columnName": "Sample Text Data",
        "defaultValue": "Sample Text Data",
        "isRequired": true,
        "isActive": true,
        "dataSourceColumnDataTypeId": 12,
        "dataSourceColumnDataTypeName": "Sample Text Data",
        "multiSelectDataSourceColumnDataTypeId": 15,
        "multiSelectDataSourceColumnDataTypeName": "Sample Text Data",
        "extensionAttributeEntityId": 26,
        "extensionAttributeEntityName": "Sample Text Data",
        "isUnique": true,
        "minValue": "Sample Text Data",
        "maxValue": "Sample Text Data",
        "validationDataTypeId": 12,
        "validationDataTypeName": "Sample Text Data",
        "validationRegEx": "Sample Text Data",
        "formula": "Sample Text Data",
        "extensionAttributeListTypeId": 20,
        "extensionAttributeListTypeName": "Sample Text Data",
        "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
                    }
                ]
            }
        }
    }
}