Skip to content

webui_user_setting

Store web UI settings for the current user

Delete

Path
DELETE /v7.0/webui_user_settings/{namespace}/{key}
Description
Delete a web UI setting
Authentication required
yes
Scope
webui_user_setting#delete
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/webui_user_settings
Description
List web UI settings for the current user
Authentication required
yes
Scope
webui_user_setting#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
webui_user_setting
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
namespace
Namespace
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • forms
  • tips
  • ui

Validation error message: %{value} cannot be used

Format

Must match this regular expression:

\A[a-z0-9_.-]+\z

null

Validation error message: %{value} is not in a valid format

Length
  • Maximum length: 75 characters (inclusive).

Validation error message: length must be at most 75
key
Key
 String no

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[a-z0-9_.-]+\z

null

Validation error message: %{value} is not in a valid format

Length
  • Maximum length: 100 characters (inclusive).

Validation error message: length must be at most 100

Output parameters

Layout
object_list
Namespace
webui_user_settings
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
namespace
Namespace
 String
key
Key
 String
value
Value
 Custom
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Set

Path
PUT /v7.0/webui_user_settings/{namespace}/{key}
Description
Create or update a web UI setting
Authentication required
yes
Scope
webui_user_setting#set
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
webui_user_setting
ParameterTypeRequiredDetails
value
Value
 Custom yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
webui_user_setting
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
namespace
Namespace
 String
key
Key
 String
value
Value
 Custom
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/webui_user_settings/{namespace}/{key}
Description
Show a web UI setting
Authentication required
yes
Scope
webui_user_setting#show
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
webui_user_setting
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
namespace
Namespace
 String
key
Key
 String
value
Value
 Custom
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime