User Preferences
Get the user preferences for a specified user
GET
request returns the user preferences for the specified user.
Path Parameters
Parameter | Description |
---|---|
|
The user locator for the user whose preferences are requested . |
Request Parameters
Parameter | Description |
---|---|
|
The authentication token. |
|
Specifies the fields to return in the response. One or more of |
Response Fields
Path | Type | Description |
---|---|---|
|
|
The object resource locator of the requested user preferences. |
|
|
Status of the response. One of: |
|
|
The identity of the user preference. |
|
|
The default search path set for the user. |
|
|
The user’s storage preferences. |
|
|
The object resource locator of the workspace where user generated artifacts are stored. |
|
|
The object resource locator of the workspace where temporal user generated artifacts are stored. This is reserved for system use. |
|
|
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:771c6823-32c1-4c33-8408-eb3c06602996",
"temporaryWorkspace" : "object:!tenant:defaultTenant~workspace:1e94af54-352a-4327-a607-b3b65616033f",
"clipboardId" : "User Preference"
},
"defaultSearchPathSet" : "object:!tenant:defaultTenant~search-path-set:search-path-set-id"
}
} ]
}
}