Based on REST principles, the TrendMiner Work Organizer API endpoints provide access to all work created and saved by users like views, searches, formulas, etc.

1. Authentication

All requests to the web API require authentication. This is achieved by sending a valid Bearer access token in the request headers. Request tokens are obtained using OAuth2.0.

Requests to the Work Organizer API can be done authenticated as your client. To do requests, you first need to create a client and request a token.

When you create/update saved items authenticated as your client, they will belong to service-account-CLIENTID.

Make sure you are calling our services over HTTPS when retrieving an access token.

1.1. Creating a new client

A new client can be created in ConfigHub: Security → Clients → Add client

1.2. Retrieving an access token

To retrieve a token to authenticate as your client, you will need:

  • Your client ID

  • Your client secret (can be obtained in ConfigHub)

A token is requested from the token endpoint of the authentication service:

Request
curl --request POST \
  --url 'https://YOUR_DOMAIN/auth/realms/trendminer/protocol/openid-connect/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data client_id=YOUR_CLIENT_ID \
  --data client_secret=YOUR_CLIENT_SECRET

Upon valid authentication, the response will contain an access token.

Response
200 OK
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJwcXZ1UXB...", (1)
  "expires_in": 300,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "not-before-policy": 1571391000,
  "scope": "email profile"
}

  1. The access token is to be used in every request towards our services (see example below). A new token needs to be fetched when the token expires after 5 minutes.

1.3. Doing a request with an access token

Example request with access token
curl --request GET \
  --url 'https://YOUR_DOMAIN/work/[any-api]' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'Authorization: Bearer ACCESS_TOKEN'

2. Resources

2.1. AccessRules

2.1.1. Create an access rule for the saved item.

POST /saveditem/{savedItemId}/accessrule

Parameters

Type

Name

Description

Schema

Path required

savedItemId

The saved item for which to create the access rule

String

Body

required

SavedItemAccessRuleModel

The access rule model.

[SavedItemAccessRuleModel]
Responses

HTTP Code

Description

Schema

404

The resource was not found

AccessRuleResource

201

Created

AccessRuleResource

400

Validation failed

AccessRuleResource

401

Unauthorized

AccessRuleResource
Produces

  • application/json

2.1.2. Delete an access rule for a saved item

DELETE /saveditem/{savedItemId}/accessrule/{accessRuleId}

Parameters

Type

Name

Description

Schema

Path required

savedItemId

The saved item to which the access rule apply

String

Path required

accessRuleId

The identifier of the access rule to delete

UUID
Responses

HTTP Code

Description

Schema

204

No response

String

404

The resource was not found

String

400

Validation failed

String

401

Unauthorized

String
Produces

  • application/json

2.1.3. Get the access rules for a saved item.

GET /saveditem/{savedItemId}/accessrule

Parameters

Type

Name

Description

Schema

Path required

savedItemId

The saved item to which the access rules apply

String
Responses

HTTP Code

Description

Schema

200

OK

List[[AccessRuleResource]]

404

The resource was not found

List[[AccessRuleResource]]

400

Validation failed

List[[AccessRuleResource]]

401

Unauthorized

List[[AccessRuleResource]]
Produces

  • application/json

2.2. AdministrativeTile

2.2.1. Add an image

POST /administrative-tile/image

Parameters

Type

Name

Description

Schema

Query

optional

type

The mimeType of the image.
Responses

HTTP Code

Description

Schema

403

Forbidden

ErrorMessage

200

Ok

404

Resource(s) not found!

401

Unauthorized
Produces

  • /

2.2.2. Delete the image

DELETE /administrative-tile/image

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

200

Ok

403

Forbidden

404

Resource(s) not found!

401

Unauthorized

2.2.3. Retrieve a administrative tile

GET /administrative-tile

Parameters

Type

Name

Description

Schema

Query

optional

ignoreExpirationTime

Ignore the expiration time
Responses

HTTP Code

Description

Schema

200

Ok

AdministrativeTile

404

Resource(s) not found!

AdministrativeTile

401

Unauthorized

AdministrativeTile
Produces

  • application/json

2.2.4. Retrieve the image of the administrative tile

GET /administrative-tile/image

Parameters

Type

Name

Description

Schema

Query

optional

ignoreExpirationTime

Ignore the expiration time
Responses

HTTP Code

Description

Schema

200

Ok

byte[]

404

Resource(s) not found!

byte[]

401

Unauthorized

byte[]
Produces

  • /

2.2.5. Update administrative tile

PUT /administrative-tile

Parameters

Type

Name

Description

Schema

Body

required

AdministrativeTileModel

A model of the item to create

[AdministrativeTileModel]
Responses

HTTP Code

Description

Schema

200

Ok

AdministrativeTile

403

Forbidden

AdministrativeTile

400

Validation failed

AdministrativeTile
Produces

  • application/json

2.3. HomeFolders

2.3.1. Delete home folder and all children items

DELETE /homefolder/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the home folder that will be removed

UUID
Responses

HTTP Code

Description

Schema

204

No content

Object

501

Not yet implemented!

Object

403

Forbidden

Object

404

Resource(s) not found!

