GET List/{id}/Items

• 2 minutes to read
 • 2 minutes to read 
GET /api/v1/List/{udListDefinitionId}/Items

Get all list items for the specified list defintion

Path Part Type Description
udListDefinitionId int32 The id of the list definition, indicating which list to get the item from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category. Required

Query String Parameters

Parameter Name Type Description
includeDeleted bool Include deleted items in result? 
GET /api/v1/List/{udListDefinitionId}/Items?includeDeleted=False

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Id int32 The identity of the list item
Name string The name of the list item
Tooltip string The tooltip of the list item
Deleted bool True if the list item is marked as deleted
UdListDefinitionId int32 The id of the list which this list item belongs to
Rank int32 The rank of the list item
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/List/{udListDefinitionId}/Items
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "Id": 266,
    "Name": "Botsford, Davis and Macejkovic",
    "Tooltip": "eveniet",
    "Deleted": true,
    "UdListDefinitionId": 745,
    "Rank": 363,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 74
      }
    }
  }
]