TAG LINE
TAG LINE
SMALL TITLE

Extension / Attribute / Entity

(API Version v7)


What can you do with ExtensionAttributeEntity?


Properties

Property Details
identity
READ-ONLY
"identity": 2
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": 2
Type: Number


End Points

DELETEExtension/Attribute/Entity/{id}
Delete an instance of the ExtensionAttributeEntity object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the ExtensionAttributeEntity object.
Delete an instance of the ExtensionAttributeEntity object.
DELETE Extension/Attribute/Entity/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "extensionAttributeEntity"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETExtension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET 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": 4
        }
    ]
}
GETExtension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET 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
        }
    ]
}
GETExtension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET 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": 26
        }
    ]
}
GETExtension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET 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": 10
        }
    ]
}
GETExtension/Attribute/Entity/
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET 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": 2
        }
    ]
}
GETExtension/Attribute/Entity/Metadata
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET Extension/Attribute/Entity/Metadata
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": 17
        }
    ]
}
GETExtension/Attribute/Entity/Metadata/sql
Retrieve all of the ExtensionAttributeEntity objects.
Retrieve all of the ExtensionAttributeEntity objects.
GET Extension/Attribute/Entity/Metadata/sql
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": 26
        }
    ]
}
GETExtension/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 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": 13
            }
        ]
    }
}
GETExtension/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 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": 12
            }
        ]
    }
}
GETExtension/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 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": 0
            }
        ]
    }
}
GETExtension/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 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": 11
            }
        ]
    }
}
GETExtension/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 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": 6
            }
        ]
    }
}
GETExtension/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 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": 27
    }
}
GETExtension/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 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": 24
    }
}
GETExtension/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 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": 5
    }
}
GETExtension/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 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": 0
    }
}
GETExtension/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 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": 14
    }
}
POSTExtension/Attribute/Entity/
Create a new instance of the ExtensionAttributeEntity object.
Create a new instance of the ExtensionAttributeEntity object.
POST Extension/Attribute/Entity/

{
    "name": "Sample Text Data",
    "tableName": "Sample Text Data",
    "sortOrder": 3
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "tableName": "Sample Text Data",
                "sortOrder": 26
            }
        ]
    }
}
PUTExtension/Attribute/Entity/{id}
Update an existing instance of the ExtensionAttributeEntity object.
Update an existing instance of the ExtensionAttributeEntity object.
PUT Extension/Attribute/Entity/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "tableName": "Sample Text Data",
    "sortOrder": 10
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "tableName": "Sample Text Data",
                "sortOrder": 15
            }
        ]
    }
}