Manual Lists

The FLOW Manual List API provides is used for a few things, desking articles in components, adding articles to be used for auto links, etc.

Manual list entities that are used for desking articles into section components are all called default.

The manual lists that are for other things have more sensible names, there is a filter to exclude default ones: ?default=0.

There is also a categorisation vocabulary attached to the manual list entities in the same way all vocabs are attached to custom entities, using the REST API.

The results can be filtered by this vocab as well by adding this to the URL: &typeId={tid}

The vocab that it references is called manual_list_types and can be searched line this:

Manual List Types Vocab

bundle: manual_list_types

https://indy-api-dev.brightsites.co.uk/api/vocab/manual_list_types/independent.co.uk?limit=20

Endpoints

/api/manual-list/bundles
/api/manual-list-search/{publicationDomain}
/api/manual-lists/{bundle}/{publicationDomain}
/api/manual-list/{id}
/api/manual-list/{id}/{publicationDomain}

Bundles

The bundles endpoint provides the CMS with a list of available bundles for the entities

Example call

https://indy-api-dev.brightsites.co.uk/api/manual-list/bundles

Search

This is an elastic endpoint for searching the lists with paging and some query parameters for narrowing down the search.

The available search parameters are:

# For paging
limit
offset

# Search
q

# Sorting
sortBy
sortDirection

# Filter by ID
id

# Filter by Bundle, defaults to section
bundle

# Filter by List Type ID
manualListTypes

# Filter by default, defaults to 0
default

Example calls

// The default entry page
https://indy-api-dev.brightsites.co.uk/api/manual-list-search/independent.co.uk

https://indy-api-dev.brightsites.co.uk/api/manual-list-search/independent.co.uk?q=Trump

https://indy-api-dev.brightsites.co.uk/api/manual-list-search/independent.co.uk?default=1

https://indy-api-dev.brightsites.co.uk/api/manual-list-search/independent.co.uk?limit=10&offset=0

https://indy-api-dev.brightsites.co.uk/api/manual-list-search/independent.co.uk?bundle=json_list

Lists

This is a pretty basic endpoint, you can exclude default (Layout Manager) lists.

Example calls

// All list entities for the publication & bundle
https://indy-api-dev.brightsites.co.uk/api/manual-lists/section/independent.co.uk

// All non default list entities for the publication & bundle
    https://indy-api-dev.brightsites.co.uk/api/manual-lists/section/independent.co.uk?default=0

// All non default list entities for the publication & bundle where the type is taxonomy term 123
    https://indy-api-dev.brightsites.co.uk/api/manual-lists/section/independent.co.uk?default=0&typeId=123

Getting a single list

There are bot valid for getting a manual list, I would suggest using the one with the domain name in it.

Example calls

https://indy-api-dev.brightsites.co.uk/api/manual-list/6619/independent.co.uk
https://indy-api-dev.brightsites.co.uk/api/manual-list/6619