User Preferences

Get the user preferences for a specified user

GET request returns the user preferences for the specified user.

Path Parameters

Table 1. /api/v3/users/{userLocator}/userpreferences
Parameter Description

userLocator

The user locator for the user whose preferences are requested .

Request Parameters

Parameter Description

ltk

The authentication token.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

Response Fields

Path Type Description

data.objects[].locator

String

The object resource locator of the requested user preferences.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the user preference.

data.objects[].object.defaultSearchPathSet

String

The default search path set for the user.

data.objects[].object.storagePreference

Object

The user’s storage preferences.

data.objects[].object.storagePreference.defaultWorkspace

String

The object resource locator of the workspace where user generated artifacts are stored.

data.objects[].object.storagePreference.temporaryWorkspace

String

The object resource locator of the workspace where temporal user generated artifacts are stored. This is reserved for system use.

data.objects[].object.storagePreference.clipboardId

String

The identity of the user’s clipboard. This is reserved for system use.

Example request

GET /api/v3/users/object:!tenant:defaultTenant~user:user-id/userpreferences?ltk=AUTHENTICATION_TOKEN&fields=object HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 644

{
  "status" : "OK",
  "data" : {
    "objects" : [ {
      "locator" : "object:!tenant:defaultTenant~user:user-id~userpreference:user-preference-id-001",
      "object" : {
        "id" : "user-preference-id-001",
        "storagePreference" : {
          "defaultWorkspace" : "object:!tenant:defaultTenant~workspace:6d1c42a7-283a-4ccc-a90f-0d1613a1efc2",
          "temporaryWorkspace" : "object:!tenant:defaultTenant~workspace:33ca2d00-6878-4eea-8384-93cad6f6d6e9",
          "clipboardId" : "User Preference"
        },
        "defaultSearchPathSet" : "object:!tenant:defaultTenant~search-path-set:search-path-set-id"
      }
    } ]
  }
}