Object
Produces

  • /

2.3.2. Retrieve a list of users home folders

POST /homefolder/search

Parameters

Type

Name

Description

Schema

Body

required

SearchHomeFolderRequest

The request API model containing search home folder request and pageable

[SearchHomeFolderRequest]
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelHomeFolderResource

501

Not yet implemented!

PagedModelHomeFolderResource

403

Forbidden

PagedModelHomeFolderResource

404

Resource(s) not found!

PagedModelHomeFolderResource
Produces

  • application/hal+json

2.4. Permissions

2.4.1. Returns a list of permissions for the saved item for the current logged in user

GET /permissions

Parameters

Type

Name

Description

Schema

Query

optional

saved-item-identifier

The identifier of the saved item to fetch permissions.This can be omitted for complex-item-identifier.

Query

optional

complex-item-identifier

The external identifier of the complex item to fetch permissions. This will be ignored if saved-item-identifier is present.
Responses

HTTP Code

Description

Schema

200

Ok

PermissionsResource

403

Forbidden

PermissionsResource

404

Resource not found

PermissionsResource
Produces

  • application/json

2.5. Preferences

2.5.1. Create a new preference

POST /preferences

Parameters

Type

Name

Description

Schema

Body

required

PreferenceModel

A representation of a preference with name and data to create

[PreferenceModel]
Responses

HTTP Code

Description

Schema

201

Created

PreferenceResource

400

Validation failed

PreferenceResource

401

Unauthorized

PreferenceResource
Produces

  • application/json

2.5.2. Delete an existing preference for the logged in user

DELETE /preferences/{name}

Parameters

Type

Name

Description

Schema

Path required

name

The name of an existing preference to delete

String
Responses

HTTP Code

Description

Schema

204

No response

String

405

Method Not Allowed

String

404

Resource(s) not found!

String

400

Validation failed

String

401

Unauthorized

String
Produces

  • application/json

2.5.3. Retrieve an existing preference for the logged in user

GET /preferences/{name}

Parameters

Type

Name

Description

Schema

Path required

name

The name of an existing preference to retrieve

String
Responses

HTTP Code

Description

Schema

200

Ok

PreferenceResource

404

Resource(s) not found!

PreferenceResource

401

Unauthorized

PreferenceResource
Produces

  • application/json

2.5.4. Retrieve all preferences for the logged in user

GET /preferences

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

200

Ok

List[[PreferenceResource]]

401

Unauthorized

List[[PreferenceResource]]
Produces

  • application/json

2.5.5. Store a list of preferences

POST /preferences/store

Parameters

Type

Name

Description

Schema

Body

required

PreferenceModel

A list of preferences to store

[PreferenceModel]
Responses

HTTP Code

Description

Schema

200

Ok

List[[PreferenceResource]]

400

Validation failed

List[[PreferenceResource]]

401

Unauthorized

List[[PreferenceResource]]
Produces

  • application/json

2.5.6. Update a preference

PUT /preferences/{name}

Parameters

Type

Name

Description

Schema

Path required

name

The name of an existing preference to update

String

Body

required

PreferenceModel

A representation of a preference with data to update.<br> The name in this model will be ignored.

[PreferenceModel]
Responses

HTTP Code

Description

Schema

200

Ok

PreferenceResource

405

Method Not Allowed

PreferenceResource

404

Resource(s) not found!

PreferenceResource

400

Validation failed

PreferenceResource

401

Unauthorized

PreferenceResource
Produces

  • application/json

2.6. SavedItemFavorites

2.6.1. Favorite a saved item for the logged in user

POST /favorite

Parameters

Type

Name

Description

Schema

Body

required

SavedItemFavoriteModel

A model of the item to create

[SavedItemFavoriteModel]
Responses

HTTP Code

Description

Schema

200

Ok

SavedItemFavoriteResource

403

Forbidden

SavedItemFavoriteResource

404

Resource not found!

SavedItemFavoriteResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.6.2. List all the favorited saved items for the logged in user

GET /favorite

Parameters

Type

Name

Description

Schema

Query

optional

query

A query string to search.<br/>Only the name and description of the saved item are searched.<br/>Wildcards (*) are supported on all locations.

Query

optional

excludeTypes

A list of saved item types.<br/>These types will be excluded from the result.

Query

optional

includeTypes

A list of saved item types.<br/>The result will only contain these types.

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelSavedItemResource

400

Validation failed

PagedModelSavedItemResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.6.3. Unfavorite a saved item for the logged in user

DELETE /favorite/{savedItemId}

Parameters

Type

Name

Description

Schema

Path required

savedItemId

The identifier of the saved item that needs to be unfavorited.<br/>This identifier should be a valid UUID.

String
Responses

HTTP Code

Description

Schema

204

No response

String

403

Forbidden

String

404

Resource not found!

String
Produces

  • application/json

2.7. SavedItemTypes

2.7.1. Retrieves the details of the specified type

GET /saveditemtype/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The name of the saved item type to retrieve details of

String
Responses

HTTP Code

Description

Schema

200

OK

SavedItemTypeResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.7.2. List all the available saved item types

