Extension / Attribute / List Item

(API Version v5)

This entity represents the list of items for a Custom Field defined as a pick list.

What can you do with ExtensionAttributeListItem?

GET Extension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
GET Extension/Attribute/ListItem/Paged
Retrieve all of the ExtensionAttributeListItem objects in a paged fashion.
GET Extension/Attribute/ListItem/{id}
Retrieve an instance of the ExtensionAttributeListItem object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 19 Type: Number This is the unique numeric identifier for the ExtensionAttributeListItem
extensionAttributeId	"extensionAttributeId": 13 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.
value	"value": "My List Item 1" Type: String The user defined text to be displayed in the list.
sortOrder	"sortOrder": 11 Type: Number Unused

End Points

Retrieve all of the ExtensionAttributeListItem objects.

GET Extension/Attribute/ListItem/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 4,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 25
        }
    ]
}

GET	Extension/Attribute/ListItem/Paged
Retrieve all of the ExtensionAttributeListItem 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 ExtensionAttributeListItem objects in a paged fashion. GET Extension/Attribute/ListItem/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": 27, "extensionAttributeName": "Sample Text Data", "value": "My List Item 1", "sortOrder": 26 } ] } }

GET	Extension/Attribute/ListItem/{id}
Retrieve an instance of the ExtensionAttributeListItem object by its ID.
{id}	Unique identifier for the ExtensionAttributeListItem object.
Retrieve an instance of the ExtensionAttributeListItem object by its ID. GET Extension/Attribute/ListItem/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "extensionAttributeId": 0, "extensionAttributeName": "Sample Text Data", "value": "My List Item 1", "sortOrder": 10 } }