TAG LINE
TAG LINE
SMALL TITLE

Extension / Attribute / List Item

(API Version v7)


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


What can you do with ExtensionAttributeListItem?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the ExtensionAttributeListItem
extensionAttributeId
"extensionAttributeId": 2
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": 8
Type: Number
Unused


End Points

DELETEExtension/Attribute/ListItem/{id}
Delete an instance of the ExtensionAttributeListItem 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 ExtensionAttributeListItem object.
Delete an instance of the ExtensionAttributeListItem object.
DELETE Extension/Attribute/ListItem/{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": "extensionAttributeListItem"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETExtension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
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": 12,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 24
        }
    ]
}
GETExtension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
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": 16,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 24
        }
    ]
}
GETExtension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
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": 15,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 12
        }
    ]
}
GETExtension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
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": 2,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 4
        }
    ]
}
GETExtension/Attribute/ListItem/
Retrieve all of the ExtensionAttributeListItem objects.
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": 12,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 9
        }
    ]
}
GETExtension/Attribute/ListItem/Metadata
Retrieve all of the ExtensionAttributeListItem objects.
Retrieve all of the ExtensionAttributeListItem objects.
GET Extension/Attribute/ListItem/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 18,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 11
        }
    ]
}
GETExtension/Attribute/ListItem/Metadata/sql
Retrieve all of the ExtensionAttributeListItem objects.
Retrieve all of the ExtensionAttributeListItem objects.
GET Extension/Attribute/ListItem/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "extensionAttributeId": 11,
            "extensionAttributeName": "Sample Text Data",
            "value": "My List Item 1",
            "sortOrder": 9
        }
    ]
}
GETExtension/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": 12,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 23
            }
        ]
    }
}
GETExtension/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": 17,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 2
            }
        ]
    }
}
GETExtension/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": 14,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 24
            }
        ]
    }
}
GETExtension/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": 20,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 17
            }
        ]
    }
}
GETExtension/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": 20,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 9
            }
        ]
    }
}
GETExtension/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": 11,
        "extensionAttributeName": "Sample Text Data",
        "value": "My List Item 1",
        "sortOrder": 17
    }
}
GETExtension/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": 2,
        "extensionAttributeName": "Sample Text Data",
        "value": "My List Item 1",
        "sortOrder": 26
    }
}
GETExtension/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": 6,
        "extensionAttributeName": "Sample Text Data",
        "value": "My List Item 1",
        "sortOrder": 1
    }
}
GETExtension/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": 11,
        "extensionAttributeName": "Sample Text Data",
        "value": "My List Item 1",
        "sortOrder": 7
    }
}
GETExtension/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": 25,
        "extensionAttributeName": "Sample Text Data",
        "value": "My List Item 1",
        "sortOrder": 27
    }
}
POSTExtension/Attribute/ListItem/
Create a new instance of the ExtensionAttributeListItem object.
Create a new instance of the ExtensionAttributeListItem object.
POST Extension/Attribute/ListItem/

{
    "extensionAttributeId": 24,
    "value": "My List Item 1",
    "sortOrder": 18
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "extensionAttributeId": 4,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 1
            }
        ]
    }
}
PUTExtension/Attribute/ListItem/{id}
Update an existing instance of the ExtensionAttributeListItem object.
Update an existing instance of the ExtensionAttributeListItem object.
PUT Extension/Attribute/ListItem/{id}

{
    "identity": 1,
    "extensionAttributeId": 5,
    "value": "My List Item 1",
    "sortOrder": 24
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "extensionAttributeId": 21,
                "extensionAttributeName": "Sample Text Data",
                "value": "My List Item 1",
                "sortOrder": 5
            }
        ]
    }
}