GET v1/custom-lists/{id}/list-items

Gets the list of choices for a custom list type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

listItemTypeId

integer

Required

Body Parameters

None.

Response Information

Resource Description

SearchResultOfListItem
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of ListItem

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "sortOrder": 3,
      "active": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "sortOrder": 3,
      "active": true
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfListItem3KdDVibf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:ListItem>
      <d2p1:active>true</d2p1:active>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:sortOrder>3</d2p1:sortOrder>
    </d2p1:ListItem>
    <d2p1:ListItem>
      <d2p1:active>true</d2p1:active>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:sortOrder>3</d2p1:sortOrder>
    </d2p1:ListItem>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfListItem3KdDVibf>