REST Auth API: Lists

List resources represent predefined collections of string values used for lookups, and are generally managed by users to contain lists of custom values. The most common use of lists is to define the supported values as part of a FieldDescription, such as a list of categories, countries or classifications of customer. If a Field is intended to be displayed as a dropdown list, it will almost always have a reference to a List.

Lists are described by an identifier and a link to a collection of ListItems that describe an ordered collection of distinct values.

This resource supports retrieval of individual list instances and collections of lists.

List instance resource

Resource URI

/api/2012-02-01/auth/resources/lists/{ListID}/

General structure

          
<List>
  <UniqueIdentifier>7a2a4563-3702-4b63-80a2-05de2cb6cbc4</UniqueIdentifier>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Items" type="application/xml" title="Items" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/items/" />
</List>

Resource properties

Property	Description
UniqueIdentifier	A Guid value that uniquely identifies this resource within the platform.

Link (title)	Description
Items	Reference to the ListItems associated with this resource. Note this link does not support inline expansion.

HTTP GET

Returns a representation of a List, including the properties and links above.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.

Example

GET /api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/

                            
<List>
  <UniqueIdentifier>7a2a4563-3702-4b63-80a2-05de2cb6cbc4</UniqueIdentifier>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Items" type="application/xml" title="Items" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/items/" />
</List>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

List collection resource

The List collection resource represents the set of List resources on the platform.

Resource URI

/api/2012-02-01/auth/resources/lists/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual List resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.
skip	Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The `skip` and `top` parameters are generally used for collection paging.
top	Returns a subset of records from the collection, starting at index 0 or index `skip`, and returns the first N records. The `skip` and `top` parameters are generally used for collection paging.

Example 1

Retrieve a collection of List links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/lists/

<Lists>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/a29ee160-3bd3-4439-99c8-0524b3e05797/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/5f19cdda-1208-4717-b2bd-04aac9459728/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/2a4c7cfe-1037-491d-96d9-cbe675075a5e/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/11977098-956a-4926-b794-34272c619a12/" />
  ...
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/List" type="application/xml" title="List" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/e94aae0e-ef94-4af4-a421-7116a737fadf/" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/" />
</Lists>