GET /api/users/:user_id/table_preferences
List of table preferences for a user

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

search
optional

filter results

Validations:

  • String

order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.


GET /api/users/:user_id/table_preferences/:name
Table preference details of a given table

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

name
required

Name of the table

Validations:

  • String


POST /api/users/:user_id/table_preferences
Creates a table preference for a given table

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

name
required

Name of the table

Validations:

  • String

columns
required

List of user selected columns

Validations:

  • Must be an array of any type


PUT /api/users/:user_id/table_preferences/:name
Updates a table preference for a given table

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

name
required

Name of the table

Validations:

  • String

columns
required

List of user selected columns

Validations:

  • Must be an array of any type


DELETE /api/users/:user_id/table_preferences/:name
Delete a table preference for a given table

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

name
required

Name of the table

Validations:

  • String