Organization
Users and User Groups
    API tokens
    Users - Entity APIs
    Users - Declarative APIs
    UserGroups - Entity APIs
    UserGroups - Declarative APIs
    User Authorization
    User Settings
      List all settings for a usergetPost new user settings for the userpostGet a setting for a usergetPut new user settings for the userputDelete a setting for a userdelete
    User Identifiers
    User management
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

User Settings (3.51)

Endpoint:/

List all settings for a user

GET
/api/v1/entities/users/{userId}/userSettings

List all settings for a user › path Parameters

  • userIdstring · required

List all settings for a user › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

List all settings for a user › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/users/{userId}/userSettings

Post new user settings for the user

POST
/api/v1/entities/users/{userId}/userSettings

Post new user settings for the user › path Parameters

  • userIdstring · required

Post new user settings for the user › Request Body

  • dataobject · required

    JSON:API representation of userSetting entity.

Post new user settings for the user › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userSetting entity.

  • linksobject
POST /api/v1/entities/users/{userId}/userSettings

Get a setting for a user

GET
/api/v1/entities/users/{userId}/userSettings/{id}

Get a setting for a user › path Parameters

  • userIdstring · required
  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get a setting for a user › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get a setting for a user › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userSetting entity.

  • linksobject
GET /api/v1/entities/users/{userId}/userSettings/{id}

Put new user settings for the user

PUT
/api/v1/entities/users/{userId}/userSettings/{id}

Put new user settings for the user › path Parameters

  • userIdstring · required
  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put new user settings for the user › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put new user settings for the user › Request Body

  • dataobject · required

    JSON:API representation of userSetting entity.

Put new user settings for the user › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userSetting entity.

  • linksobject
PUT /api/v1/entities/users/{userId}/userSettings/{id}

Delete a setting for a user

DELETE
/api/v1/entities/users/{userId}/userSettings/{id}

Delete a setting for a user › path Parameters

  • userIdstring · required
  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete a setting for a user › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete a setting for a user › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/users/{userId}/userSettings/{id}
User AuthorizationUser Identifiers