TAG LINE
SMALL TITLE

Extension / Attribute / Lookup

(API Version v4)


What can you do with ExtensionAttributeLookup?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the ExtensionAttributeLookup
extensionAttributeId
"extensionAttributeId": 18
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.
resourceName
"resourceName": "Hello World"
Type: String
searchRequest
"searchRequest": "Hello World"
Type: String
columnName
"columnName": "Hello World"
Type: String


End Points

GETapi/v4/Extension/Attribute/Lookup/
Retrieve all of the ExtensionAttributeLookup objects.
Retrieve all of the ExtensionAttributeLookup objects.
GET api/v4/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",
            "resourceName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Extension/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 api/v4/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": 1,
                "extensionAttributeName": "Sample Text Data",
                "resourceName": "Sample Text Data",
                "searchRequest": "Sample Text Data",
                "columnName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Extension/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 api/v4/Extension/Attribute/Lookup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "extensionAttributeId": 11,
        "extensionAttributeName": "Sample Text Data",
        "resourceName": "Sample Text Data",
        "searchRequest": "Sample Text Data",
        "columnName": "Sample Text Data"
    }
}
POSTapi/v4/Extension/Attribute/Lookup/Search
Retreive a list of ExtensionAttributeLookup objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of ExtensionAttributeLookup objects based on search criteria.
POST api/v4/Extension/Attribute/Lookup/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 13,
            "extensionAttributeName": "Sample Text Data",
            "resourceName": "Sample Text Data",
            "searchRequest": "Sample Text Data",
            "columnName": "Sample Text Data"
        }
    ]
}