POST Agents/List/GetListDefinitions

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetListDefinitions

Get a list of the lists - built-in and user-defined.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/List/GetListDefinitions?$select=name,department,category/id

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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

IncludeDeleted

Property Name Type Description
IncludeDeleted Boolean

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Id int32 The identity of the list
Name string The name of the list
Tooltip string The tooltip of the list
Deleted bool True if the list item is marked as deleted
Rank int32 The rank of the list
IsCustomList bool Indicates if this is a custom list or a standard list
IsMDOList bool Indicates if this is a MDO list
UseGroupsAndHeadings bool Indicates if this list should use groups and headings
ListType string The type of this list, often indicated by the database name, but not necessarily
InUseByUserDefinedFields bool True if this in use by one or more udfields
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/GetListDefinitions
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "IncludeDeleted": true
}

Sample response

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

[
  {
    "Id": 141,
    "Name": "Mayer, Dare and Wisozk",
    "Tooltip": "sint",
    "Deleted": true,
    "Rank": 785,
    "IsCustomList": false,
    "IsMDOList": false,
    "UseGroupsAndHeadings": true,
    "ListType": "numquam",
    "InUseByUserDefinedFields": false,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 60
      }
    }
  }
]