Skip to main content

GetWorkspaceSettings

Gets the settings for the specified workspace.

Description

  • Obtains information on each setting configured for the specified workspace.
  • Not available to users without workspace access (403:Forbidden).

Method

GET

Request URL Format

/api/v0/workspaces/:workspace-id

URL Params

workspace-id Specifies the workspace ID to be acquired

Query Params

None

Request URL Sample

GET https://api.xxx.com/api/v0/workspaces/58ca3597cce5fe3ea0a42fa8

Response Sample

{
"id": "624bea3a879f4e8d8b5dcc6c",
"w_id": "624bea3a879f4e8d8b5dcc6c",
"plan_id": "624b9e14879f4e8d8b5dcc65",
"plan_name": "Free Plan",
"ws_admin": [
"624be35e879f4e8d8b5dcc6a",
"62b9451468805f4d4381229d"
],
"ws_admin_users": [
{
"user_id": "624be35e879f4e8d8b5dcc6a",
"email": "[email protected]",
"user_name": "hexabase1",
"access_key": "624bea3a879f4e8d8b5dcc6b",
"media_link": "https://storage.googleapis.com/linker/pub/default.png"
},
{
"user_id": "62b9451468805f4d4381229d",
"email": "[email protected]",
"user_name": "hexabase2",
"access_key": "62b946ab68805f4d4381229f",
"media_link": "https://storage.googleapis.com/linker/pub/default.png"
}
],
"user_id": "624be35e879f4e8d8b5dcc6a",
"name": "My Workspace",
"ws_usage": {
"datastores": 5,
"users": 3,
"storage_size": 5,
"items": 100
},
"languages": [
{
"lang_cd": "en",
"use": true
},
{
"lang_cd": "ja",
"use": true,
"default": true
}
],
"pwd_policy": {
"expired_day": 30,
"lockout_count": 5,
"lockout_time": 5,
"min_length": 6,
"max_length": 12,
"pattern_check_type": 1,
"same_limit": 2,
"use_expired_day": false,
"use_lockout_count": false,
"use_lockout_time": false,
"use_min_length": false,
"use_max_length": false,
"use_pattern_check": false,
"use_same_limit": false,
"use_language_en": true,
"use_language_ja": true
},
"user_code_settings": {
"min_length": 6,
"max_length": 10,
"pattern_check_type": 1,
"use_min_length": true,
"use_max_length": true,
"use_pattern_check": true
},
"user_sessions": {
"session_timeout_sec": 0
},
"ws_functions": {
"ws_settings": {
"disable_change_name": false,
"disable_change_logo": false,
"disable_manage_admins": false,
"disable_archive": false,
"disable_password_policy": true,
"disable_global_search": false
},
"group_settings": {
"disable_new_group": false,
"disable_group_import": false,
"disable_user_import": false,
"disable_group_roles": false
},
"developer_functions": {
"disable_developer_mode": false,
"disable_beta": false,
"disable_generate_token": false,
"show_access_keys": 0
},
"task_queue": {
"show_task_list": 1
},
"new_workspaces": {
"new_workspace": 2
}
},
"app_functions": {
"app_settings": {
"disable_change_name": false,
"disable_role_settings": false,
"disable_left_menu_extension": false,
"disable_program_extension": false,
"disable_delete_application": false,
"enable_action_validation": true,
"enable_field_values_validation": true
},
"app_templates": {
"disable_new_application": false,
"disable_save_templates": true
},
"dashboards": {
"disable_edit_dashboards": false,
"disable_edit_dash_items": false
},
"data_reports": {
"disable_edit_reports": false,
"disable_save_reports": true,
"disable_csv_downloads": false
},
"datastores": {
"disable_db_settings": false,
"disable_grid_view": false,
"disable_borad_view": false,
"disable_status_update": false,
"disable_query": false
},
"csv_import": {
"disable_csv_update": false,
"disable_replace_import": false,
"use_qr_download": false
},
"item_view": {
"disable_pagination": true,
"disable_change_layouts": false,
"disable_edit_statuses": false,
"disable_edit_fields": false,
"disable_edit_actions": false,
"hide_link_items": false,
"disable_pin_items": false
}
},
"redirect": {
"is_apply_redirect_url_for_disabled_users": false,
"redirect_url": ""
},
"created_at": "2022-04-05T07:05:30.311Z",
"updated_at": "2022-10-20T01:44:14.041Z"
}

Errors

  • If the logged-in user cannot use the specified workspace, a 403 error will be generated.