TAG LINE
TAG LINE
SMALL TITLE

Extension / Attribute / Lookup

(API Version v7)


What can you do with ExtensionAttributeLookup?


Properties

Property Details
identity
READ-ONLY
"identity": 14
Type: Number
This is the unique numeric identifier for the ExtensionAttributeLookup
extensionAttributeId
"extensionAttributeId": 6
Type: Number
Unique identifier for the associated ExtensionAttribute object.
extensionAttributeName
"extensionAttributeName": "Sample Name"
Type: String
The name of the object associated with the extensionAttributeId property.
searchRequest
"searchRequest": "Hello World"
Type: String
columnName
"columnName": "Hello World"
Type: String
resourceName
"resourceName": "Hello World"
Type: String


End Points

DELETEExtension/Attribute/Lookup/{id}
Delete an instance of the ExtensionAttributeLookup 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 ExtensionAttributeLookup object.
Delete an instance of the ExtensionAttributeLookup object.
DELETE Extension/Attribute/Lookup/{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": "extensionAttributeLookup"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 22,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 13,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 6,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 25,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 9,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/Metadata
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 21,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/Metadata/sql
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET Extension/Attribute/Lookup/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 20,
            "extensionAttributeName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data",
            "resourceName": "Sample Text Data"
        }
    ]
}
GETExtension/Attribute/Lookup/Paged
Retrieve all of the ExtensionAttributeLookup 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 ExtensionAttributeLookup objects in a paged fashion.
GET Extension/Attribute/Lookup/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,
                "extensionAttributeId": 13,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/Paged
Retrieve all of the ExtensionAttributeLookup 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 ExtensionAttributeLookup objects in a paged fashion.
GET Extension/Attribute/Lookup/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,
                "extensionAttributeId": 16,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/Paged
Retrieve all of the ExtensionAttributeLookup 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 ExtensionAttributeLookup objects in a paged fashion.
GET Extension/Attribute/Lookup/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,
                "extensionAttributeId": 18,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/Paged
Retrieve all of the ExtensionAttributeLookup 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 ExtensionAttributeLookup objects in a paged fashion.
GET Extension/Attribute/Lookup/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,
                "extensionAttributeId": 26,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/Paged
Retrieve all of the ExtensionAttributeLookup 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 ExtensionAttributeLookup objects in a paged fashion.
GET Extension/Attribute/Lookup/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,
                "extensionAttributeId": 12,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
GETExtension/Attribute/Lookup/{id}
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
{id}Unique identifier for the ExtensionAttributeLookup object.
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
GET Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 24,
        "extensionAttributeName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data",
        "resourceName": "Sample Text Data"
    }
}
GETExtension/Attribute/Lookup/{id}
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
{id}Unique identifier for the ExtensionAttributeLookup object.
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
GET Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 13,
        "extensionAttributeName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data",
        "resourceName": "Sample Text Data"
    }
}
GETExtension/Attribute/Lookup/{id}
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
{id}Unique identifier for the ExtensionAttributeLookup object.
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
GET Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 6,
        "extensionAttributeName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data",
        "resourceName": "Sample Text Data"
    }
}
GETExtension/Attribute/Lookup/{id}
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
{id}Unique identifier for the ExtensionAttributeLookup object.
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
GET Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 25,
        "extensionAttributeName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data",
        "resourceName": "Sample Text Data"
    }
}
GETExtension/Attribute/Lookup/{id}
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
{id}Unique identifier for the ExtensionAttributeLookup object.
Retrieve an instance of the ExtensionAttributeLookup object by its ID.
GET Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 4,
        "extensionAttributeName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data",
        "resourceName": "Sample Text Data"
    }
}
POSTExtension/Attribute/Lookup/
Create a new instance of the ExtensionAttributeLookup object.
Create a new instance of the ExtensionAttributeLookup object.
POST Extension/Attribute/Lookup/

{
    "extensionAttributeId": 22,
    "searchRequest": "Sample Text Data",
    "columnName": "Sample Text Data",
    "resourceName": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "extensionAttributeId": 6,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}
PUTExtension/Attribute/Lookup/{id}
Update an existing instance of the ExtensionAttributeLookup object.
Update an existing instance of the ExtensionAttributeLookup object.
PUT Extension/Attribute/Lookup/{id}

{
    "identity": 1,
    "extensionAttributeId": 20,
    "searchRequest": "Sample Text Data",
    "columnName": "Sample Text Data",
    "resourceName": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "extensionAttributeId": 2,
                "extensionAttributeName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data",
                "resourceName": "Sample Text Data"
            }
        ]
    }
}