1. 42 Api 2.0
  2. Clusters
  3. index

GET /v2/clusters
Return all the clusters

live_help Notes

assignment This action requires one of theses roles: Basic staff
chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
sort optional . Must be one of: id, name, campus_id, created_at, updated_at, image.

The sort field. Sorted by created_at desc, id desc by default.

Example:

To sort on clusters on the fields updated_at on a descending order and image on a ascending order: 

...&sort=-updated_at,image
filter optional . Must be one of: id, name, campus_id, created_at, updated_at, image.

Filtering on one or more fields

Example:

To filter on clusters with the id field matching a_value or another_value: 

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • name (standard field)
  • campus_id (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • image (standard field)
page optional . Must be a Hash

The pagination params, as a hash
page[number] optional . Must be Fixnum

The current page
page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100
cluster optional , nil allowed . Must be a Hash
cluster[name] optional . Must be String

The name.
cluster[campus_id] optional . Must be Fixnum

The campus id.
cluster[image] optional , nil allowed . Must be File

The image.