TAG LINE
TAG LINE
SMALL TITLE

Extension / Attribute / Entity

(API Version v6)


What can you do with ExtensionAttributeEntity?


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the ExtensionAttributeEntity
name
"name": "Hello World"
Type: String
tableName
"tableName": "Hello World"
Type: String
sortOrder
"sortOrder": 19
Type: Number


End Points

GETapi/v6/Extension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET api/v6/Extension/Attribute/Entity/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "tableName": "Sample Text Data",
            "sortOrder": 13
        }
    ]
}
GETapi/v6/Extension/Attribute/Entity/Paged
Retrieve all of the ExtensionAttributeEntity 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 ExtensionAttributeEntity objects in a paged fashion.
GET api/v6/Extension/Attribute/Entity/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,
                "name": "Sample Text Data",
                "tableName": "Sample Text Data",
                "sortOrder": 3
            }
        ]
    }
}
GETapi/v6/Extension/Attribute/Entity/{id}
Retrieve an instance of the ExtensionAttributeEntity object by its ID.
{id}Unique identifier for the ExtensionAttributeEntity object.
Retrieve an instance of the ExtensionAttributeEntity object by its ID.
GET api/v6/Extension/Attribute/Entity/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "tableName": "Sample Text Data",
        "sortOrder": 8
    }
}