GET /saveditemtype

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

200

OK

CollectionModelSavedItemTypeResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.8. SavedItems

2.8.1. Browse the contents of a folder

GET /saveditem/browse

Parameters

Type

Name

Description

Schema

Query

optional

parent

The identifier of the folder you want to browse

Query

optional

excludeTypes

A list of saved item types.<br/>These types will be excluded from the result.

Query

optional

includeTypes

A list of saved item types.<br/>The result will only contain these types.

Query

optional

includeData

Set to true to include the full data object in the result.<br/>Defaults to false

Query

optional

foldersOnly

Set to true to only return folders.

Query

optional

homeFolderByUserId

Used to find the home folder by id of user

Query

optional

resolveMostRecentLastUsedInformation

Used to show most recent usage time, instead of time, when user used it

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelSavedItemResource

404

The resource was not found!

PagedModelSavedItemResource

400

Validation failed

PagedModelSavedItemResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.8.2. Copy an existing saved item.

POST /saveditem/{id}/copy

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the existing saved item that will be copied

String

Body

required

SavedItemModel

The API model containing the changes to apply to the copied saved item.<br/>Only the name and/or description can be changed

[SavedItemModel]
Responses

HTTP Code

Description

Schema

404

The resource was not found!

SavedItemResource

403

Forbidden

SavedItemResource

201

Created

SavedItemResource

400

Validation failed

SavedItemResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.8.3. Create a new saved item

POST /saveditem

Parameters

Type

Name

Description

Schema

Body

required

SavedItemModel

A model of the item to create

[SavedItemModel]
Responses

HTTP Code

Description

Schema

201

Created

SavedItemResource

400

Validation failed

SavedItemResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

2.8.4. Delete saved item(s)

DELETE /saveditem/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The id's of the saved items to delete

String
Responses

HTTP Code

Description

Schema

200

OK

DeletedItemsResource

404

The resource was not found!

DeletedItemsResource
Produces

  • application/hal+json

  • application/x-spring-data-compact+json

GET /saveditem/allowed-access

===== Parameters

Type

Name

Description

Schema

Query

optional

user

Query

required

permission

Query

required

type

===== Responses

HTTP Code

Description

Schema

200

OK

ComplexIdList

===== Produces

  • application/json

==== Retrieve the full path of a saved item; including the saved item itself GET /saveditem/{id}/path

===== Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the saved item who's full path needs to be retrieved.<br/>This identifier should be a valid UUID.

String

Query

optional

startingPosition

The identifier of the saved item from which we will start to build the path

===== Responses

HTTP Code

Description

Schema

200

Ok

List[[PathComponentResource]]

403

Forbidden

List[[PathComponentResource]]

404

Resource not found!

List[[PathComponentResource]]

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Retrieve a saved item GET /saveditem/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the saved item to retrieve.<br/>This identifier should be a valid UUID.

String

Query

optional

updateLastUsedInformation

Optionally set this to false to not have the opening logged into LastUsedInformation.<br/>Defaults to true

===== Responses

HTTP Code

Description

Schema

200

Ok

SavedItemResource

403

Forbidden

SavedItemResource

404

Resource(s) not found!

SavedItemResource

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Get hal links to saved items GET /saveditem

===== Parameters

Type Name Description Schema

===== Responses

HTTP Code

Description

Schema

200

Ok

SavedItemHalResource

403

Forbidden

SavedItemHalResource

404

Resource not found!

SavedItemHalResource

===== Produces

  • application/hal+json

==== Move saved item(s) to a folder PUT /saveditem/{id}/move

===== Parameters

Type

Name

Description

Schema

Path required

id

List

Query

optional

destination

The identifier of the destination folder.

===== Responses

HTTP Code

Description

Schema

404

The resource was not found!

Object

204

Ok

Object

406

Duplicate item!

Folder structure invalid!

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Patch a saved item PATCH /saveditem/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the saved item that will be patched

String

Body

required

SavedItemModel

The API model containing the changes to apply to the saved item. Only the extended view properties are checked and the rest will be ignored

[SavedItemModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

SavedItemResource

404

The resource was not found!

SavedItemResource

400

Validation failed

SavedItemResource

406

Duplicate item!

Folder structure invalid!

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Search saved items GET /saveditem/search

===== Parameters

Type

Name

Description

Schema

Query

required

query

A query string to search.<br/>Only the name and description of the saved item are searched.<br/>Wildcards (*) are supported on all locations.

Query

optional

excludeTypes

A list of saved item types.<br/>These types will be excluded from the result.

Query

optional

includeTypes

A list of saved item types.<br/>The result will only contain these types.

Query

optional

includeData

Set to true to include the full data object in the result.<br/>Defaults to false

Query

optional

sharedWithMe

Set to true to filter the results to only show items that are shared with the logged in user.<br/>Defaults to false

Query

optional

includeSharedWithMe

Set to true to also include items in the results, that are shared with the logged in user.<br/>Defaults to false

Query

optional

parent

Needed as entry point for the search. If not provided, the search will start from the top level folder.

Query

optional

homeFolderByUserId

Used to find the home folder by id of user

Query

optional

resolveMostRecentLastUsedInformation

Used to show most recent usage time, instead of time, when user used it

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported.

===== Responses

HTTP Code

Description

Schema

200

Ok

PagedModelSavedItemResource

400

Validation failed

PagedModelSavedItemResource

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Transfer the ownership of a saved item POST /saveditem/{id}/transfer-ownership

===== Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the saved item that will be changing owner

String

Body

required

SavedItemTransferOwnershipModel

The API model containing the details of the new owner.

[SavedItemTransferOwnershipModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

TransferOwnershipResultResource

404

The resource was not found!

TransferOwnershipResultResource

400

Validation failed

TransferOwnershipResultResource

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

==== Update a saved item PUT /saveditem/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the saved item that will be updated

String

Body

required

SavedItemModel

The API model containing the changes to apply to the saved item.

[SavedItemModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

SavedItemResource

404

The resource was not found!

SavedItemResource

400

Validation failed

SavedItemResource

406

Duplicate item!

Folder structure invalid!

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

=== SavedItemsDemo

==== Create demo saved items for a (new) user POST /saveditem/demo

===== Parameters

Type

Name

Description

Schema

Body

required

UserInformationModel

[UserInformationModel]

===== Responses

HTTP Code

Description

Schema

201

Created

Object

400

Validation failed

Object

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

=== SavedItemsExportImport

==== Export saved items GET /export

===== Parameters

Type

Name

Description

Schema

Query

optional

username

The username for which the savedItems need to be exported (default: current user)

===== Responses

HTTP Code

Description

Schema

200

Ok

Object

403

Forbidden

Object

===== Produces

  • /

==== Retrieve the results from the current or last import GET /import/result

===== Parameters

Type Name Description Schema

===== Responses

HTTP Code

Description

Schema

200

Ok

ImportResult

===== Produces

  • /

==== Import saved items POST /import

===== Parameters

Type

Name

Description

Schema

Query

optional

username

The username for which the savedItems need to be imported (default: current user)

Query

optional

skip

when set to true, duplicates will not be imported; when set to false, duplicates will be replaced (default: true)

===== Responses

HTTP Code

Description

Schema

200

Ok

ImportResult

403

Forbidden

ImportResult

===== Produces

  • /

=== Schedule

==== Creates new schedule POST /schedule

===== Parameters

Type

Name

Description

Schema

Body

required

ScheduleModel

A representation of a schedule to create

[ScheduleModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

ScheduleResource

403

Forbidden

ScheduleResource

404

Resource(s) not found!

ScheduleResource

401

Unauthorized

ScheduleResource

===== Produces

  • application/json

==== Delete schedule by it's id DELETE /schedule/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The id of schedule we trying to delete

UUID

===== Responses

HTTP Code

Description

Schema

200

Ok

ScheduleResource

403

Forbidden

ScheduleResource

404

Resource(s) not found!

ScheduleResource

401

Unauthorized

ScheduleResource

===== Produces

  • /

==== Returns the schedule requested by it's id GET /schedule/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The id of schedule we trying to get

UUID

===== Responses

HTTP Code

Description

Schema

200

Ok

ScheduleResource

404

Resource(s) not found!

ScheduleResource

401

Unauthorized

ScheduleResource

===== Produces

  • application/json

==== Returns a list of schedules present in the system GET /schedule

===== Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported.

===== Responses

HTTP Code

Description

Schema

200

Ok

PagedModelScheduleResource

===== Produces

  • application/json

==== Update schedule PUT /schedule/{id}

===== Parameters

Type

Name

Description

Schema

Path required

id

The id of schedule we trying to update

UUID

Body

required

ScheduleModel

A representation of a schedule to with new values

[ScheduleModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

ScheduleResource

403

Forbidden

ScheduleResource

404

Resource(s) not found!

ScheduleResource

401

Unauthorized

ScheduleResource

===== Produces

  • application/json

=== Sessions

==== Create a new session POST /sessions

===== Parameters

Type

Name

Description

Schema

Body

required

SessionModel

A session containing valid JSON data

[SessionModel]

===== Responses

HTTP Code

Description

Schema

201

Created

PreferenceResource

400

Validation failed

PreferenceResource

401

Unauthorized

PreferenceResource

===== Produces

  • application/json

==== Delete an existing session DELETE /sessions/{identifier}

===== Parameters

Type

Name

Description

Schema

Path required

identifier

The short url identifier of the session to delete

String

===== Responses

HTTP Code

Description

Schema

204

No response

Object

405

Method Not Allowed

Object

404

Resource(s) not found!

Object

400

Validation failed

Object

401

Unauthorized

Object

===== Produces

  • application/json

==== Retrieve a session GET /sessions/{identifier}

===== Parameters

Type

Name

Description

Schema

Path required

identifier

The short url identifier of the session to retrieve

String

===== Responses

HTTP Code

Description

Schema

200

Ok

PreferenceResource

404

Resource(s) not found!

PreferenceResource

401

Unauthorized

PreferenceResource

===== Produces

  • application/json

==== Get a session by viewId GET /sessions

===== Parameters

Type

Name

Description

Schema

Query

required

viewId

The viewId of the session

===== Responses

HTTP Code

Description

Schema

200

Ok

PreferenceResource

404

Resource(s) not found!

PreferenceResource

401

Unauthorized

PreferenceResource

===== Produces

  • application/json

=== TransferResults

==== Get a list of all the transfer of ownership results GET /transferresults

===== Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported.

===== Responses

HTTP Code

Description

Schema

200

Ok

PagedModelTransferOwnershipResultResource

403

Forbidden

PagedModelTransferOwnershipResultResource

===== Produces

  • application/hal+json

  • application/x-spring-data-compact+json

=== WeekSetting

==== Retrieve information about current week setting GET /week-setting

===== Parameters

Type Name Description Schema

===== Responses

HTTP Code

Description

Schema

200

Ok

WeekSetting

401

Unauthorized

WeekSetting

===== Produces

  • application/json

==== Update week setting PUT /week-setting

===== Parameters

Type

Name

Description

Schema

Body

required

WeekSettingModel

A model of the setting to update

[WeekSettingModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

WeekSetting

403

Forbidden

WeekSetting

===== Produces

  • application/json

== Models

=== AccessRuleResource

Represents an access rule definition

Field Name Required Type Description Format

identifier

String

The identifier of the access rule.

objectId

X

String

The identifier of the object.

paths

X

List of [string]

An array of paths towards the object.

subjectId

X

String

The identifier of the subject.

subjectType

X

String

The type of the subject: USER, GROUP, EVERYONE, GUEST.

Enum: GUEST, EVERYONE, GROUP, USER,

permissions

X

Set of [string]

A set of permissions the subject has on the specified object. Can be an empty set.

Enum:

userDetailsResource

UserDetailsResource

_links

Map of [Link]

=== AdministrativeTile

API model of the administrative tile

Field Name Required Type Description Format

messageTitle

String

A message title for administrative tile

messageParagraph

String

A message paragraph for administrative tile

contactInformation

String

A contact information for administrative tile

lastModifiedDate

Date

A last modified time for administrative tile

date-time

isActive

Boolean

A flag to indicate if administrative tile is active

expirationTime

Date

Expiration time

date-time

_links

Map of [Link]

=== AdministrativeTileModel

Field Name Required Type Description Format

messageTitle

String

A message title for administrative tile

messageParagraph

String

A message paragraph for administrative tile

contactInformation

String

A contact information for administrative tile

isActive

Boolean

A flag to indicate if administrative tile is active

expirationTime

Date

Expiration time

date-time

=== CollectionModelSavedItemTypeResource

Field Name Required Type Description Format

_embedded

CollectionModelSavedItemTypeResource__embedded

_links

Map of [Link]

=== CollectionModelSavedItemTypeResourceEmbedded

Field Name Required Type Description Format

savedItemTypeResourceList

List of [SavedItemTypeResource]

=== ComplexIdList

Field Name Required Type Description Format

complexItemIds

List of [string]

=== DeletedItemsResource

Object to describe the saved items that were deleted

Field Name Required Type Description Format

identifiers

List of [string]

The identifiers of the deleted items

_links

Map of [Link]

=== ErrorMessage

Represents a tm-context exception

Field Name Required Type Description Format

statusCode

HttpStatusCode

errorCode

String

The specific error code of the exception

message

String

The exception message

details

Object

The details of the exception

=== HomeFolderResource

Field Name Required Type Description Format

identifier

String

The identifier of the saved item.<br/>This identifier is a UUID.

type

String

The type of the saved item.<br/>The type indicates what can be stored in the data property.

Enum: SIMILARITY_SEARCH, VALUE_BASED_SEARCH, CROSS_ASSET_VALUE_BASED_SEARCH, DIGITAL_STEP_SEARCH, AREA_SEARCH, FINGERPRINT, LEGACY_FINGERPRINT, VIEW, TREND_HUB_2_VIEW, FILTER, CONTEXT_LOGBOOK_VIEW, FORMULA, AGGREGATION, DASHBOARD, MONITOR, MACHINE_LEARNING, PREDICTIVE, TOTALIZER, CUSTOM_CALCULATIONS, NOTEBOOK, PIPELINE,

name

String

The name of the saved item.

description

String

The description of the saved item.

data

Map of [object]

A Json Object representing the content of the saved item.<br/>This content is specific to the saved item type.<br/>The data is, by default, only available when retrieving a single saved item.<br/>This behaviour can be overridden in lists by explicitly providing &quot;includeData&quot; in the request URL.

extendedViewProperties

Map of [string]

Key value pairs representing the extended view properties of the saved item.<br/>This content is specific to the saved item type.

lastModifiedDate

Date

The UTC date when the saved item was last modified.

date-time

folder

Boolean

true if the saved item is a folder; false otherwise.

shared

Boolean

true if the saved item is shared; false otherwise.

favorite

Boolean

true if the saved item is favorited; false otherwise.

owner

String

The name of the saved item's owner.

ownerUuid

String

The UUID of the saved item's owner.

ownerUserDetails

UserDetailsResource

parentId

String

The UUID of the folder where this saved item can be found.<br/>This folder is a saved item.

permissions

Set of [string]

A list of permissions on the saved item for the current logged in user.<br/>Possible permissions:<br/>* SAVED_ITEM_NO_PERMISSIONS - The item can not be accessed;<br/>* SAVED_ITEM_READ_ITEM - The item can be read;<br/>* SAVED_ITEM_WRITE_ITEM - The item can be updated.

lastUsedInformation

LastUsedInformationResource

complexId

String

The UUID of the complex identifier where the complex data of the saved item can be found.

_links

Map of [Link]

=== HttpStatusCode

The httpStatus code of the exception

Field Name Required Type Description Format

error

Boolean

is4xxClientError

Boolean

is5xxServerError

Boolean

is1xxInformational

Boolean

is2xxSuccessful

Boolean

is3xxRedirection

Boolean

=== ImportFailure

Field Name Required Type Description Format

fileLocation

String

typeOfFailure

String

message

String

itemIdentifier

String

itemName

String

itemType

String

itemLocation

List of [string]

=== ImportResult

Field Name Required Type Description Format

identifier

UUID

uuid

inProgress

Boolean

startTime

String

endTime

String

severeFailure

ImportFailure

totalOfItemsSuccessfullyImported

Integer

int32

totalOfItemsFailedToImport

Integer

int32

totalOfSkippedItems

Integer

int32

totalOfReplacedItems

Integer

int32

failureDetails

List of [ImportFailure]

itemsSkipped

List of [string]

itemsReplaced

List of [string]

=== LastUsedInformationResource

Details about the way a saved item was last used

Field Name Required Type Description Format

timestamp

Date

Time of last interaction

date-time

type

String

Type of interaction

Enum: CREATED, OPENED, MODIFIED, SHARED,
Field Name Required Type Description Format

href

String

hreflang

String

title

String

type

String

deprecation

String

profile

String

name

String

templated

Boolean

=== LocalTime

The start time of schedule.

Field Name Required Type Description Format

hour

Integer

int32

minute

Integer

int32

second

Integer

int32

nano

Integer

int32

=== PageMetadata

Field Name Required Type Description Format

size

Long

int64

totalElements

Long

int64

totalPages

Long

int64

number

Long

int64

=== PagedModelHomeFolderResource

Field Name Required Type Description Format

_embedded

PagedModelHomeFolderResource__embedded

_links

Map of [Link]

page

PageMetadata

=== PagedModelHomeFolderResourceEmbedded

Field Name Required Type Description Format

content

List of [HomeFolderResource]

=== PagedModelSavedItemResource

Field Name Required Type Description Format

_embedded

PagedModelSavedItemResource__embedded

_links

Map of [Link]

page

PageMetadata

=== PagedModelSavedItemResourceEmbedded

Field Name Required Type Description Format

content

List of [SavedItemResource]

=== PagedModelScheduleResource

Field Name Required Type Description Format

_embedded

PagedModelScheduleResource__embedded

_links

Map of [Link]

page

PageMetadata

=== PagedModelScheduleResourceEmbedded

Field Name Required Type Description Format

content

List of [ScheduleResource]

=== PagedModelTransferOwnershipResultResource

Field Name Required Type Description Format

_embedded

PagedModelTransferOwnershipResultResource__embedded

_links

Map of [Link]

page

PageMetadata

=== PagedModelTransferOwnershipResultResourceEmbedded

Field Name Required Type Description Format

transferOwnershipResultResourceList

List of [TransferOwnershipResultResource]

=== PathComponentResource

The definition of a path component = subset of a savedItem resource

Field Name Required Type Description Format

identifier

String

The identifier of the saved item.<br/>This identifier is a UUID.

parentId

String

The UUID of the folder where this saved item can be found.<br/>This folder is a saved item.

type

String

The type of the saved item.

Enum: SIMILARITY_SEARCH, VALUE_BASED_SEARCH, CROSS_ASSET_VALUE_BASED_SEARCH, DIGITAL_STEP_SEARCH, AREA_SEARCH, FINGERPRINT, LEGACY_FINGERPRINT, VIEW, TREND_HUB_2_VIEW, FILTER, CONTEXT_LOGBOOK_VIEW, FORMULA, AGGREGATION, DASHBOARD, MONITOR, MACHINE_LEARNING, PREDICTIVE, TOTALIZER, CUSTOM_CALCULATIONS, NOTEBOOK, PIPELINE,

folder

Boolean

true if the saved item is a folder; false otherwise.

name

String

The name of the saved item.

description

String

The description of the saved item.

_links

Map of [Link]

=== PermissionsResource

Describes a list of permissions

Field Name Required Type Description Format

permissions

List of [string]

The list of permissions

owner

String

username that owns this item

ownerId

String

userid that owns this item

_links

Map of [Link]

=== PreferenceModel

API model of a preference

Field Name Required Type Description Format

name

X

String

A unique name for the preference

data

X

Object

JSON object containing the definition of the preference

=== PreferenceResource

Represents a saved user preference

Field Name Required Type Description Format

name

String

The name of the preference

data

Object

JSON object containing the definition of the preference

_links

Map of [Link]

=== SavedItemAccessRuleModel

API model for an access rule on a SavedItem

Field Name Required Type Description Format

subjectId

String

The identifier of the subject for which to grant the access rule

subjectType

X

String

The type of the subject

Enum: GUEST, EVERYONE, GROUP, USER,

permissions

X

Set of [string]

The set of permissions

Enum:

autoGenerated

Boolean

=== SavedItemFavoriteModel

API model for favoriting a saved item

Field Name Required Type Description Format

savedItemId

String

The identifier of the saved item.<br/>This identifier is a UUID.

=== SavedItemFavoriteResource

A reference to a saved item

Field Name Required Type Description Format

savedItemIdentifier

String

The identifier of the related saved item.<br/>This identifier is a UUID.

_links

Map of [Link]

=== SavedItemHalResource

The response containing HAL links for a saved item

Field Name Required Type Description Format

_links

Map of [Link]

=== SavedItemModel

API model for creation or modification of a saved item

Field Name Required Type Description Format

id

String

The identifier of the saved item.<br/>This identifier is a UUID.

parentId

String

The UUID of the folder where this saved item can be found.<br/>This folder is a saved item.<br/>When empty, the saved item will be saved in the most top level.

type

String

The type of the saved item.<br/>The type indicates what can be stored in the data property.

Enum: SIMILARITY_SEARCH, VALUE_BASED_SEARCH, CROSS_ASSET_VALUE_BASED_SEARCH, DIGITAL_STEP_SEARCH, AREA_SEARCH, FINGERPRINT, LEGACY_FINGERPRINT, VIEW, TREND_HUB_2_VIEW, FILTER, CONTEXT_LOGBOOK_VIEW, FORMULA, AGGREGATION, DASHBOARD, MONITOR, MACHINE_LEARNING, PREDICTIVE, TOTALIZER, CUSTOM_CALCULATIONS, NOTEBOOK, PIPELINE,

name

X

String

The name of the savedItem

description

String

The description of the savedItem

data

Map of [object]

A Json Object representing the content of the saved item.<br/>This content is specific to the saved item type.

extendedViewProperties

Map of [string]

Key value pairs representing the extended view properties of the saved item.<br/>This content is specific to the saved item type.

folder

Boolean

true if the saved item is a folder; false otherwise.<br/>A folder can not contain data nor a type.<br/>As a result, both the data and type property will be ignored when a folder is saved.

=== SavedItemResource

The definition of a saved item

Field Name Required Type Description Format

identifier

String

The identifier of the saved item.<br/>This identifier is a UUID.

type

String

The type of the saved item.<br/>The type indicates what can be stored in the data property.

Enum: SIMILARITY_SEARCH, VALUE_BASED_SEARCH, CROSS_ASSET_VALUE_BASED_SEARCH, DIGITAL_STEP_SEARCH, AREA_SEARCH, FINGERPRINT, LEGACY_FINGERPRINT, VIEW, TREND_HUB_2_VIEW, FILTER, CONTEXT_LOGBOOK_VIEW, FORMULA, AGGREGATION, DASHBOARD, MONITOR, MACHINE_LEARNING, PREDICTIVE, TOTALIZER, CUSTOM_CALCULATIONS, NOTEBOOK, PIPELINE,

name

String

The name of the saved item.

description

String

The description of the saved item.

data

Map of [object]

A Json Object representing the content of the saved item.<br/>This content is specific to the saved item type.<br/>The data is, by default, only available when retrieving a single saved item.<br/>This behaviour can be overridden in lists by explicitly providing &quot;includeData&quot; in the request URL.

extendedViewProperties

Map of [string]

Key value pairs representing the extended view properties of the saved item.<br/>This content is specific to the saved item type.

lastModifiedDate

Date

The UTC date when the saved item was last modified.

date-time

folder

Boolean

true if the saved item is a folder; false otherwise.

shared

Boolean

true if the saved item is shared; false otherwise.

favorite

Boolean

true if the saved item is favorited; false otherwise.

owner

String

The name of the saved item's owner.

ownerUuid

String

The UUID of the saved item's owner.

ownerUserDetails

UserDetailsResource

parentId

String

The UUID of the folder where this saved item can be found.<br/>This folder is a saved item.

permissions

Set of [string]

A list of permissions on the saved item for the current logged in user.<br/>Possible permissions:<br/>* SAVED_ITEM_NO_PERMISSIONS - The item can not be accessed;<br/>* SAVED_ITEM_READ_ITEM - The item can be read;<br/>* SAVED_ITEM_WRITE_ITEM - The item can be updated.

lastUsedInformation

LastUsedInformationResource

complexId

String

The UUID of the complex identifier where the complex data of the saved item can be found.

_links

Map of [Link]

=== SavedItemTransferOwnershipModel

API model for changing the owner of a saved item

Field Name Required Type Description Format

transferee

String

The identifier of the new owner.<br/>This identifier is a UUID.

=== SavedItemTypeResource

Represents a SavedItemType definition

Field Name Required Type Description Format

name

String

description

String

category

String

_links

Map of [Link]

=== ScheduleModel

Field Name Required Type Description Format

identifier

UUID

The identifier of the schedule.

uuid

timeZone

X

ScheduleModel_timeZone

startDay

X

String

Start day of schedule.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

name

X

String

The name of the schedule.

startTime

X

LocalTime

numberOfWorkingDays

X

Integer

The number of working days in schedule.

int32

nameOfShifts

X

List of [string]

Name of shifts in schedule.

type

X

String

Type fo schedule.

Enum: FIXED,

duration

X

String

Duration of shift.

Enum: 4H, 6H, 8H, 12H,

=== ScheduleModelTimeZone

The time zone of the schedule.

Field Name Required Type Description Format

id

String

rules

ScheduleModel_timeZone_rules

=== ScheduleModelTimeZoneRules

Field Name Required Type Description Format

fixedOffset

Boolean

transitions

List of [ScheduleModel_timeZone_rules_transitions]

transitionRules

List of [ScheduleModel_timeZone_rules_transitionRules]

=== ScheduleModelTimeZoneRulesDuration

Field Name Required Type Description Format

seconds

Long

int64

zero

Boolean

nano

Integer

int32

negative

Boolean

units

List of [ScheduleModel_timeZone_rules_duration_units]

=== ScheduleModelTimeZoneRulesDurationUnits

Field Name Required Type Description Format

durationEstimated

Boolean

timeBased

Boolean

dateBased

Boolean

=== ScheduleModelTimeZoneRulesOffsetBefore

Field Name Required Type Description Format

totalSeconds

Integer

int32

id

String

=== ScheduleModelTimeZoneRulesTransitionRules

Field Name Required Type Description Format

month

String

Enum: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER,

timeDefinition

String

Enum: UTC, WALL, STANDARD,

standardOffset

ScheduleModel_timeZone_rules_offsetBefore

offsetBefore

ScheduleModel_timeZone_rules_offsetBefore

offsetAfter

ScheduleModel_timeZone_rules_offsetBefore

dayOfWeek

String

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

dayOfMonthIndicator

Integer

int32

localTime

LocalTime

midnightEndOfDay

Boolean

=== ScheduleModelTimeZoneRulesTransitions

Field Name Required Type Description Format

offsetBefore

ScheduleModel_timeZone_rules_offsetBefore

offsetAfter

ScheduleModel_timeZone_rules_offsetBefore

duration

ScheduleModel_timeZone_rules_duration

gap

Boolean

dateTimeAfter

Date

date-time

dateTimeBefore

Date

date-time

instant

Date

date-time

overlap

Boolean

=== ScheduleResource

Represents a schedule definition

Field Name Required Type Description Format

identifier

UUID

The identifier of the schedule.

uuid

timeZone

X

ScheduleResource_timeZone

startDay

X

String

Start day of schedule.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

name

X

String

The name of the schedule.

startTime

X

LocalTime

numberOfWorkingDays

X

Integer

The number of working days in schedule.

int32

nameOfShifts

X

List of [string]

Name of shifts in schedule.

type

X

String

Type of schedule.

Enum: FIXED,

duration

X

String

Duration of shift.

Enum: 4H, 6H, 8H, 12H,

_links

Map of [Link]

=== ScheduleResourceTimeZone

The time zone of the schedule.

Field Name Required Type Description Format

id

String

rules

ScheduleModel_timeZone_rules

=== SearchHomeFolderRequest

Field Name Required Type Description Format

userId

List of [UUID]

Collection of user identifiers for searching for their home folders

uuid

=== SessionModel

API model of a session

Field Name Required Type Description Format

data

X

Object

JSON object containing the definition of the preference

=== TransferOwnershipResultResource

Represents the result of an ownership transfer of a SavedItem

Field Name Required Type Description Format

savedItemId

UUID

The identifier of the saved item.<br/>This identifier is a UUID.

uuid

initiator

UUID

The identifier of the transfer initiator.<br/>This identifier is a UUID.

uuid

transferor

UUID

The identifier of the original owner of the saved item.<br/>This identifier is a UUID.

uuid

transferee

UUID

The identifier of the new owner of the saved item.<br/>This identifier is a UUID.

uuid

status

String

The status that resulted from the transfer of ownership action.

Enum: SUCCESS, FAILED,

_links

Map of [Link]

=== UserDetailsResource

Details about a user

Field Name Required Type Description Format

userId

String

Unique identifier

userName

String

Username

firstName

String

First name

lastName

String

Last name

=== UserInformationModel

Field Name Required Type Description Format

userUuid

String

The uuid of the owner of the new demo tag

=== WeekSetting

API model of the week setting

Field Name Required Type Description Format

startOfWeek

String

Start day of week

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

startOfWorkweek

String

Start day of workweek

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

workweekDuration

Integer

Duration of workweek

int32

_links

Map of [Link]

=== WeekSettingModel

Field Name Required Type Description Format

startOfWeek

String

Start of week

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

startOfWorkweek

String

Start of workweek

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY,

workweekDuration

Integer

Duration of workweek

int32

Download PDF version | Download OpenAPI specifications