1. Standard Services

1.1. AnnouncementService

List of Methods

archiveAnnouncements, countAnnouncements, retrieveAnnouncements

1.1.1. archiveAnnouncements

URL

${jsonUrl}/announcements/{ids}

Method

DELETE

Description

Archive elements.

Parameters

ids

Path Variable

List<UUID>

identifiers of the elements to archive

Response Body

List<DTO<UUID>>

a list of the remaining elements

1.1.2. countAnnouncements

URL

${jsonUrl}/announcements/count

Method

GET

Description

Count announcement for a user.

Parameters

no parameters

Response Body

AnnouncementCountDTO

count of announcement for the user

1.1.3. retrieveAnnouncements

URL

${jsonUrl}/announcements

Method

GET

Description

Retrieves announcement for a user.

Parameters

no parameters

Response Body

List<DTO<UUID>>

an list of announcement for the user

1.2. ApplicationService

Application’s Remoting service.

List of Methods

userInfos, retrieveHelpLinks, retrieveHelpLinksFromRoomId, retrieveHelpLinksFromDomainId, retrieveSystemAssets, retrieveSystemAssetsByCategory, retrieveSystemAssetsByName, retrieveSystemAssetsCategories, retrieveLicenseInfo, getTime

1.2.1. userInfos

URL

${jsonUrl}/application/myInfos

Method

GET

Description

Gets information about a user.

Parameters

no parameters

Response Body

UserDTO

the user information as a UserDTO

URL

${jsonUrl}/application/helpLinks

Method

GET

Description

Retrieves all help links.

Parameters

no parameters

Response Body

List<HelpLinkDTO>

an array of all help links

1.2.3. retrieveHelpLinksFromRoomId

URL

${jsonUrl}/application/room/{roomId}/helpLinks

Method

GET

Description

Retrieves the help links for a given room.

Parameters

roomId

Path Variable

String

the room’s identifier

Response Body

List<HelpLinkDTO>

an array of the room’s help links

1.2.4. retrieveHelpLinksFromDomainId

URL

${jsonUrl}/application/domain/{domainId}/helpLinks

Method

GET

Description

Retrieves the help links for a given domain.

Parameters

domainId

Path Variable

String

the domain’s identifier

Response Body

List<HelpLinkDTO>

an array of the domain’s help links

1.2.5. retrieveSystemAssets

URL

${jsonUrl}/application/{key}/systemAssets

Method

GET

Description

Retrieves the system assets of a given collection.

Parameters

key

Path Variable

String

the collection’s key

Response Body

List<AssetDTO>

an array of the corresponding assets

1.2.6. retrieveSystemAssetsByCategory

URL

${jsonUrl}/application/{key}/systemAssets?category

Method

GET

Description

Retrieves the system assets of a given category in a given collection.

Parameters

key

Path Variable

String

the collection’s key

category

Request Param

String

the category’s name

Response Body

List<AssetDTO>

an array of the corresponding assets

1.2.7. retrieveSystemAssetsByName

URL

${jsonUrl}/application/{key}/systemAssets?name

Method

GET

Description

Retrieves the system assets with a given name in a given collection.

Parameters

key

Path Variable

String

the collection’s key

name

Request Param

String

the asset’s name

Response Body

List<AssetDTO>

an array of the corresponding assets

1.2.8. retrieveSystemAssetsCategories

URL

${jsonUrl}/application/{key}/assetsCategories

Method

GET

Description

Retrieves all the system asset categories in a given collection.

Parameters

key

Path Variable

String

the collection’s key

Response Body

List<String>

an array of the category keys

1.2.9. retrieveLicenseInfo

URL

${jsonUrl}/application/licenseInfo

Method

GET

Description

Retrieves license’s information.

Parameters

no parameters

Response Body

LicenseInfoDTO

the license’s information as a LicenseInfoDTO

1.2.10. getTime

URL

${jsonUrl}/application/time

Method

GET

Description

Gets the current server’s date.

Parameters

no parameters

Response Body

Date

the current server’s date as a Date

1.3. AssetContainerService

List of Methods

create, findByIds, update, delete, remove, undelete

1.3.1. create

URL

${jsonUrl}/assetContainers

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<AssetContainerDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.3.2. findByIds

URL

${jsonUrl}/assetContainers/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<AssetContainerDTO>

a list of the found elements DTOs

1.3.3. update

URL

${jsonUrl}/assetContainers

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<AssetContainerDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.3.4. delete

URL

${jsonUrl}/assetContainers/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.3.5. remove

URL

${jsonUrl}/assetContainers/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.3.6. undelete

URL

${jsonUrl}/assetContainers/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.4. AssetService

Service for loading assets (images, pdf, documents .. etc)

List of Methods

findByContainer, clone, upload, uploadData, endUpload, cancelUpload, create, findByIds, update, delete, remove, undelete

1.4.1. findByContainer

URL

${jsonUrl}/assets?container

Method

GET

Description

Finds assets in a container (that is a room).

Parameters

container

Request Param

String

the container’s id

Response Body

List<AssetDTO>

an array of the container’s assets

1.4.2. clone

URL

${jsonUrl}/assets/clone

Method

PUT

Description

Clones assets.

The only field required and kept in the DTOs of dtos is id, all the other ones are ignored and copied from the source (excepted for modifier and modificationDate that are automatically set).

The field id in the dtos can either be:

- an existing identifier to replace the asset with the corresponding identifier,

- or a new identifier to create a new asset with this new identifier.

If a source identifier doesn’t exist, there won’t be any value for it in the result. The order of elements in the result is not guaranteed.

Parameters

params

Request Body

CloneParamDTO<AssetDTO>

the source identifiers and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones’s DTOs, all of class AssetDTO

1.4.3. upload

URL

${jsonUrl}/assets/upload?file&tempId

Method

POST

Description

Uploads an image and binds it to a temporary file identifier.

This temporary file identifier can then be used in a subsequent call to the #endUpload method.

Parameters

file

Request Param

MultipartFile

file to upload

tempId

Request Param

String

the identifier the uploaded file will be bound to

Response Body

void

1.4.4. uploadData

URL

${jsonUrl}/assets/uploadData?assetId

Method

POST

Description

Uploads an image and registers it as an asset.

Parameters

dataStr

Request Body

String

file to upload

assetId

Request Param

String

the identifier of the asset to update with data

Response Body

AssetDTO

the asset

1.4.5. endUpload

URL

${jsonUrl}/assets/end?tempId

Method

POST

Description

Ends the image upload by finally registering it as an asset.

Parameters

tempId

Request Param

String

the identifier of the temporary file to register as an asset

assetDTO

Request Body

AssetDTO

the DTO of the asset to create

Response Body

AssetDTO

the asset

1.4.6. cancelUpload

URL

${jsonUrl}/assets/cancel

Method

POST

Description

cancel upload images.

Parameters

tempIds

Request Body

List<String>

ids of temp files to delete

Response Body

void

1.4.7. create

URL

${jsonUrl}/assets

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<AssetDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.4.8. findByIds

URL

${jsonUrl}/assets/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<AssetDTO>

a list of the found elements DTOs

1.4.9. update

URL

${jsonUrl}/assets

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<AssetDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.4.10. delete

URL

${jsonUrl}/assets/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.4.11. remove

URL

${jsonUrl}/assets/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.4.12. undelete

URL

${jsonUrl}/assets/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.5. AsyncService

This service can be used to transform a long blocking request in an asynchronous request with minimal change.

List of Methods

waitRequest, downloadResult

1.5.1. waitRequest

URL

${jsonUrl}/async/{id}

Method

GET

Description

Wait for the request with given id to be ready (up to a timeout).

Parameters

id

Path Variable

String

request id returned in AsyncResponse of #asyncHandle.

Response Body

DeferredResult<Object>

A DeferredResult or null when the request id is not found. The deferred result resolves to: <ul> <li>an AsyncResponse in case of timeout,</li> <li>a DownloadResult when the result should be downloaded,</li> <li>or any final result.</li> </ul>

1.5.2. downloadResult

URL

${jsonUrl}/async/{id}/download

Method

GET

Description

Download result if previous result was a DownloadResult.

Parameters

id

Path Variable

String

Ther request id.

Response Body

void

1.6. AuthClientService

Auth client service.

List of Methods

findApplicationInstancesByType, findUserAccessTokenByApplication, checkUserAccessTokenAvailability, getApplicationInstancesByBaseUrl, getApplicationInstanceById, invalidateAccessToken

1.6.1. findApplicationInstancesByType

URL

${jsonUrl}/oauthClient/applicationInstances?applicationType&roomId

Method

GET

Description

Filter application instances by application type and domain if exist.

Parameters

applicationType

Request Param

String

application type

(roomId)

Request Param

String

(optional) room identified

Response Body

List<OauthApplicationInstanceDTO>

list of application instances

1.6.2. findUserAccessTokenByApplication

URL

${jsonUrl}/oauthClient/accessToken?applicationInstanceId&null

Method

GET

Description

Find a user access token from application instance id.

Parameters

applicationInstanceId

Request Param

String

identifier of application instance

null

Request Param

Map<String, String>

specific parameters to use in oauth authorization url

Response Body

OauthTokenResponseDTO

an access token or oauth authorization request parameters in order to init an oauth dance

1.6.3. checkUserAccessTokenAvailability

URL

${jsonUrl}/oauthClient/checkAccessToken?applicationInstanceId

Method

GET

Description

Simply check if there is a valid user access token or valid refresh token and set the access token in user session.

Parameters

applicationInstanceId

Request Param

String

identifier of application instance

Response Body

Boolean

true if there is a valid access token or a valid refresh token

1.6.4. getApplicationInstancesByBaseUrl

URL

${jsonUrl}/oauthClient/applicationInstance/getByBaseUrl?baseUrl

Method

GET

Description

Get Identifier by application instance URL.

Parameters

baseUrl

Request Param

String

base url used to find the identifier

Response Body

List<OauthApplicationInstanceDTO>

a list of application instance

1.6.5. getApplicationInstanceById

URL

${jsonUrl}/oauthClient/applicationInstance/getByIdentifier?applicationInstanceId

Method

GET

Description

Get base url by application instance identifier.

Parameters

applicationInstanceId

Request Param

String

application instance identifier used to find the base url

Response Body

OauthApplicationInstanceDTO

application instance

1.6.6. invalidateAccessToken

URL

${jsonUrl}/oauthClient/invalidateAccessToken?applicationInstanceId

Method

PUT

Description

Invalidate current user access token for a specific application instance.

Parameters

applicationInstanceId

Request Param

String

application instance ID

Response Body

Boolean

true if the access token has been invalidated successfully

1.7. BoardChildService

Board children service.

List of Methods

findChildrenByContainer, create, findByIds, update, delete, remove, undelete

1.7.1. findChildrenByContainer

URL

${jsonUrl}/boardChildren?container&class

Method

GET

Description

Finds all children (of a given class) in a board element.

Parameters

container

Request Param

String

the identifier of the board element

(class)

Request Param

String

(optional) the class name of the elements that should be retrieved

Response Body

List<BoardChildDTO>

an array of the children in the board element

1.7.2. create

URL

${jsonUrl}/boardChildren

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<BoardChildDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.7.3. findByIds

URL

${jsonUrl}/boardChildren/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardChildDTO>

a list of the found elements DTOs

1.7.4. update

URL

${jsonUrl}/boardChildren

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardChildDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.7.5. delete

URL

${jsonUrl}/boardChildren/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.7.6. remove

URL

${jsonUrl}/boardChildren/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.7.7. undelete

URL

${jsonUrl}/boardChildren/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.8. BoardDockService

Board Dock Service.

List of Methods

findByIds, update

1.8.1. findByIds

URL

${jsonUrl}/docks/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardDockDTO>

a list of the found elements DTOs

1.8.2. update

URL

${jsonUrl}/docks

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardDockDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.9. BoardElementChildService

Board element children service.

List of Methods

findChildrenByElement, findChildrenByElements, create, findByIds, update, delete, remove, undelete

1.9.1. findChildrenByElement

URL

${jsonUrl}/elementChildren?elementId&class

Method

GET

Description

Finds all children (of a given class) in a board element.

Parameters

elementId

Request Param

String

the identifier of the board element

(class)

Request Param

String

(optional) the class name of the elements that should be retrieved

Response Body

List<BoardElementChildDTO>

an array of the children in the board element

1.9.2. findChildrenByElements

URL

${jsonUrl}/elementChildren?elementIds&class

Method

GET

Description

Finds all children (of a given class) using board element ids.

Parameters

elementIds

Request Param

List<String>

the identifier of the board elements

(class)

Request Param

String

(optional) the class name of the elements that should be retrieved

Response Body

List<BoardElementChildDTO>

an array of the children in the board elements

1.9.3. create

URL

${jsonUrl}/elementChildren

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<BoardElementChildDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.9.4. findByIds

URL

${jsonUrl}/elementChildren/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardElementChildDTO>

a list of the found elements DTOs

1.9.5. update

URL

${jsonUrl}/elementChildren

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardElementChildDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.9.6. delete

URL

${jsonUrl}/elementChildren/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.9.7. remove

URL

${jsonUrl}/elementChildren/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.9.8. undelete

URL

${jsonUrl}/elementChildren/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.10. BoardElementService

BoardElement’s Remoting service.

List of Methods

move, rotate, moveElementsWithContext, resize, clone, findByContainer, updateChartAsset, createFromDataItems, updateFromDataItems, createBoardImages, countMyElements, findMyCreatedElements, findMyElements, getBoardElementContainers, assignUsersTo, loadDetails, desynchronize, synchronizedClone, updateCollectionCounts, findDetailedCollectionItems, updateMasterInCollectionItem, instantiateCollectionItems, findNavigableSyncElements, countNavigableSyncElements, apply, addToCollection, removeFromCollection, applyDiffToCollectionItem, create, findByIds, update, delete, remove, undelete

1.10.1. move

URL

${jsonUrl}/elements/move

Method

GET

Description

Moves elements.

Parameters

movedElements

Request Body

List<BoardElementDTO>

DTOs to update

Response Body

List<DTO<String>>

an array of the updated elements after the charts generation

1.10.2. rotate

URL

${jsonUrl}/elements/rotate

Method

GET

Description

Rotates elements.

Parameters

rotatedElements

Request Body

List<BoardElementDTO>

DTOs to update

Response Body

List<DTO<String>>

an array of the updated elements after the charts generation

1.10.3. moveElementsWithContext

URL

${jsonUrl}/elements/moveWithContext?context

Method

GET

Description

Move board elements with context.

Parameters

movedElements

Request Body

List<BoardElementDTO>

DTOs of board elements to move.

(context)

Request Param

String

(optional) context name to use in command.

Response Body

List<DTO<String>>

moved elements.

1.10.4. resize

URL

${jsonUrl}/elements/resize

Method

GET

Description

Resizes elements.

Parameters

dtos

Request Body

List<BoardElementDTO>

DTOs to update

Response Body

List<DTO<String>>

an array of the updated elements

1.10.5. clone

URL

${jsonUrl}/elements/clone

Method

GET

Description

Clones board elements as well as their children and any asset they may reference.

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- always from the dto: x, y, zOrder, score

- from the dto if not null, otherwise from the source: isAnchored

- from the dto if not null, otherwise generated: id

- (for synchronizable elements) from the dto if same as source, otherwise null: syncInfo

- (for customizable elements) from the dto if present, otherwise from the source: all direct children of props - always from the source: the remaining fields

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (the board elements, their children and the assets, all of class BoardElementDTO or AssetDTO)

1.10.6. findByContainer

URL

${jsonUrl}/elements?container

Method

GET

Description

Finds the board elements in a container (that is an ElementContainer).

Parameters

container

Request Param

String

the container’s identifier

Response Body

List<BoardElementDTO>

an array of the corresponding board elements

1.10.7. updateChartAsset

URL

${jsonUrl}/elements/updateAsset

Method

GET

Description

Updates elements of chart.

Parameters

dtos

Request Body

List<BoardElementDTO>

DTOs to update

Response Body

List<DTO<String>>

an array of the updated elements after the charts generation

1.10.8. createFromDataItems

URL

${jsonUrl}/elements/fromItem

Method

GET

Description

Create a board element from a data source item.

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

A clone param with a list of data source item ids and a list of board element dto.

Response Body

List<DTO<String>>

Created elements DTO.

1.10.9. updateFromDataItems

URL

${jsonUrl}/elements/updateItem

Method

GET

Description

Update a board element according to its linked data source items.

Parameters

dtos

Request Body

List<BoardElementDTO>

DTO of board elements to synchronise.

Response Body

List<DTO<String>>

Updated elements.

1.10.10. createBoardImages

URL

${jsonUrl}/elements/addImages

Method

GET

Description

Add board images from uploaded files.

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

A clone param with a list of uploaded file ids and a list of board image dto.

Response Body

List<DTO<String>>

Created elements DTO.

1.10.11. countMyElements

URL

${jsonUrl}/elements/countMyElements?className

Method

GET

Description

Counts all my elements or all my elements of a given class.

Parameters

(className)

Request Param

String

(optional) the class name of the assignable elements to be taken into account

Response Body

int

nb of elements assigned to me.

1.10.12. findMyCreatedElements

URL

${jsonUrl}/elements/elementsOfUser?className&entityTypes&pageNb&nbResults

Method

GET

Description

Retrieves all elements created by me.

Parameters

(className)

Request Param

String

(optional) the class name of the assignable elements to be taken into account.

(entityTypes)

Request Param

List<String>

(optional) if provided, returns only elements of these entity types.

(pageNb)

Request Param

Integer

(optional)

(nbResults)

Request Param

Integer

(optional)

Response Body

List<AssignableElementDTO>

all elements created by me.

1.10.13. findMyElements

URL

${jsonUrl}/elements/myElements?className&pageNb&nbResults

Method

GET

Description

Retrieves all my elements or all my elements of a given class.

Parameters

(className)

Request Param

String

(optional) the class name of the assignable elements to be taken into account.

(pageNb)

Request Param

Integer

(optional)

(nbResults)

Request Param

Integer

(optional)

Response Body

List<AssignableElementDTO>

all elements assigned to me.

1.10.14. getBoardElementContainers

URL

${jsonUrl}/elements/boardElementContainers?id

Method

GET

Description

Returns the BoardElementContainersDTO of the board element.

Parameters

id

Request Param

String

the id of the board element.

Response Body

BoardElementContainersDTO

A BoardElementContainersDTO which contains information on the containers : board, room, permission.

1.10.15. assignUsersTo

URL

${jsonUrl}/elements/{id}/assign?usernames

Method

GET

Description

Replaces assigned users for an element. Removes all assignments if usernames request param is omitted.

Parameters

id

Path Variable

String

the assignable element identifier

(usernames)

Request Param

List<String>

(optional) the users' usernames to be assigned to the given assignable element.

Response Body

boolean

true if succeeded.

1.10.16. loadDetails

URL

${jsonUrl}/elements/{id}/details

Method

GET

Description

Loads details.

Parameters

id

Path Variable

String

the assignable element’s identifier.

Response Body

List<DTO<String>>

an array of the DTOs. (element + child + board + room)

1.10.17. desynchronize

URL

${jsonUrl}/elements/desynchronize

Method

GET

Description

Desynchronizes synchronized elements.

Parameters

elementIds

Request Body

List<String>

the synchronized element’s identifiers.

Response Body

List<DTO<String>>

an array of the DTOs. (card + syncInfo)

1.10.18. synchronizedClone

URL

${jsonUrl}/elements/syncclone

Method

GET

Description

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

Response Body

List<DTO<String>>

1.10.19. updateCollectionCounts

URL

${jsonUrl}/elements/updateCollectionCounts

Method

GET

Description

Updates collection counters for given elements.

Parameters

elementIds

Request Body

List<String>

the element’s identifiers.

Response Body

List<DTO<String>>

an array of the element DTOs. (card + syncInfo)

1.10.20. findDetailedCollectionItems

URL

${jsonUrl}/elements/detailedCollectionItems?elementId

Method

GET

Description

Finds all collection items of a board element, and their details.

Parameters

elementId

Request Param

String

the identifier of the board element

Response Body

List<DTO<String>>

an array of the collection items of the board element, and their details

1.10.21. updateMasterInCollectionItem

URL

${jsonUrl}/elements/collectionItem/{id}

Method

GET

Description

Update master from collection item having given id.

Parameters

id

Path Variable

String

id of the collectionItem whose master will be updated

masterDTO

Request Body

BoardElementDTO

dto of the updated master

Response Body

List<DTO<String>>

the ServiceResultDTO for the updated master

1.10.22. instantiateCollectionItems

URL

${jsonUrl}/elements/instantiateCollectionItems

Method

GET

Description

Instantiates element collection items.

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

CloneParamDTO where CloneParamDTO#getIds() are the ids of the BoardElementCollectionItemDTO to instantiate and CloneParamDTO#getDtos() are the BoardElementDTO of the target elements to instantiate from these collection items.

Response Body

List<DTO<String>>

A list of changed DTOs.

1.10.23. findNavigableSyncElements

URL

${jsonUrl}/elements/navigableSyncElements?elementId

Method

GET

Description

Find all navigable synchronized elements.

Parameters

elementId

Request Param

String

the identifier of the board element.

Response Body

List<NavigableSyncElementDTO>

an array of the navigable synchronized elements.

1.10.24. countNavigableSyncElements

URL

${jsonUrl}/elements/countNavigableSyncElements?elementId

Method

GET

Description

Count the number of all navigable synchronized elements.

Parameters

elementId

Request Param

String

the identifier of the board element.

Response Body

int

number of the navigable synchronized elements.

1.10.25. apply

URL

${jsonUrl}/elements/{id}/apply

Method

GET

Description

Updates the board element using a diff of modified element attributes.

Parameters

id

Path Variable

String

the id of the board element.

diff

Request Body

ObjectNode

json data containing the attributes to update.

Response Body

void

1.10.26. addToCollection

URL

${jsonUrl}/elements/addToCollection

Method

GET

Description

adds an element in another element collection.

Parameters

request

Request Body

AddToCollectionParamDTO

dto containing the parent element master id, the parent instance id

and a list of AbstractSyncElementReferenceDTO references to elements to be added to collection

Response Body

void

1.10.27. removeFromCollection

URL

${jsonUrl}/elements/removeFromCollection

Method

GET

Description

removes elements from another element collection.

Parameters

request

Request Body

RemoveFromCollectionParamDTO

dto containing the parent element master id, the parent instance id

and a list of elements ids to be removed from the collection

Response Body

void

1.10.28. applyDiffToCollectionItem

URL

${jsonUrl}/elements/updateCollectionItem

Method

GET

Description

Update master from collection item having given id.

Parameters

diff

Request Body

ObjectNode

object node contains updates to be applied to master and the master id

Response Body

void

1.10.29. create

URL

${jsonUrl}/elements

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<BoardElementDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.10.30. findByIds

URL

${jsonUrl}/elements/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardElementDTO>

a list of the found elements DTOs

1.10.31. update

URL

${jsonUrl}/elements

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardElementDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.10.32. delete

URL

${jsonUrl}/elements/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.10.33. remove

URL

${jsonUrl}/elements/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.10.34. undelete

URL

${jsonUrl}/elements/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.11. BoardImageService

List of Methods

replaceImage

1.11.1. replaceImage

URL

${jsonUrl}/boardImages/replaceImage

Method

GET

Description

Resizes elements.

Parameters

dtos

Request Body

List<BoardElementDTO>

DTOs to update

Response Body

List<DTO<String>>

an array of the updated elements

1.12. BoardImageServiceImpl

List of Methods

replaceImage

1.12.1. replaceImage

URL

/replaceImage

Method

GET

Description

Parameters

arg0

Request Body

List<BoardElementDTO>

Response Body

List<DTO<String>>

1.13. BoardService

Board’s remoting service.

List of Methods

clone, cloneAsync, updateProperties, updatePropertiesAsync, findByContainer, findByContainers, loadDetails, loadDetailsSince, findElementsByClassAndUser, reorderElements, getDockToolSets, getDockToolSets, findMyTopBoards, resetBoardHits, incrementBoardHits, getNextZOrder, visualExport, visualExportAsync, tsvExport, exportBoard, exportElements, tsvExportForIds, exportElementsForIds, tsvReportExport, tsvReportExportForIds, tsvImport, importElementsAsync, importElements, create, createAsync, update, updateAsync, downloadBackgrounds, addImageToBoard, findByIds, delete, remove, undelete

1.13.1. clone

URL

${jsonUrl}/boards/clone

Method

PUT

Description

Clones boards. Most of the boards details will be cloned with the boards.

The background asset is cloned if it was user-provided (not a default background).

Usage of each field in the DTOs of dtos: - ignored and automatically set: modificationDate, modifier, background, screenshot, hasControl

- always from the dto: x, y and isModel

- from the dto if not null, otherwise from the source: name

- from the dto if not null, otherwise generated: id

- shareStatus is reset if the source board has a linked board, otherwise it is set from the DTO.

- always from the source: all the other fields.

Parameters

params

Request Body

CloneParamDTO<BoardDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (the boards), as well as the boards and wall categories moved to make room for these new boards, all of class BoardDTO or WallCategoryDTO, and one instance of DeletedEntityDTO<String> for each source that had been deleted

1.13.2. cloneAsync

URL

${jsonUrl}/boards/clone

Method

PUT

Description

Clones boards. Most of the boards details will be cloned with the boards.

The background asset is cloned if it was user-provided (not a default background).

Usage of each field in the DTOs of dtos: - ignored and automatically set: modificationDate, modifier, background, screenshot, hasControl

- always from the dto: x, y and isModel

- from the dto if not null, otherwise from the source: name

- from the dto if not null, otherwise generated: id

- shareStatus is reset if the source board has a linked board, otherwise it is set from the DTO.

- always from the source: all the other fields.

Parameters

params

Request Body

CloneParamDTO<BoardDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

AsyncResponse

an array of all the clones' DTOs (the boards), as well as the boards and wall categories moved to make room for these new boards, all of class BoardDTO or WallCategoryDTO, and one instance of DeletedEntityDTO<String> for each source that had been deleted

1.13.3. updateProperties

URL

${jsonUrl}/boards/updateProperties?needScreenshot

Method

PUT

Description

Update board’s properties.

Parameters

board

Request Body

BoardDTO

the board.

(needScreenshot)

Request Param

boolean

(optional)

Response Body

List<DTO<String>>

the board dto.

1.13.4. updatePropertiesAsync

URL

${jsonUrl}/boards/updateProperties?needScreenshot

Method

PUT

Description

Update board’s properties.

Parameters

board

Request Body

BoardDTO

the board.

(needScreenshot)

Request Param

boolean

(optional)

Response Body

AsyncResponse

the board dto.

1.13.5. findByContainer

URL

${jsonUrl}/boards?container

Method

GET

Description

Finds boards in a given container (that is a room).

Note that this method returns all boards of the container, board models included.

Parameters

container

Request Param

String

the container’s identifier

Response Body

List<BoardDTO>

an array of the corresponding boards

1.13.6. findByContainers

URL

${jsonUrl}/boards?containers

Method

GET

Description

Finds boards in all the given containers.

Note that this method does not return board models.

Parameters

containers

Request Param

String[]

the container' identifiers

Response Body

Map<String, List<BoardDTO>>

a map which key is the id of the room and the value is the list of boards of the room

1.13.7. loadDetails

URL

${jsonUrl}/boards/{id}/details

Method

GET

Description

Loads all the elements contained in a board (including itself).

Parameters

id

Path Variable

String

the board’s identifier

Response Body

List<DTO<String>>

an array of the DTOs contained in the board with identifier id

1.13.8. loadDetailsSince

URL

${jsonUrl}/boards/{id}/details?since

Method

GET

Description

Loads all the elements contained in a board (including itself) and whose last modification occurred after the given date.

Parameters

id

Path Variable

String

the board’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the corresponding DTOs contained in the board with identifier id

1.13.9. findElementsByClassAndUser

URL

${jsonUrl}/boards/{id}/elements?since&className&userName

Method

GET

Description

Loads all the board elements contained in a board and whose last modification occurred after the given date.

Parameters

id

Path Variable

String

the board’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

className

Request Param

String

the class name of board element

userName

Request Param

String

the user’s name

Response Body

List<DTO<String>>

an array of the elements DTOs contained in the board with identifier id

1.13.10. reorderElements

URL

${jsonUrl}/boards/{id}/reorderElements?since&className&reconciliationType&toolSetItemsIds

Method

GET

Description

Reorder all the board elements contained in a board after the given date.

Parameters

id

Path Variable

String

the board’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

className

Request Param

String

the class name of board element

reconciliationType

Request Param

String

the reconciliation type by which board elements will be grouped

toolSetItemsIds

Request Param

List<String>

the list of tool set item ids in order.

Response Body

List<DTO<String>>

an array of the ordered elements DTOs contained in the board with identifier id

1.13.11. getDockToolSets

URL

${jsonUrl}/boards/{id}/docktoolsets

Method

GET

Description

Returns the toolset of the board with identifier id.

Parameters

id

Path Variable

String

the board’s identifier

Response Body

List<DockToolSetDTO>

an array of the DockToolSetDTO of the board with identifier id

1.13.12. getDockToolSets

URL

${jsonUrl}/boards/docktoolsets?ids

Method

GET

Description

Returns the toolset of the board with identifier id.

Parameters

ids

Request Param

String[]

the boards' identifiers

Response Body

Map<String, List<DockToolSetDTO>>

an array of the DockToolSetDTO of the board with identifier id

1.13.13. findMyTopBoards

URL

${jsonUrl}/boards/myTopBoards?nbResults

Method

GET

Description

Finds the favorite boards of the logged user.

Parameters

(nbResults)

Request Param

Integer

(optional) the maximum number of expected results

Response Body

List<BoardViewDTO>

an array of the favorite boards of the logged user

1.13.14. resetBoardHits

URL

${jsonUrl}/boards/resetMyHits?boardId&nbResults

Method

POST

Description

Resets the number of views for a board.

Parameters

boardId

Request Param

String

the board’s identifier

(nbResults)

Request Param

Integer

(optional)

Response Body

List<BoardViewDTO>

an array of the new favorite boards of the logged user

1.13.15. incrementBoardHits

URL

${jsonUrl}/boards/incrementMyHits?boardId

Method

POST

Description

Increments the number of views for a board.

Parameters

boardId

Request Param

String

the board’s identifier

Response Body

boolean

true if it succeeded, false if not

1.13.16. getNextZOrder

URL

${jsonUrl}/boards/{id}/nextZOrder

Method

GET

Description

Return next z order to use for board elements.

Parameters

id

Path Variable

String

the board’s identifier

Response Body

int

z order to use.

1.13.17. visualExport

URL

${jsonUrl}/boards/{id}/visualExport?f

Method

GET

Description

Gets board screenshot as a file.

Parameters

id

Path Variable

String

the board identifier

(f)

Request Param

String

(optional)

Response Body

void

1.13.18. visualExportAsync

URL

${jsonUrl}/boards/{id}/visualExport?f

Method

GET

Description

Gets board screenshot as a file.

Parameters

id

Path Variable

String

the board identifier

(f)

Request Param

String

(optional)

Response Body

AsyncResponse

1.13.19. tsvExport

URL

${jsonUrl}/boards/{id}/tsvExport?exportedClassNames&headerOldNames&headerNewNames

Method

GET

Description

Returns all the board’s elements that are instances of the specified classes as a csv file.

Parameters

id

Path Variable

String

the board’s identifier

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

void

1.13.20. exportBoard

URL

${jsonUrl}/boards/{id}/exportBoard?exportedClassNames&headerOldNames&headerNewNames

Method

GET

Description

Returns the board its elements and its tools a csv file.

Parameters

id

Path Variable

String

the board’s identifier

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

void

1.13.21. exportElements

URL

${jsonUrl}/boards/{id}/exportElements?exportedClassNames&headerOldNames&headerNewNames

Method

GET

Description

Returns all the board’s elements that are instances of the specified classes as a csv file.

Parameters

id

Path Variable

String

the board’s identifier

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

void

1.13.22. tsvExportForIds

URL

${jsonUrl}/boards/{id}/tsvExport?ids&exportedClassNames&headerOldNames&headerNewNames

Method

POST

Description

Returns the specified board’s elements that are instances of the specified classes as csv file.

Parameters

(ids)

Request Param

List<String>

(optional) A comma separated list of the board elements identifiers.

id

Path Variable

String

the board’s identifier.

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names.

(headerOldNames)

Request Param

List<String>

(optional) the old column names.

(headerNewNames)

Request Param

List<String>

(optional) the new column names.

Response Body

void

1.13.23. exportElementsForIds

URL

${jsonUrl}/boards/{id}/exportElements?ids&exportedClassNames&headerOldNames&headerNewNames

Method

POST

Description

Returns the specified board’s elements that are instances of the specified classes as csv file.

Parameters

(ids)

Request Param

List<String>

(optional) A comma separated list of the board elements identifiers.

id

Path Variable

String

the board’s identifier.

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names.

(headerOldNames)

Request Param

List<String>

(optional) the old column names.

(headerNewNames)

Request Param

List<String>

(optional) the new column names.

Response Body

void

1.13.24. tsvReportExport

URL

${jsonUrl}/boards/{id}/tsvReportExport

Method

GET

Description

Returns all the board’s elements as a csv file.

Parameters

id

Path Variable

String

the board’s identifier

Response Body

void

1.13.25. tsvReportExportForIds

URL

${jsonUrl}/boards/{id}/tsvReportExport?ids

Method

POST

Description

Returns the specified board’s elements as a csv file.

Parameters

(ids)

Request Param

List<String>

(optional) A comma separated list of the board elements identifiers.

id

Path Variable

String

the board’s identifier.

Response Body

void

1.13.26. tsvImport

URL

${jsonUrl}/boards/{id}/tsvImport?file&headerOldNames&headerNewNames

Method

POST

Description

Imports csv file.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the board’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

ImportReportDTO

a report as an ImportReportDTO

1.13.27. importElementsAsync

URL

${jsonUrl}/boards/{id}/importElements?file&headerOldNames&headerNewNames

Method

GET

Description

Imports elements as csv file.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the board’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

AsyncResponse

a report as an ImportReportDTO

1.13.28. importElements

URL

${jsonUrl}/boards/{id}/importElements?file&headerOldNames&headerNewNames

Method

GET

Description

Imports elements as csv file.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the board’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

ImportReportDTO

a report as an ImportReportDTO

1.13.29. create

URL

${jsonUrl}/boards

Method

GET

Description

Creates boards.

Parameters

dtos

Request Body

List<BoardDTO>

the Boards to create

Response Body

List<DTO<String>>

a list of the effectively created boards DTOs

1.13.30. createAsync

URL

${jsonUrl}/boards

Method

GET

Description

Creates boards.

Parameters

dtos

Request Body

List<BoardDTO>

the Boards to create

Response Body

AsyncResponse

a list of the effectively created boards DTOs

1.13.31. update

URL

${jsonUrl}/boards

Method

GET

Description

Updates boards.

Parameters

dtos

Request Body

List<BoardDTO>

the borards to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.13.32. updateAsync

URL

${jsonUrl}/boards

Method

GET

Description

Updates board.

Parameters

dtos

Request Body

List<BoardDTO>

the boards to update

Response Body

AsyncResponse

an array of the effectively updated elements DTOs

1.13.33. downloadBackgrounds

URL

${jsonUrl}/boards/backgrounds/download

Method

GET

Description

Parameters

no parameters

Response Body

void

1.13.34. addImageToBoard

URL

${jsonUrl}/boards/{id}/board-images

Method

GET

Description

Add existing asset to board.

Parameters

id

Path Variable

String

the board where asset will be added

boardImage

Request Body

BoardImageDTO

the infos about the asset to add

Response Body

DTO<String>

an object of the effectively created BoardElement

1.13.35. findByIds

URL

${jsonUrl}/boards/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardDTO>

a list of the found elements DTOs

1.13.36. delete

URL

${jsonUrl}/boards/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.13.37. remove

URL

${jsonUrl}/boards/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.13.38. undelete

URL

${jsonUrl}/boards/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.14. BoardSharedElementService

Shared element Remoting service.

List of Methods

findByContainer, loadDetails, loadDetails, restoreSharedElement, undoShare, create, findByIds, update, delete, remove, undelete

1.14.1. findByContainer

URL

${jsonUrl}/boardShared?container

Method

GET

Description

Finds the shared elements of a board (that is the elements in the board’s trash).

Parameters

container

Request Param

String

the container’s id

Response Body

List<BoardSharedElementDTO>

the elements in the trash

1.14.2. loadDetails

URL

${jsonUrl}/boardShared/{id}/details

Method

GET

Description

Loads all the elements contained in a board’s shared element (including itself).

Parameters

id

Path Variable

String

identifier of the board’s shared element

Response Body

List<DTO<String>>

an array of the DTOs contained in the board shared element with identifier id

1.14.3. loadDetails

URL

${jsonUrl}/boardShared/{id}/details?since

Method

GET

Description

Loads all the elements contained in a board’s shared element (including itself) and whose last modification occurred after the given date.

Parameters

id

Path Variable

String

identifier of the board’s shared element

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the corresponding DTOs contained in the board share with identifier id

1.14.4. restoreSharedElement

URL

${jsonUrl}/boardShared/{id}/unshare?containerId&offsetX&offsetY

Method

PUT

Description

Restores the elements from a shared element to the given position within the given container.

Parameters

id

Path Variable

String

the board shared element’s identifier

containerId

Request Param

String

identifier of the container in which the elements will be restored

offsetX

Request Param

int

X coordinate of the position where the upper left corner will be restored

offsetY

Request Param

int

Y coordinate of the position where the upper left corner will be restored

Response Body

List<DTO<String>>

an array of the changed elements' DTOs

1.14.5. undoShare

URL

${jsonUrl}/boardShared/{id}/undo

Method

POST

Description

Undoes shared element creation. Removes the shared element from the board, and restores the board elements from this shared element into their original board (with same id).

Parameters

id

Path Variable

String

the identifier of the shared element whose creation should be undone

originalIds

Request Body

List<String>

the identifiers of the original elements to restore

Response Body

List<DTO<String>>

an array of DTOs of the changed elements

1.14.6. create

URL

${jsonUrl}/boardShared

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<BoardSharedElementDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.14.7. findByIds

URL

${jsonUrl}/boardShared/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardSharedElementDTO>

a list of the found elements DTOs

1.14.8. update

URL

${jsonUrl}/boardShared

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardSharedElementDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.14.9. delete

URL

${jsonUrl}/boardShared/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.14.10. remove

URL

${jsonUrl}/boardShared/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.14.11. undelete

URL

${jsonUrl}/boardShared/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.15. BoardSharingProposalService

Board’s remoting service.

List of Methods

addSharedBoardToRoom, refuse, takeControlOf, filterSharingProposalsByBoard, filterMySharingProposals, create, findByIds, update, delete, remove, undelete

1.15.1. addSharedBoardToRoom

URL

${jsonUrl}/boardProposals/{id}/accept

Method

PUT

Description

Accepts a board sharing proposal and adds the shared board to the room.

Parameters

boardDTO

Request Body

BoardDTO

the DTO of the new board

id

Path Variable

String

identifier of the board sharing

Response Body

List<DTO<String>>

an array of the modified DTOs as a side effect of the board addition in the room

1.15.2. refuse

URL

${jsonUrl}/boardProposals/{ids}/refuse

Method

PUT

Description

Declines a board sharing proposal.

Parameters

ids

Path Variable

List<String>

an array of the boards' ids to remove

Response Body

List<DTO<String>>

an array of the updated board sharing proposals' DTOs

1.15.3. takeControlOf

URL

${jsonUrl}/boardProposals/{id}/takeControl

Method

POST

Description

Takes control of a shared board.

Parameters

id

Path Variable

String

identifier of the board link to control

since

Request Body

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the DTOs of all the elements in the board which have been modified after since

1.15.4. filterSharingProposalsByBoard

URL

${jsonUrl}/boardProposals?boardId

Method

GET

Description

Filters sharing proposals by board.

Parameters

boardId

Request Param

String

the board id needed to filter

Response Body

List<BoardSharingProposalDTO>

an array of the DTOs of the sharing proposals which concern the given board

1.15.5. filterMySharingProposals

URL

${jsonUrl}/boardProposals/mine

Method

GET

Description

Retrieves the sharing proposals from the current user.

Parameters

no parameters

Response Body

List<DTO<String>>

an array of the DTOs of the sharing proposals from the current user

1.15.6. create

URL

${jsonUrl}/boardProposals

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<BoardSharingProposalDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.15.7. findByIds

URL

${jsonUrl}/boardProposals/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<BoardSharingProposalDTO>

a list of the found elements DTOs

1.15.8. update

URL

${jsonUrl}/boardProposals

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<BoardSharingProposalDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.15.9. delete

URL

${jsonUrl}/boardProposals/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.15.10. remove

URL

${jsonUrl}/boardProposals/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.15.11. undelete

URL

${jsonUrl}/boardProposals/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.16. BoardSizeService

BoardSize remoting service.

List of Methods

findAll, findByIds, findCompatibleSizes

1.16.1. findAll

URL

${jsonUrl}/boardSizes

Method

GET

Description

Finds all board sizes.

Parameters

no parameters

Response Body

List<BoardSizeDTO>

an array of all the board sizes

1.16.2. findByIds

URL

${jsonUrl}/boardSizes/{ids}

Method

GET

Description

Finds board sizes by their identifiers.

Parameters

ids

Path Variable

List<String>

the board size’s identifiers we are searching for

Response Body

List<BoardSizeDTO>

an array of the corresponding board sizes

1.16.3. findCompatibleSizes

URL

${jsonUrl}/boardSizes/sizes/{id}

Method

GET

Description

Finds compatible sizes for a given board.

Parameters

id

Path Variable

String

the board’s identifier

Response Body

List<BoardSizeDTO>

an array of the board sizes compatible with the board

1.17. CatalogService

Catalog Remoting service.

List of Methods

loadDetails, loadDetailsSince, loadDefault, create, findByIds, update, delete, remove, undelete

1.17.1. loadDetails

URL

${jsonUrl}/catalogs/{id}/details

Method

GET

Description

Loads all the elements contained in a catalog (including itself).

Parameters

id

Path Variable

String

the catalog’s identifier

Response Body

List<DTO<String>>

an array of the DTOs contained in the catalog with identifier id

1.17.2. loadDetailsSince

URL

${jsonUrl}/catalogs/{id}/details?since

Method

GET

Description

Loads all the elements contained in a catalog (including itself) and whose last modification occurred after the given date.

Parameters

id

Path Variable

String

the catalog’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the corresponding DTOs contained in the catalog with identifier id

1.17.3. loadDefault

URL

${jsonUrl}/catalogs/default

Method

GET

Description

Loads the default catalog details.

Parameters

no parameters

Response Body

List<DTO<String>>

an array of all the default catalog’s elements and the catalog itself

1.17.4. create

URL

${jsonUrl}/catalogs

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<CatalogDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.17.5. findByIds

URL

${jsonUrl}/catalogs/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<CatalogDTO>

a list of the found elements DTOs

1.17.6. update

URL

${jsonUrl}/catalogs

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<CatalogDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.17.7. delete

URL

${jsonUrl}/catalogs/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.17.8. remove

URL

${jsonUrl}/catalogs/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.17.9. undelete

URL

${jsonUrl}/catalogs/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.18. DataSourceService

ExternalSource’s Remoting service.

List of Methods

findAll, findByName, getItems, create, findByIds, update, delete, remove, undelete

1.18.1. findAll

URL

${jsonUrl}/datasources

Method

GET

Description

Find all sources.

Parameters

no parameters

Response Body

List<DataSourceDTO>

all the sources the user has access to.

1.18.2. findByName

URL

${jsonUrl}/datasources?name

Method

GET

Description

Find a datasource by its name.

Parameters

name

Request Param

String

the source’s name we are searching.

Response Body

DataSourceDTO

the matched source

1.18.3. getItems

URL

${jsonUrl}/datasources/{id}/items

Method

GET

Description

Get items in a data source.

Parameters

id

Path Variable

String

The datasource id.

Response Body

List<DataItemDTO>

All the non-deleted items in the data source.

1.18.4. create

URL

${jsonUrl}/datasources

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<DataSourceDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.18.5. findByIds

URL

${jsonUrl}/datasources/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<DataSourceDTO>

a list of the found elements DTOs

1.18.6. update

URL

${jsonUrl}/datasources

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<DataSourceDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.18.7. delete

URL

${jsonUrl}/datasources/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.18.8. remove

URL

${jsonUrl}/datasources/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.18.9. undelete

URL

${jsonUrl}/datasources/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.19. DockToolSetItemService

DockToolSetItem Remoting service.

List of Methods

clone, findElementsByContainer, create, findByIds, update, delete, remove, undelete

1.19.1. clone

URL

${jsonUrl}/dockItems/clone

Method

PUT

Description

Clones dock tools.

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- from the dto if not null, otherwise generated: id

- always from the source: all the other fields.

Parameters

params

Request Body

CloneParamDTO<DockToolSetItemDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (the dock tools and their assets), all of class DockToolSetItemDTO or AssetDTO

1.19.2. findElementsByContainer

URL

${jsonUrl}/dockItems?container

Method

GET

Description

Finds all dock tools in a dock toolset.

Parameters

container

Request Param

String

the container’s identifier

Response Body

List<DockToolSetItemDTO>

an array of the elements in the container

1.19.3. create

URL

${jsonUrl}/dockItems

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<DockToolSetItemDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.19.4. findByIds

URL

${jsonUrl}/dockItems/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<DockToolSetItemDTO>

a list of the found elements DTOs

1.19.5. update

URL

${jsonUrl}/dockItems

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<DockToolSetItemDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.19.6. delete

URL

${jsonUrl}/dockItems/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.19.7. remove

URL

${jsonUrl}/dockItems/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.19.8. undelete

URL

${jsonUrl}/dockItems/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.20. DockToolSetService

DockToolSet Remoting service.

List of Methods

findElementsByContainer, clone, create, findByIds, update, delete, remove, undelete

1.20.1. findElementsByContainer

URL

${jsonUrl}/dockSets?container

Method

GET

Description

Finds all dock toolsets in a given catalog.

Parameters

container

Request Param

String

the catalog’s identifier

Response Body

List<DockToolSetDTO>

an array of the tools in the catalog

1.20.2. clone

URL

${jsonUrl}/dockSets/clone

Method

PUT

Description

Clones dock toolsets (with their items).

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- from the dto if not null, otherwise from the source: container, label

- from the dto if not null, otherwise generated: id

- always from the source: all other fields.

Parameters

params

Request Body

CloneParamDTO<DockToolSetDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (dock tool sets, their items and their assets), all of class DockToolSetDTO, DockToolSetItemDTO or AssetDTO

1.20.3. create

URL

${jsonUrl}/dockSets

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<DockToolSetDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.20.4. findByIds

URL

${jsonUrl}/dockSets/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<DockToolSetDTO>

a list of the found elements DTOs

1.20.5. update

URL

${jsonUrl}/dockSets

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<DockToolSetDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.20.6. delete

URL

${jsonUrl}/dockSets/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.20.7. remove

URL

${jsonUrl}/dockSets/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.20.8. undelete

URL

${jsonUrl}/dockSets/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.21. DomainChildService

Domain children service.

List of Methods

findChildrenByDomain, findChildrenByRoom, create, findByIds, update, delete, remove, undelete

1.21.1. findChildrenByDomain

URL

${jsonUrl}/domainChildren?domain&class

Method

GET

Description

Finds all children in a domain.

Parameters

domain

Request Param

String

the domain’s identifier

(class)

Request Param

String

(optional)

Response Body

List<DomainChildDTO>

an array of the children in the domain

1.21.2. findChildrenByRoom

URL

${jsonUrl}/domainChildren?room&class

Method

GET

Description

Finds all children in a room’s domain. This method is a shortcut that avoids loading room to get its domain id.

Parameters

room

Request Param

String

the room’s identifier

(class)

Request Param

String

(optional)

Response Body

List<DomainChildDTO>

an array of the children in the room’s domain

1.21.3. create

URL

${jsonUrl}/domainChildren

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<DomainChildDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.21.4. findByIds

URL

${jsonUrl}/domainChildren/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<DomainChildDTO>

a list of the found elements DTOs

1.21.5. update

URL

${jsonUrl}/domainChildren

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<DomainChildDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.21.6. delete

URL

${jsonUrl}/domainChildren/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.21.7. remove

URL

${jsonUrl}/domainChildren/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.21.8. undelete

URL

${jsonUrl}/domainChildren/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.22. DomainService

Domain’s Remoting service.

List of Methods

findAll, findDomainsAllowsCreateRooms, canRenameRoom, canArchiveRoom, findByIds

1.22.1. findAll

URL

${jsonUrl}/domains

Method

GET

Description

Finds all domains.

Parameters

no parameters

Response Body

List<DomainDTO>

an array of all the domains

1.22.2. findDomainsAllowsCreateRooms

URL

${jsonUrl}/domains/compact

Method

GET

Description

Parameters

no parameters

Response Body

List<DomainDTO>

1.22.3. canRenameRoom

URL

${jsonUrl}/domains/canRenameRoom?roomId

Method

GET

Description

Parameters

(roomId)

Request Param

String

(optional)

Response Body

boolean

1.22.4. canArchiveRoom

URL

${jsonUrl}/domains/canArchiveRoom?roomId

Method

GET

Description

Parameters

(roomId)

Request Param

String

(optional)

Response Body

boolean

1.22.5. findByIds

URL

${jsonUrl}/domains/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<DomainDTO>

a list of the found elements DTOs

1.23. ElementContainerService

List of Methods

notifyElementChanged, create, findByIds, update, delete, remove, undelete

1.23.1. notifyElementChanged

URL

${jsonUrl}/elementContainers/notifyChanged

Method

POST

Description

Notify of change in element containers. Most of the time change is update, create or delete of elements. The containers are marked for screenshot generation, and change notification are send to all rooms containing containers.

Parameters

containersIds

Request Body

Set<String>

Ids of containers.

Response Body

void

1.23.2. create

URL

${jsonUrl}/elementContainers

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<ElementContainerDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.23.3. findByIds

URL

${jsonUrl}/elementContainers/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<ElementContainerDTO>

a list of the found elements DTOs

1.23.4. update

URL

${jsonUrl}/elementContainers

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<ElementContainerDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.23.5. delete

URL

${jsonUrl}/elementContainers/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.23.6. remove

URL

${jsonUrl}/elementContainers/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.23.7. undelete

URL

${jsonUrl}/elementContainers/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.24. ElementSharingService

Service for {@link ElementSharingProposalDTO}.

List of Methods

findDetailedByIds, findUserProposals, findDetailedProposals, findProposalsForGroups, findDetailedProposalsForGroups, instantiateProposals, create, findByIds, update, delete, remove, undelete

1.24.1. findDetailedByIds

URL

${jsonUrl}/syncElementRefs/detailed/{ids}

Method

GET

Description

Returns same result as #findByIds, completed by ElementSyncInfoDTO and master BoardElementDTO referenced by EntityReferenceDTOs.

@see #findByIds

Parameters

ids

Path Variable

List<String>

Response Body

List<DTO<String>>

1.24.2. findUserProposals

URL

${jsonUrl}/syncElementRefs/findProposals?role&maxCount&maxDate

Method

GET

Description

Finds a bound number of most recently created element sharing proposals by role, and max creation date.

Parameters

(role)

Request Param

ElementSharingRole

(optional) the role the authenticated user has in the proposal (undefined for any)

(maxCount)

Request Param

Integer

(optional) the maximum number of results (unlimited if undefined)

(maxDate)

Request Param

Long

(optional) the maximum creation date of returned proposals (as timestamp, undefined for none, bound excluded)

Response Body

List<ElementSharingProposalDTO>

a list of the corresponding proposals as DTOs.

1.24.3. findDetailedProposals

URL

${jsonUrl}/syncElementRefs/findDetailedProposals?role&maxCount&maxDate

Method

GET

Description

Returns same result as findUserProposals, completed by ElementSyncInfoDTO and master BoardElementDTO referenced by EntityReferenceDTOs.

See findUserProposals

Parameters

(role)

Request Param

ElementSharingRole

(optional)

(maxCount)

Request Param

Integer

(optional)

(maxDate)

Request Param

Long

(optional)

Response Body

List<DTO<String>>

1.24.4. findProposalsForGroups

URL

${jsonUrl}/syncElementRefs/findProposalsForGroups?groupIds&maxCount&maxDate

Method

GET

Description

Finds a bound number of most recently created element sharing proposals by audience group ids, and max creation date.

Current user should be a member of a queried group for its proposals to be returned.

Parameters

groupIds

Request Param

List<Long>

The ids of groups whose proposals should be returned.

(maxCount)

Request Param

Integer

(optional) The maximum number of proposals to be returned (unlimited if undefined)

(maxDate)

Request Param

Long

(optional) the maximum creation date of returned proposals (as timestamp, undefined for none, bound excluded)

Response Body

List<DTO<String>>

a list of the corresponding proposals as DTOs.

1.24.5. findDetailedProposalsForGroups

URL

${jsonUrl}/syncElementRefs/findDetailedProposalsForGroups?groupIds&maxCount&maxDate

Method

GET

Description

Returns same result as findProposalsForGroups, completed by ElementSyncInfoDTO and master BoardElementDTO referenced by EntityReferenceDTOs.

See findProposalsForGroups

Parameters

groupIds

Request Param

List<Long>

(maxCount)

Request Param

Integer

(optional)

(maxDate)

Request Param

Long

(optional)

Response Body

List<DTO<String>>

1.24.6. instantiateProposals

URL

${jsonUrl}/syncElementRefs/instantiateProposals

Method

PUT

Description

Instantiates element sharing proposals.

Parameters

params

Request Body

CloneParamDTO<BoardElementDTO>

CloneParamDTO where CloneParamDTO#getIds() are the ids of the ElementSharingProposalDTO to instantiate and CloneParamDTO#getDtos() are the BoardElementDTO of the target elements to instantiate from these proposals.

Response Body

List<DTO<String>>

A list of changed DTOs.

1.24.7. create

URL

${jsonUrl}/syncElementRefs

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<ElementSharingProposalDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.24.8. findByIds

URL

${jsonUrl}/syncElementRefs/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<ElementSharingProposalDTO>

a list of the found elements DTOs

1.24.9. update

URL

${jsonUrl}/syncElementRefs

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<ElementSharingProposalDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.24.10. delete

URL

${jsonUrl}/syncElementRefs/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.24.11. remove

URL

${jsonUrl}/syncElementRefs/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.24.12. undelete

URL

${jsonUrl}/syncElementRefs/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.25. ElementSyncInfoService

Service for {@link com.iobeya.dto.ElementSyncInfoDTO}.

List of Methods

findByIds

1.25.1. findByIds

URL

${jsonUrl}/elementSyncInfo/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<ElementSyncInfoDTO>

a list of the found elements DTOs

1.26. FeatureTogglesService

Service for Feature Toggles.

List of Methods

getFeatures

1.26.1. getFeatures

URL

${jsonUrl}/featureToggles

Method

GET

Description

Finds all features with their states.

Parameters

no parameters

Response Body

Set<FeatureToggles>

an set of feature toggles defined in the application.

1.27. ForgetPasswordService

Forget Password service.

List of Methods

verifyEmailServer, sendEmail, setForgotPasswordInstructions, getForgotPasswordInstructions

1.27.1. verifyEmailServer

URL

${jsonUrl}/forgetpassword/emailserver

Method

GET

Description

Verifies email server configuration.

Parameters

no parameters

Response Body

boolean

a boolean for email server status.

1.27.2. sendEmail

URL

${jsonUrl}/forgetpassword/sendemail

Method

POST

Description

Sends forget password email.

Parameters

identifier

Request Body

String

username or email of the user.

Response Body

JSonResult

a JSonResult for operation result.

1.27.3. setForgotPasswordInstructions

URL

${jsonUrl}/forgetpassword/setinstructions

Method

POST

Description

Sets forgot password instructions for user.

Parameters

forgotPasswordInstructions

Request Body

String

Forgot password instructions.

Response Body

void

1.27.4. getForgotPasswordInstructions

URL

${jsonUrl}/forgetpassword/instructions

Method

GET

Description

Retrieves forgot password instructions for user.

Parameters

no parameters

Response Body

String

the value of forgot password instructions.

1.28. GroupService

Group’s Remoting service.

List of Methods

findPagedAudienceGroups, findByIds, findByCriteriaForRoom

1.28.1. findPagedAudienceGroups

URL

${jsonUrl}/groups?from&maxCount&maxUserCount&searchText

Method

GET

Description

Retrieves a bounded number of all groups matching a searchText, with a group name lower bound.

Only the groups having access to at least one domain accessible by the user are returned.

Parameters

(from)

Request Param

Integer

(optional) the offset on result (start at 0).

(maxCount)

Request Param

Integer

(optional) the maximum number of results (unlimited if undefined)

(maxUserCount)

Request Param

Integer

(optional)

(searchText)

Request Param

String

(optional) the text to search in group names

Response Body

PagedResultDTO

a list of all the matching groups

1.28.2. findByIds

URL

${jsonUrl}/groups/{ids}?maxUserCount

Method

GET

Description

Finds groups by identifiers.

Parameters

ids

Path Variable

List<Long>

the groups' identifiers

(maxUserCount)

Request Param

Integer

(optional)

Response Body

List<GroupDTO>

an array of the groups' DTOs

1.28.3. findByCriteriaForRoom

URL

${jsonUrl}/groups/{roomId}/criteria?maxUserCount

Method

POST

Description

Find groups with read access on a room and further criteria.

Parameters

criteria

Request Body

List<Criterion>

an array of criteria on groups

roomId

Path Variable

String

the identifier of the room the groups should have read access to

(maxUserCount)

Request Param

Integer

(optional)

Response Body

List<GroupDTO>

an array of the corresponding groups' DTOs

1.29. HealthCheckService

List of Methods

health

1.29.1. health

URL

${jsonUrl}/health

Method

GET

Description

Parameters

no parameters

Response Body

Health

1.30. IframeAllowedDomainService

List of Methods

findAll

1.30.1. findAll

URL

${jsonUrl}/iframeAllowedDomains

Method

GET

Description

Finds all iframe allowed domains.

Parameters

no parameters

Response Body

List<IframeAllowedDomainDTO>

an array of all the domains

1.31. IobeyaAuthReverseProxyService

List of Methods

requestData, requestDataAsync

1.31.1. requestData

URL

${jsonUrl}/oauthReverseProxy/requestData

Method

POST

Description

Execute a request with oauth access token.

Parameters

reverseProxyRequestDTO

Request Body

ReverseProxyRequestDTO

request parameters

Response Body

void

1.31.2. requestDataAsync

URL

${jsonUrl}/oauthReverseProxy/requestData

Method

POST

Description

Parameters

reverseProxyRequest

Request Body

ReverseProxyRequestDTO

Response Body

AsyncResponse

1.32. MeetingService

Meeting service.

List of Methods

startMeeting, stopMeeting, startGuidance, startBrainstorm, startIdeation, startVote, prepareIdeation, prepareVote, followLink, list, list, setToolState, commitRoom, updateCountdown, askMeetingControl, cancelAskMeetingControl, acceptMeetingControlRequest, refuseMeetingControlRequest, giveMeetingControl, acceptMeetingControl, refuseMeetingControl, takeBackMeetingControl, giveBackMeetingControl, forceMeetingStop, forceUpdateCountdown, returnPreviousState, startEditing, stopEditing

1.32.1. startMeeting

URL

${jsonUrl}/meeting/start/{clientId}?stateToBeSaved

Method

GET

Description

Starts a meeting.

Parameters

clientId

Path Variable

String

the client’s identifier

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.2. stopMeeting

URL

${jsonUrl}/meeting/stop/{clientId}

Method

GET

Description

Stops a meeting.

Parameters

clientId

Path Variable

String

the client’s identifier.

Response Body

JSonResult

result

1.32.3. startGuidance

URL

${jsonUrl}/meeting/guidance/{clientId}?stateToBeSaved

Method

POST

Description

Starts or updates guidance.

Parameters

clientId

Path Variable

String

the client’s identifier

viewPort

Request Body

ViewportDTO

View port

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.4. startBrainstorm

URL

${jsonUrl}/meeting/brainstorm/{clientId}?stateToBeSaved

Method

GET

Description

Starts brainstorm mode.

Parameters

clientId

Path Variable

String

the client’s identifier

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.5. startIdeation

URL

${jsonUrl}/meeting/ideation/{clientId}?stateToBeSaved

Method

POST

Description

Starts ideation mode.

Parameters

clientId

Path Variable

String

the client’s identifier

configuration

Request Body

MeetingConfigurationDTO

configuration of meeting

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.6. startVote

URL

${jsonUrl}/meeting/vote/{clientId}?stateToBeSaved

Method

POST

Description

Starts vote mode.

Parameters

clientId

Path Variable

String

the client’s identifier

configuration

Request Body

VoteConfigurationDTO

vote configuration made by animator

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.7. prepareIdeation

URL

${jsonUrl}/meeting/prepareIdeation/{clientId}?stateToBeSaved

Method

GET

Description

Prepare ideation mode.

Parameters

clientId

Path Variable

String

the client’s identifier

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

1.32.8. prepareVote

URL

${jsonUrl}/meeting/prepareVote/{clientId}?stateToBeSaved

Method

GET

Description

Prepare vote mode.

Parameters

clientId

Path Variable

String

the client’s identifier

stateToBeSaved

Request Param

Boolean

boolean to indicate if state has to be saved

Response Body

JSonResult

result

URL

${jsonUrl}/meeting/link/{clientId}?url&label

Method

GET

Description

Makes other client open an url.

Parameters

clientId

Path Variable

String

the client’s identifier

url

Request Param

String

url to open

label

Request Param

String

label of url

Response Body

JSonResult

result

1.32.10. list

URL

${jsonUrl}/meeting/list

Method

GET

Description

Lists meeting states.

Only for platform admin users.

Parameters

no parameters

Response Body

List<IRoomMeetingState>

all room meeting states

1.32.11. list

URL

${jsonUrl}/meeting/list

Method

POST

Description

Lists meeting states.

Only for platform admin users.

Parameters

no parameters

Response Body

List<IRoomMeetingState>

all room meeting states

1.32.12. setToolState

URL

${jsonUrl}/meeting/tool/{toolKey}/{clientId}

Method

POST

Description

Sets tool state.

Parameters

clientId

Path Variable

String

the client’s identifier

toolKey

Path Variable

String

unique key of the tool

toolState

Request Body

String

value of the tool state

Response Body

JSonResult

result

1.32.13. commitRoom

URL

${jsonUrl}/meeting/commit/{clientId}?roomId&boardId

Method

GET

Description

Commits all changes in a room or in a board in this room.

Commit date is stored and used to improve cache. Message is sent to all users in the room.

Parameters

clientId

Path Variable

String

the client’s identifier

roomId

Request Param

String

the room’s identifier

boardId

Request Param

String

the board’s identifier, or an empty string to commit the changes of the whole room

Response Body

JSonResult

result

1.32.14. updateCountdown

URL

${jsonUrl}/meeting/countdown/{clientId}

Method

POST

Description

Updates countdown.

Parameters

clientId

Path Variable

String

the client’s identifier

message

Request Body

CountdownMessage

countdown message.

Response Body

JSonResult

result

1.32.15. askMeetingControl

URL

${jsonUrl}/meeting/askcontrol/{clientId}

Method

GET

Description

Asks meeting control. Called by user.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.16. cancelAskMeetingControl

URL

${jsonUrl}/meeting/cancelask/{clientId}

Method

GET

Description

Cancels ask control. Called by user.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.17. acceptMeetingControlRequest

URL

${jsonUrl}/meeting/acceptrequest/{clientId}?speakerClientId

Method

GET

Description

Accepts control request. Called by animator.

Parameters

clientId

Path Variable

String

the client’s identifier

speakerClientId

Request Param

String

client id of new speaker

Response Body

JSonResult

result

1.32.18. refuseMeetingControlRequest

URL

${jsonUrl}/meeting/refuserequest/{clientId}?speakerClientId

Method

GET

Description

Refuses control request.

Called by animator.

Parameters

clientId

Path Variable

String

the client’s identifier

speakerClientId

Request Param

String

client id of refused

Response Body

JSonResult

result

1.32.19. giveMeetingControl

URL

${jsonUrl}/meeting/givecontrol/{clientId}?userName

Method

GET

Description

Proposes control to a user. Called by animator.

Parameters

clientId

Path Variable

String

the client’s identifier

userName

Request Param

String

Username.

Response Body

JSonResult

result

1.32.20. acceptMeetingControl

URL

${jsonUrl}/meeting/acceptcontrol/{clientId}

Method

GET

Description

Accepts control. Called by proposed speaker.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.21. refuseMeetingControl

URL

${jsonUrl}/meeting/refusecontrol/{clientId}

Method

GET

Description

Refuses control. Called by proposed speaker.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.22. takeBackMeetingControl

URL

${jsonUrl}/meeting/takeback/{clientId}

Method

GET

Description

Takes back control. Called by animator.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.23. giveBackMeetingControl

URL

${jsonUrl}/meeting/giveback/{clientId}

Method

GET

Description

Gives back control. Called by speaker.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.32.24. forceMeetingStop

URL

${jsonUrl}/meeting/forcestop/{clientId}

Method

GET

Description

Forces a meeting to stop.

Parameters

clientId

Path Variable

String

client id.

Response Body

JSonResult

result.

1.32.25. forceUpdateCountdown

URL

${jsonUrl}/meeting/forceCountdown/{clientId}

Method

POST

Description

Force countdown update.

Parameters

clientId

Path Variable

String

the client’s identifier

message

Request Body

CountdownMessage

countdown message.

Response Body

JSonResult

result

1.32.26. returnPreviousState

URL

${jsonUrl}/meeting/returnPreviousState/{clientId}

Method

GET

Description

Return the previous state if exist else stop meeting.

Parameters

clientId

Path Variable

String

client id.

Response Body

JSonResult

result.

1.32.27. startEditing

URL

${jsonUrl}/meeting/startEditing/{clientId}?elementId

Method

POST

Description

Starts editing.

Parameters

clientId

Path Variable

String

the editor username

elementId

Request Param

String

the modified element id

Response Body

JSonResult

result

1.32.28. stopEditing

URL

${jsonUrl}/meeting/stopEditing/{clientId}?elementId

Method

POST

Description

Stops editing.

Parameters

clientId

Path Variable

String

the editor username

elementId

Request Param

String

the modified element id

Response Body

JSonResult

result

1.33. MessageService

Message service.

List of Methods

connect, connect, disconnect, disconnect, enterRoom, enterRoom, list, list, getMessages, getMessages

1.33.1. connect

URL

${jsonUrl}/messages/in?clientId

Method

GET

Description

Connects to the given client or creates a new client.

Parameters

(clientId)

Request Param

String

(optional) the client’s identifier

Response Body

IMessagingClient

result

1.33.2. connect

URL

${jsonUrl}/messages/in?clientId

Method

POST

Description

Connects to the given client or creates a new client.

Parameters

(clientId)

Request Param

String

(optional) the client’s identifier

Response Body

IMessagingClient

result

1.33.3. disconnect

URL

${jsonUrl}/messages/out/{clientId}

Method

GET

Description

Disconnects from the given client.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.33.4. disconnect

URL

${jsonUrl}/messages/out/{clientId}

Method

POST

Description

Disconnects from the given client.

Parameters

clientId

Path Variable

String

the client’s identifier

Response Body

JSonResult

result

1.33.5. enterRoom

URL

${jsonUrl}/messages/enter/{clientId}?roomId&boardId

Method

GET

Description

Notifies client entrance in a given room or if a client leaves when roomId is not passed.

Parameters

clientId

Path Variable

String

the client’s identifier

(roomId)

Request Param

String

(optional) the room’s identifier

(boardId)

Request Param

String

(optional)

Response Body

JSonResult

result

1.33.6. enterRoom

URL

${jsonUrl}/messages/enter/{clientId}?roomId&boardId

Method

POST

Description

Notifies client entrance in a given room or if a client leaves when roomId is not passed.

Parameters

clientId

Path Variable

String

the client’s identifier

(roomId)

Request Param

String

(optional) the room’s identifier

(boardId)

Request Param

String

(optional)

Response Body

JSonResult

result

1.33.7. list

URL

${jsonUrl}/messages/list

Method

GET

Description

Retrieves all the available clients.

Parameters

no parameters

Response Body

List<IMessagingClient>

an array of all the messaging clients

1.33.8. list

URL

${jsonUrl}/messages/list

Method

POST

Description

Retrieves all the available clients.

Parameters

no parameters

Response Body

List<IMessagingClient>

an array of all the messaging clients

1.33.9. getMessages

URL

${jsonUrl}/messages/get/{clientId}?position

Method

GET

Description

Retrieves the messages in the given client, either from the start or from a given position.

Parameters

clientId

Path Variable

String

the client’s identifier

(position)

Request Param

Long

(optional) the position of the last message that won’t be returned (usually the last message received)

Response Body

Object

the messages as an instance of DeferredResult<BaseMessage[]> if the server supports asynchronous calls or as an instance of BaseMessage[]) if it doesn’t.

1.33.10. getMessages

URL

${jsonUrl}/messages/get/{clientId}?position

Method

POST

Description

Retrieves the messages in the given client, either from the start or from a given position.

Parameters

clientId

Path Variable

String

the client’s identifier

(position)

Request Param

Long

(optional) the position of the last message that won’t be returned (usually the last message received)

Response Body

Object

the messages as an instance of DeferredResult<BaseMessage[]> if the server supports asynchronous calls or as an instance of BaseMessage[]) if it doesn’t.

1.34. MetricsProviderController

List of Methods

getPlatformMetricsFile

1.34.1. getPlatformMetricsFile

URL

${jsonUrl}/metrics/platform

Method

GET

Description

Exports an archive file regrouping the extracted platform data metrics files in CSV format. This functionality can be used only by cloud platforms. It can’t be used by on-prem platforms.

Parameters

no parameters

Response Body

AsyncResponse

a downloadable .zip file resource of the platform metrics.

1.35. PasswordPolicyService

Password policy service.

List of Methods

retrievePasswordConstraints, validatePassword, updatePassword, updatePassword, setPasswordConstraints

1.35.1. retrievePasswordConstraints

URL

/passwordpolicy/constraints

Method

GET

Description

Retrieves the list of constraints set in password policy.

Parameters

no parameters

Response Body

PasswordPolicySettingDTO

a DTO of constraints.

1.35.2. validatePassword

URL

/passwordpolicy/validation

Method

POST

Description

Validates the password sent.

Parameters

password

Request Body

String

Response Body

PasswordValidationDTO

a DTO of the password validation.

1.35.3. updatePassword

URL

/passwordpolicy/updatePassword

Method

POST

Description

Updates the user with password sent.

Parameters

userToken

Request Body

UserTokenDTO

DTO class for a secure update

Response Body

boolean

a boolean for update operation result.

1.35.4. updatePassword

URL

/passwordpolicy/updateOldPassword

Method

POST

Description

Updates the user with password sent but needs to verify old password first.

Parameters

userPasswords

Request Body

UserPasswordsDTO

DTO class containing old and new password

Response Body

boolean

a boolean for update operation result.

1.35.5. setPasswordConstraints

URL

/passwordpolicy/setconstraints

Method

POST

Description

Sets password constraints in application.

Parameters

passwordPolicySettingDTO

Request Body

PasswordPolicySettingDTO

DTO class containing old and new password.

Response Body

void

1.36. PlanningService

Planning board service.

List of Methods

getElementArea, getPositionFromDates

1.36.1. getElementArea

URL

${jsonUrl}/planning/{boardId}/activities/{elementId}/area

Method

GET

Description

Get area of an element on a planning board, including its row if there is one.

Parameters

boardId

Path Variable

String

the board id

elementId

Path Variable

String

the element id

Response Body

PlanningAreaDTO

the area

1.36.2. getPositionFromDates

URL

${jsonUrl}/planning/{id}/position/{startDate}/{endDate}/{rowNumber}

Method

GET

Description

Get position on a planning board from dates

Parameters

id

Path Variable

String

boardId

startDate

Path Variable

long

startDate in timestamp ms

endDate

Path Variable

long

endDate in timestamp ms

rowNumber

Path Variable

int

the number of row (start at 1)

Response Body

ObjectNode

an object with x, y, width, height or exception in case of error

1.37. PlanningServiceImpl

List of Methods

getElementArea, getPositionFromDates

1.37.1. getElementArea

URL

/{boardId}/activities/{elementId}/area

Method

GET

Description

Parameters

boardId

Path Variable

String

elementId

Path Variable

String

Response Body

PlanningAreaDTO

1.37.2. getPositionFromDates

URL

/{id}/position/{startDate}/{endDate}/{rowNumber}

Method

GET

Description

Parameters

id

Path Variable

String

startDate

Path Variable

long

endDate

Path Variable

long

rowNumber

Path Variable

int

Response Body

ObjectNode

1.38. PlatformChildService

Domain children service.

List of Methods

findChildrenByClass, findAllChildren, create, findByIds, update, delete, remove, undelete

1.38.1. findChildrenByClass

URL

${jsonUrl}/platformChildren?class

Method

GET

Description

Finds all children of a given class (or entity type) in the platform.

Parameters

class

Request Param

String

Name of DTO class or entity type of flexible child to return

Response Body

List<PlatformChildDTO>

a list of the corresponding children in the platform

1.38.2. findAllChildren

URL

${jsonUrl}/platformChildren

Method

GET

Description

Finds all children in the platform.

Parameters

no parameters

Response Body

List<PlatformChildDTO>

a list of the corresponding children in the platform

1.38.3. create

URL

${jsonUrl}/platformChildren

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<PlatformChildDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.38.4. findByIds

URL

${jsonUrl}/platformChildren/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<PlatformChildDTO>

a list of the found elements DTOs

1.38.5. update

URL

${jsonUrl}/platformChildren

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<PlatformChildDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.38.6. delete

URL

${jsonUrl}/platformChildren/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.38.7. remove

URL

${jsonUrl}/platformChildren/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.38.8. undelete

URL

${jsonUrl}/platformChildren/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.39. PublicRestService

Service providing public endpoints.

List of Methods

iconForMechanism

1.39.1. iconForMechanism

URL

${jsonUrl}/public/iconForMechanism?mechanismId

Method

GET

Description

Returns the mechanism’s icon.

Parameters

mechanismId

Request Param

String

the authentication mechanism id

Response Body

void

1.40. RoomChildService

Room children service.

List of Methods

findChildrenByRoom, create, findByIds, update, delete, remove, undelete

1.40.1. findChildrenByRoom

URL

${jsonUrl}/roomChildren?room&class

Method

GET

Description

Finds all the children in a room.

Parameters

room

Request Param

String

the room’s identifier

(class)

Request Param

String

(optional)

Response Body

List<RoomChildDTO>

an array of all the children in the room

1.40.2. create

URL

${jsonUrl}/roomChildren

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<RoomChildDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.40.3. findByIds

URL

${jsonUrl}/roomChildren/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<RoomChildDTO>

a list of the found elements DTOs

1.40.4. update

URL

${jsonUrl}/roomChildren

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<RoomChildDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.40.5. delete

URL

${jsonUrl}/roomChildren/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.40.6. remove

URL

${jsonUrl}/roomChildren/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.40.7. undelete

URL

${jsonUrl}/roomChildren/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.41. RoomService

Room’s Remoting service.

List of Methods

update, cloneAsync, clone, findAll, findAllMinimal, findAllCompact, loadDetails, loadDetailsSince, retrieveGlobalParameters, retrieveRoomPermissionInfo, teamPermissions, addUsers, removeUsers, addGroups, removeGroups, addUserPermission, removeUserPermission, addGroupPermission, removeGroupPermission, getStatistics, removeWallCell, hasReadAccess, lockAllBoards, unlockAllBoards, getTeamAndGuest, visualExport, visualExportAsync, tsvExport, tsvExportElements, tsvReportExport, tsvImport, importBoard, importBoardAsync, importElements, importElementsAsync, create, setUpRoom, delete, findNbRoomsInDomain, getAvailabilityDuration, renameRoom, archiveRoom, findByIds

1.41.1. update

URL

${jsonUrl}/rooms

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<RoomDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.41.2. cloneAsync

URL

${jsonUrl}/rooms/clone

Method

PUT

Description

Clones rooms (with their simple boards, tools, wall categories, assets, catalogs and catalog docks).

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- always from the dto: isModel

- from the dto if not null, otherwise from the source: name, description

- from the dto if not null, otherwise generated: id

- always from the source: all other fields

The name can be modified to meet constraints if the clone should be a model (that is isModel is true).

Only the simple boards in the rooms are cloned.

Parameters

params

Request Body

CloneParamDTO<RoomDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

AsyncResponse

an array of all the clones' DTOs (the rooms), all of class RoomDTO

1.41.3. clone

URL

${jsonUrl}/rooms/clone

Method

PUT

Description

Clones rooms (with their simple boards, tools, wall categories, assets, catalogs and catalog docks).

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- always from the dto: isModel

- from the dto if not null, otherwise from the source: name, description

- from the dto if not null, otherwise generated: id

- always from the source: all other fields

The name can be modified to meet constraints if the clone should be a model (that is isModel is true).

Only the simple boards in the rooms are cloned.

Parameters

params

Request Body

CloneParamDTO<RoomDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (the rooms), all of class RoomDTO

1.41.4. findAll

URL

${jsonUrl}/rooms

Method

GET

Description

Finds all affected rooms and unknown rooms if settings permit it. Unknown rooms are public rooms and where I have no specific permission. Warn this could be very time expensive.

Parameters

no parameters

Response Body

List<RoomDTO>

an array of all the rooms

1.41.5. findAllMinimal

URL

${jsonUrl}/rooms/minimal

Method

GET

Description

Finds all affected rooms and unknown rooms if settings permit it. Unknown rooms are public rooms and where I have no specific permission. The difference with findAll is that it returns less information.

Parameters

no parameters

Response Body

List<RoomDTO>

an array of all the rooms

1.41.6. findAllCompact

URL

${jsonUrl}/rooms/compact

Method

GET

Description

Finds all affected rooms and unknown rooms if settings permit it in compact form. Unknown rooms are public rooms and where I have no specific permission. Compact form mean no assetContainer and catalog are not sent (null value), and icon are sent.

Parameters

no parameters

Response Body

List<DTO<String>>

an array of all the rooms

1.41.7. loadDetails

URL

${jsonUrl}/rooms/{id}/details

Method

GET

Description

Loads all the elements contained in a room (including itself).

Parameters

id

Path Variable

String

the room’s identifier

Response Body

List<DTO<String>>

an array of the DTOs contained in the room with identifier id

1.41.8. loadDetailsSince

URL

${jsonUrl}/rooms/{id}/details?since

Method

GET

Description

Loads all the elements contained in a room (including itself) and whose last modification occurred after the given date.

Parameters

id

Path Variable

String

the room’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the corresponding DTOs contained in the room with identifier id

1.41.9. retrieveGlobalParameters

URL

${jsonUrl}/rooms/{id}/globalParams

Method

GET

Description

Retrieves room global parameters.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

RoomGlobalParamsDTO

a RoomGlobalParamDTO

1.41.10. retrieveRoomPermissionInfo

URL

${jsonUrl}/rooms/{id}/info

Method

GET

Description

Retrieves room permissions.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

RoomPermissionInfoDTO

a RoomPermissionInfoDTO

1.41.11. teamPermissions

URL

${jsonUrl}/rooms/{id}/usersPermissions

Method

GET

Description

Retrieves room’s user permissions.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

List<UserRoomDTO>

a list of UserRoomDTO

1.41.12. addUsers

URL

${jsonUrl}/rooms/{id}/addUsers?usernames

Method

PUT

Description

Adds users to a room.

Parameters

id

Path Variable

String

the room’s identifier

usernames

Request Param

List<String>

the users' identifiers

Response Body

boolean

true if operation succeeded

1.41.13. removeUsers

URL

${jsonUrl}/rooms/{id}/removeUsers?usernames

Method

PUT

Description

Removes users from a room.

Parameters

id

Path Variable

String

the room identifier

usernames

Request Param

List<String>

the users identifiers

Response Body

boolean

true if operation succeeded

1.41.14. addGroups

URL

${jsonUrl}/rooms/{id}/addGroups?groupNames

Method

PUT

Description

Adds groups to a room.

Parameters

id

Path Variable

String

the room’s identifier

groupNames

Request Param

List<String>

an array of the groups' names

Response Body

boolean

true if operation succeeded

1.41.15. removeGroups

URL

${jsonUrl}/rooms/{id}/removeGroups?groupNames

Method

PUT

Description

Removes groups from a room.

Parameters

id

Path Variable

String

the room’s identifier

groupNames

Request Param

List<String>

an array of the groups' names

Response Body

boolean

true if operation succeeded

1.41.16. addUserPermission

URL

${jsonUrl}/rooms/{id}/addUserPermission?username&mask

Method

PUT

Description

Adds user permissions to a room.

Parameters

id

Path Variable

String

the room’s identifier

username

Request Param

String

the user’s identifier

mask

Request Param

int

the permission mask

Response Body

boolean

true if operation succeeded

1.41.17. removeUserPermission

URL

${jsonUrl}/rooms/{id}/removeUserPermission?username&mask

Method

PUT

Description

Removes user permissions from a room.

Parameters

id

Path Variable

String

the room’s identifier

username

Request Param

String

the user’s identifier

mask

Request Param

int

the permission mask

Response Body

boolean

true if operation succeeded

1.41.18. addGroupPermission

URL

${jsonUrl}/rooms/{id}/addGroupPermission?groupId&mask

Method

PUT

Description

Adds group permissions to a room.

Parameters

id

Path Variable

String

the room’s identifier

groupId

Request Param

Long

the group’s identifier

mask

Request Param

int

the permission mask

Response Body

boolean

true if operation succeeded

1.41.19. removeGroupPermission

URL

${jsonUrl}/rooms/{id}/removeGroupPermission?groupId&mask

Method

PUT

Description

Removes group permissions from a room.

Parameters

id

Path Variable

String

the room’s identifier

groupId

Request Param

Long

the group’s identifier

mask

Request Param

int

the permission mask

Response Body

boolean

true if operation succeeded

1.41.20. getStatistics

URL

${jsonUrl}/rooms/{id}/statistics

Method

GET

Description

Gets all rooms' statistics.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

RoomStatisticsDTO

a RoomStatisticsDTO

1.41.21. removeWallCell

URL

${jsonUrl}/rooms/{id}/removeWallCell?posX&nbColumns

Method

PUT

Description

Removes an empty cell from the wall.

Parameters

id

Path Variable

String

the room’s identifier

posX

Request Param

int

position of the cell to remove

nbColumns

Request Param

int

number of columns to remove

Response Body

List<DTO<String>>

all changes about this cell

1.41.22. hasReadAccess

URL

${jsonUrl}/rooms/{id}/canRead

Method

GET

Description

Checks if logged user has read access to a specific room.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

boolean

access boolean

1.41.23. lockAllBoards

URL

${jsonUrl}/rooms/{id}/lockAllBoards

Method

PUT

Description

Locks all room’s boards.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

List<DTO<String>>

1.41.24. unlockAllBoards

URL

${jsonUrl}/rooms/{id}/unlockAllBoards

Method

PUT

Description

Unlocks all room’s boards.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

List<DTO<String>>

1.41.25. getTeamAndGuest

URL

${jsonUrl}/rooms/{id}/team?connected

Method

GET

Description

Gets the members (team) of and the connected guests to a given room.

Parameters

id

Path Variable

String

the room’s identifier

(connected)

Request Param

boolean

(optional) if true, only connected users are returned

Response Body

List<UserConnectedRoomDTO>

List of room members (team) and connected guests

1.41.26. visualExport

URL

${jsonUrl}/rooms/{id}/visualExport?f

Method

GET

Description

Gets all rooms screenshots as a zip file as byte array in response.

Parameters

id

Path Variable

String

the room’s identifier

(f)

Request Param

String

(optional)

Response Body

void

1.41.27. visualExportAsync

URL

${jsonUrl}/rooms/{id}/visualExport?f

Method

GET

Description

Gets all rooms screenshots as a zip file as byte array in response.

Parameters

id

Path Variable

String

the room’s identifier

(f)

Request Param

String

(optional)

Response Body

AsyncResponse

1.41.28. tsvExport

URL

${jsonUrl}/rooms/{id}/tsvExport?exportedClassNames&headerOldNames&headerNewNames

Method

GET

Description

Returns all the room’s board’s elements that are instances of the specified classes as a csv file.

Parameters

id

Path Variable

String

the room’s identifier

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

void

1.41.29. tsvExportElements

URL

${jsonUrl}/rooms/{id}/exportElements?exportedClassNames&headerOldNames&headerNewNames

Method

GET

Description

Returns all the room’s board’s elements that are instances of the specified classes as a csv file.

Parameters

id

Path Variable

String

the room’s identifier

(exportedClassNames)

Request Param

List<String>

(optional) the exported class names

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

void

1.41.30. tsvReportExport

URL

${jsonUrl}/rooms/{id}/tsvReportExport

Method

GET

Description

Returns all the room’s board’s elements as a csv file.

Parameters

id

Path Variable

String

the room’s identifier

Response Body

void

1.41.31. tsvImport

URL

${jsonUrl}/rooms/{id}/tsvImport?file&headerOldNames&headerNewNames

Method

POST

Description

Imports csv file.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the room’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

ImportReportDTO

a report as an ImportReportDTO

1.41.32. importBoard

URL

${jsonUrl}/rooms/{id}/importBoard?file&headerOldNames&headerNewNames&x&y&isModel

Method

POST

Description

Imports csv file of board.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the room’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

(x)

Request Param

Integer

(optional) the new x position of board

(y)

Request Param

Integer

(optional) the new y position of board

(isModel)

Request Param

Boolean

(optional)

Response Body

ImportReportDTO

a report as an ImportReportDTO

1.41.33. importBoardAsync

URL

${jsonUrl}/rooms/{id}/importBoard?file&headerOldNames&headerNewNames&x&y&isModel

Method

POST

Description

Imports csv file of board.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the room’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

(x)

Request Param

Integer

(optional) the new x position of board

(y)

Request Param

Integer

(optional) the new y position of board

(isModel)

Request Param

Boolean

(optional)

Response Body

AsyncResponse

a report as an ImportReportDTO

1.41.34. importElements

URL

${jsonUrl}/rooms/{id}/importElements?file&headerOldNames&headerNewNames

Method

POST

Description

Imports csv file of board elements.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the room’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

ImportReportDTO

a report as an ImportReportDTO

1.41.35. importElementsAsync

URL

${jsonUrl}/rooms/{id}/importElements?file&headerOldNames&headerNewNames

Method

POST

Description

Imports csv file of board elements.

Parameters

file

Request Param

MultipartFile

the csv file to import

id

Path Variable

String

the room’s identifier

(headerOldNames)

Request Param

List<String>

(optional) the old column names

(headerNewNames)

Request Param

List<String>

(optional) the new column names

Response Body

AsyncResponse

a report as an ImportReportDTO

1.41.36. create

URL

${jsonUrl}/rooms?modelId

Method

POST

Description

Create a new room. Room limits must be set and compatible with domain limits. This must be called with domain permission.

Parameters

room

Request Body

RoomDTO

Room to create

(modelId)

Request Param

String

(optional) Model to use (empty room if null).

Response Body

RoomDTO

The created room.

1.41.37. setUpRoom

URL

${jsonUrl}/rooms/setUp

Method

GET

Description

Create a new room with category and board.

Parameters

room

Request Body

RoomDTO

Room to create

Response Body

RoomDTO

The created room.

1.41.38. delete

URL

${jsonUrl}/rooms/{ids}

Method

DELETE

Description

Deletes rooms.

Parameters

ids

Path Variable

List<String>

identifiers of the rooms to delete

Response Body

List<DTO<String>>

a list of the effectively deleted room DTOs

1.41.39. findNbRoomsInDomain

URL

${jsonUrl}/rooms/count?domainId

Method

GET

Description

Parameters

(domainId)

Request Param

String

(optional)

Response Body

int

1.41.40. getAvailabilityDuration

URL

${jsonUrl}/rooms/availabilityDuration

Method

GET

Description

Parameters

no parameters

Response Body

int

1.41.41. renameRoom

URL

${jsonUrl}/rooms/{id}/rename?newName

Method

GET

Description

Parameters

id

Path Variable

String

newName

Request Param

String

Response Body

RoomDTO

1.41.42. archiveRoom

URL

${jsonUrl}/rooms/{id}/archive

Method

GET

Description

Set requested room as locked.

Parameters

id

Path Variable

String

the room ID;

Response Body

RoomDTO

archived room

1.41.43. findByIds

URL

${jsonUrl}/rooms/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<RoomDTO>

a list of the found elements DTOs

1.42. RoomSharedElementService

Shared element Remoting service.

List of Methods

findByContainer, loadDetails, loadDetails, restoreSharedElement, undoShare, create, findByIds, update, delete, remove, undelete

1.42.1. findByContainer

URL

${jsonUrl}/roomShared?container

Method

GET

Description

Finds the shared elements of a room (that is the elements in the room’s exchange zone).

Parameters

container

Request Param

String

the room’s identifier

Response Body

List<RoomSharedElementDTO>

an array of the corresponding shared elements

1.42.2. loadDetails

URL

${jsonUrl}/roomShared/{id}/details

Method

GET

Description

Loads all the elements contained in a room’s shared element (including itself).

Parameters

id

Path Variable

String

the room shared element’s identifier

Response Body

List<DTO<String>>

an array of the DTOs contained in the room shared element with identifier id

1.42.3. loadDetails

URL

${jsonUrl}/roomShared/{id}/details?since

Method

GET

Description

Loads all the elements contained in a room’s shared element (including itself) and whose modification occurred after the given date.

Parameters

id

Path Variable

String

the room shared element’s identifier

since

Request Param

Date

the date after which the modification of an element should have occurred for this element to be included in the result

Response Body

List<DTO<String>>

an array of the corresponding DTOs contained in the room shared element with identifier id

1.42.4. restoreSharedElement

URL

${jsonUrl}/roomShared/{id}/unshare?containerId&offsetX&offsetY

Method

PUT

Description

Restores the elements from a shared element to the given position within the given container.

Parameters

id

Path Variable

String

the room shared element’s identifier

containerId

Request Param

String

identifier of the container in which the elements will be restored

offsetX

Request Param

int

X coordinate of the position where the upper left corner will be restored

offsetY

Request Param

int

Y coordinate of the position where the upper left corner will be restored

Response Body

List<DTO<String>>

an array of the changed elements' DTOs

1.42.5. undoShare

URL

${jsonUrl}/roomShared/{id}/undo

Method

POST

Description

Undoes shared element creation. Removes the shared element from the room, and restores the board elements from this shared element into their original board (with same id).

Parameters

id

Path Variable

String

the identifier of the shared element whose creation should be undone

originalIds

Request Body

List<String>

the identifiers of the original elements to restore

Response Body

List<DTO<String>>

an array of DTOs of the changed elements

1.42.6. create

URL

${jsonUrl}/roomShared

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<RoomSharedElementDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.42.7. findByIds

URL

${jsonUrl}/roomShared/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<RoomSharedElementDTO>

a list of the found elements DTOs

1.42.8. update

URL

${jsonUrl}/roomShared

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<RoomSharedElementDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.42.9. delete

URL

${jsonUrl}/roomShared/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.42.10. remove

URL

${jsonUrl}/roomShared/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.42.11. undelete

URL

${jsonUrl}/roomShared/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.43. ScreenshotService

Screenshot’s remoting service.

List of Methods

generateScreenshot

1.43.1. generateScreenshot

URL

${jsonUrl}/screenshot/{id}

Method

POST

Description

Requests the generation of a board’s screenshot.

Parameters

id

Path Variable

String

the board’s identifier

Response Body

BoardDTO

the DTO of the board whose identifier is id

1.44. ToolConfigurationService

Tool configuration service.

List of Methods

findElementsByContainer, create, findByIds, update, delete, remove, undelete

1.44.1. findElementsByContainer

URL

${jsonUrl}/tools?container

Method

GET

Description

Finds all tool configurations in a room.

Parameters

container

Request Param

String

identifier of the room

Response Body

List<ToolConfigurationBaseDTO>

an array of all the tool configuration DTOs in the room

1.44.2. create

URL

${jsonUrl}/tools

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<ToolConfigurationBaseDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.44.3. findByIds

URL

${jsonUrl}/tools/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<ToolConfigurationBaseDTO>

a list of the found elements DTOs

1.44.4. update

URL

${jsonUrl}/tools

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<ToolConfigurationBaseDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.44.5. delete

URL

${jsonUrl}/tools/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.44.6. remove

URL

${jsonUrl}/tools/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.44.7. undelete

URL

${jsonUrl}/tools/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

1.45. UserService

User’s Remoting service.

List of Methods

update, findPagedAudienceUsers, findByUsername, findByCriteriaForRoom, findDomainCanUse, findDomainCanPublishModel, addAvatar, removeAvatar, changeLanguage, canAccessToStandardDomains

1.45.1. update

URL

${jsonUrl}/users

Method

PUT

Description

Updates users.

Parameters

dtos

Request Body

List<UserDTO>

DTOs of the users to update

Response Body

List<UserDTO>

an array of fully populated DTOs of the updated users

1.45.2. findPagedAudienceUsers

URL

${jsonUrl}/users?from&maxCount&searchText

Method

GET

Description

Retrieves a bounded number of all users matching a searchText, with a fullname lower bound.

The pair (afterFirstname, afterLastname) defines a lowerbound for the search whose result is ordered by ascending (firstname, lastname). They have to be both defined to be taken into account, else the search won’t have a lowerbound.

Only the groups having access to at least one domain accessible by the user are returned.

Parameters

(from)

Request Param

Integer

(optional) the first item position (start at 0)

(maxCount)

Request Param

Integer

(optional) the maximum number of results (unlimited if undefined)

(searchText)

Request Param

String

(optional) the text to search in firstname or lastname

Response Body

PagedResultDTO

a list of all the matching users ordered by ascending (firstname, lastname)

1.45.3. findByUsername

URL

${jsonUrl}/users?username

Method

GET

Description

Finds a user by name.

Parameters

username

Request Param

String

the username of the user to search for

Response Body

UserDTO

the DTO of the found user or null if there is no user with this username

1.45.4. findByCriteriaForRoom

URL

${jsonUrl}/users/{roomId}/criteria?from&maxCount

Method

POST

Description

Finds users with read access on a room and further criteria.

Parameters

criteria

Request Body

List<Criterion>

an array of criteria on users

roomId

Path Variable

String

the identifier of the room the users should have read access to

(from)

Request Param

Integer

(optional)

(maxCount)

Request Param

Integer

(optional)

Response Body

List<UserDTO>

an array of the corresponding users' DTOs

1.45.5. findDomainCanUse

URL

${jsonUrl}/users/{roomId}/canUseDomain

Method

POST

Description

Finds users that can be use the domain of the given room, in addition to further criteria.

Parameters

criteria

Request Body

List<Criterion>

an array of criteria on users

roomId

Path Variable

String

the identifier of the room in the domain in which the users should be able to be administrator

Response Body

List<UserDTO>

an array of the corresponding users' DTOs

1.45.6. findDomainCanPublishModel

URL

${jsonUrl}/users/{roomId}/canPublishModel

Method

POST

Description

Finds users that can publish room models in the domain of the given room, in addition to further criteria.

Parameters

criteria

Request Body

List<Criterion>

an array of criteria on users

roomId

Path Variable

String

the identifier of the room in the domain in which the users should be able to publish a room as model

Response Body

List<UserDTO>

an array of the corresponding users' DTOs

1.45.7. addAvatar

URL

${jsonUrl}/users/addAvatar

Method

POST

Description

Add avatar to current user.

Parameters

dataStr

Request Body

String

Response Body

UserDTO

1.45.8. removeAvatar

URL

${jsonUrl}/users/removeAvatar

Method

POST

Description

Remove avatar from current user.

Parameters

no parameters

Response Body

UserDTO

1.45.9. changeLanguage

URL

${jsonUrl}/users/changeLanguage

Method

POST

Description

Change current user’s language.

Parameters

language

Request Body

String

Response Body

UserDTO

1.45.10. canAccessToStandardDomains

URL

${jsonUrl}/users/canAccessToStandardDomains

Method

GET

Description

Checks if the current user can access to iobeya Standard domains (and not only instant meeting domain).

Parameters

no parameters

Response Body

Boolean

TRUE if current user can access to standard domains, or FALSE if he can’t

1.46. ViewMessagingService

View service.

List of Methods

registerForView, registerForViewType, notifyViewActivity, unregisterForView, unregisterForViewType

1.46.1. registerForView

URL

${jsonUrl}/view/registerForView/{clientId}?viewType&viewId

Method

GET

Description

Registers a client for view activity.

Parameters

clientId

Path Variable

String

the client’s identifier

viewType

Request Param

String

String viewType

viewId

Request Param

String

String viewId

Response Body

void

1.46.2. registerForViewType

URL

${jsonUrl}/view/registerForViewType/{clientId}?viewType

Method

GET

Description

Registers a client for view type activity..

Parameters

clientId

Path Variable

String

the client’s identifier

viewType

Request Param

String

String viewType

Response Body

void

1.46.3. notifyViewActivity

URL

${jsonUrl}/view/viewActivity/{activityType}?viewType&viewId

Method

GET

Description

Notifies that a view activity has occurred.

Parameters

activityType

Path Variable

String

the client’s identifier

viewType

Request Param

String

String viewType

viewId

Request Param

String

String viewId

Response Body

void

1.46.4. unregisterForView

URL

${jsonUrl}/view/unregisterForView/{clientId}?viewType&viewId

Method

GET

Description

Unregisters a client for view activity.

Parameters

clientId

Path Variable

String

the client’s identifier

viewType

Request Param

String

String viewType

viewId

Request Param

String

String viewId

Response Body

void

1.46.5. unregisterForViewType

URL

${jsonUrl}/view/unregisterForViewType/{clientId}?viewType

Method

GET

Description

Unregisters a client for view type activity..

Parameters

clientId

Path Variable

String

the client’s identifier

viewType

Request Param

String

String viewType

Response Body

void

1.47. VoteService

Vote service.

List of Methods

saveConfig, updateVoteScore, getCurrentVoteSession, stopVoteSession, deleteConfig

1.47.1. saveConfig

URL

${jsonUrl}/meeting/vote/saveVoteConfig

Method

POST

Description

Creates a vote configuration.

Parameters

voteConfig

Request Body

VoteConfigurationDTO

the vote configuration

Response Body

void

1.47.2. updateVoteScore

URL

${jsonUrl}/meeting/vote/updateScore/{elementId}?delta

Method

GET

Description

Updates the vote related to passed username/elementId with a delta.

Parameters

elementId

Path Variable

String

board element id related to vote.

delta

Request Param

int

delta to be added as vote.

Response Body

List<Integer>

result and remaining points.

1.47.3. getCurrentVoteSession

URL

${jsonUrl}/meeting/vote/getVoteSession/{roomId}

Method

GET

Description

Returns the current vote session of the user in the room specified.

Parameters

roomId

Path Variable

String

room id in which the vote is created.

Response Body

VoteSessionDTO

the current vote session.

1.47.4. stopVoteSession

URL

${jsonUrl}/meeting/vote/stopVoteSession/{roomId}

Method

GET

Description

Stops the vote session within the room.

Parameters

roomId

Path Variable

String

room id in which the vote is created.

Response Body

List<BoardElementDTO>

the list of board elements voted.

1.47.5. deleteConfig

URL

${jsonUrl}/meeting/vote/deleteVoteConfig

Method

POST

Description

Deletes a vote configuration.

Parameters

voteConfig

Request Body

VoteConfigurationDTO

the vote configuration

Response Body

void

1.48. WallCategoryService

Wall Category’s Remoting service.

List of Methods

clone, findElementsByContainer, create, findByIds, update, delete, remove, undelete

1.48.1. clone

URL

${jsonUrl}/wallCategories/clone

Method

PUT

Description

Clones wall categories.

Description of the usage of each field in the DTOs of dtos:

- ignored and automatically set: modificationDate, modifier

- from the dto if not null, otherwise generated: id

- always from the source: all the other fields.

Parameters

params

Request Body

CloneParamDTO<WallCategoryDTO>

the source ids and target DTOs as a CloneParamDTO object

Response Body

List<DTO<String>>

an array of all the clones' DTOs (the wall categories), as well as the boards and wall categories moved to make room for these new wall categories, all of class BoardDTO or WallCategoryDTO

1.48.2. findElementsByContainer

URL

${jsonUrl}/wallCategories?container

Method

GET

Description

Finds all the wall categories in a room.

Parameters

container

Request Param

String

the room’s identifier

Response Body

List<WallCategoryDTO>

an array of DTOs of all the wall categories in the room

1.48.3. create

URL

${jsonUrl}/wallCategories

Method

POST

Description

Creates elements.

Parameters

dtos

Request Body

List<WallCategoryDTO>

the DTOs to create

Response Body

List<DTO<String>>

a list of the effectively created elements DTOs

1.48.4. findByIds

URL

${jsonUrl}/wallCategories/{ids}

Method

GET

Description

Finds elements by id. Only non-deleted elements are returned. Order is not guaranteed.

Parameters

ids

Path Variable

List<String>

the identifiers of the elements to find

Response Body

List<WallCategoryDTO>

a list of the found elements DTOs

1.48.5. update

URL

${jsonUrl}/wallCategories

Method

PUT

Description

Updates elements.

Parameters

dtos

Request Body

List<WallCategoryDTO>

the DTOs to update

Response Body

List<DTO<String>>

an array of the effectively updated elements DTOs

1.48.6. delete

URL

${jsonUrl}/wallCategories/{ids}

Method

DELETE

Description

Deletes elements.

Parameters

ids

Path Variable

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.48.7. remove

URL

${jsonUrl}/wallCategories/delete

Method

POST

Description

Deletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the elements to delete

Response Body

List<DTO<String>>

a list of the effectively deleted elements DTOs

1.48.8. undelete

URL

${jsonUrl}/wallCategories/undelete

Method

POST

Description

Undeletes elements.

Parameters

ids

Request Body

List<String>

identifiers of the previously deleted elements to undelete

Response Body

List<DTO<String>>

a list of the effectively undeleted elements DTOs

2. DTO Hierarchy

3. DTOs

3.1. AbstractBoardTextDTO

Qualified name

com.iobeya.dto.abs.AbstractBoardTextDTO

Direct ancestors

BoardElementDTO

Direct descendants

BoardFreetextDTO, BoardLabelDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.abs.AbstractBoardTextDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int) Text color.
  "fontSize": "string",       // (string) A font size to be chosen from predefined
                              // values : 12, 14, 18, 24, 36, 48, 60, 72, 96, 120, 144,
                              // 180, 228, 276.
  "textAlign": "string",      // (string) Horizontal text alignment. Value should be
                              // 'left', 'right', 'center' or 'justify'.
  "textVerticalAlign": "string", // (string) Vertical text alignment. Value should be
                              // 'top', 'middle', 'bottom'.
  "textAutofit": true,        // (bool) Whether the text should fit the element size.
                              // In that case, the fontSize value is not useful.
  "fitToText": true,          // (bool) Whether the element should resize according to
                              // the font size.
  "contentLabel": "string",   // (string) Main label of the element.
  "linkLabel": "string",      // (string) Label of the associated hyperlink '#linkUrl'
                              // .
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "fontFamily": "string",     // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.2. AbstractChartDataDTO

Qualified name

com.iobeya.dto.abs.AbstractChartDataDTO

Direct ancestors

BoardElementChildDTO

Direct descendants

ChartDataColumnDTO, ChartDataRowDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.abs.AbstractChartDataDTO",
  "index": 1,                 // (int)
  "label": "string",          // (string)
  "color": 1,                 // (int)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.3. AbstractSyncElementReferenceDTO

Qualified name

com.iobeya.api.dto.abs.AbstractSyncElementReferenceDTO

Direct ancestors

HistorizedDTO

Direct descendants

ElementSharingProposalDTO, SyncElementReferenceDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.AbstractSyncElementReferenceDTO",
  "id": "string",             // (string)
  "boardElement": {},         // (EntityReferenceDTO)
  "weakRef": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.4. AbstractTextToolSetItemDTO

Qualified name

com.iobeya.dto.abs.AbstractTextToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Direct descendants

FreetextToolSetItemDTO, LabelToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.abs.AbstractTextToolSetItemDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int)
  "fontSize": "string",       // (string)
  "textAlign": "string",      // (string)
  "textVerticalAlign": "string", // (string)
  "textAutofit": true,        // (bool)
  "fitToText": true,          // (bool)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.5. AddToCollectionParamDTO

Qualified name

com.iobeya.dto.AddToCollectionParamDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AddToCollectionParamDTO",
  "masterId": "string",       // (string) The id of the parent element master.
  "elementId": "string",      // (string) The id of the parent element.
  "boardElementsIds": ["string"], // (string[]) List of elements ids to add to the
                              // collection.
  "modifierClientId": "string", // (string)
}

3.6. AnimationReportDTO

Qualified name

com.iobeya.dto.AnimationReportDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AnimationReportDTO",
  "id": 1,                    // (Long)
  "roomId": "string",         // (string)
  "status": 1,                // (int)
  "guidanceInfo": {},         // (object)
  "endDate": 86400000,        // (timestamp)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.7. AnnouncementCountDTO

Qualified name

com.iobeya.dto.AnnouncementCountDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AnnouncementCountDTO",
  "totalAnnouncements": 1,    // (long)
  "totalMajorAnnouncements": 1, // (long)
  "newAnnouncements": 1,      // (long)
  "newMajorAnnouncements": 1, // (long)
}

3.8. AnnouncementDTO

Qualified name

com.iobeya.dto.AnnouncementDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AnnouncementDTO",
  "id": {},                   // (UUID)
  "type": "string",           // (string)
  "title": "string",          // (string)
  "content": "string",        // (string)
  "priority": 1,              // (int)
  "endDate": 86400000,        // (timestamp)
  "startDate": 86400000,      // (timestamp)
  "linkTitle": "string",      // (string)
  "link": "string",           // (string)
  "userRead": true,           // (bool)
  "props": {},                // (JsonNode)
  "iconClass": "string",      // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.9. AssetContainerDTO

Asset ContainerDTO Class.

Qualified name

com.iobeya.dto.AssetContainerDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AssetContainerDTO",
  "id": "string",             // (string)
  "kind": "string",           // (string)
  "room": {},                 // (EntityReferenceDTO) The room.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.10. AssetDTO

Qualified name

com.iobeya.dto.AssetDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AssetDTO",
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Usually a board
  "id": "string",             // (string) ID of the asset.
  "assetWidth": 1,            // (int) Asset width, in pixels.
  "assetHeight": 1,           // (int) Asset height, in pixels.
  "mimeType": "string",       // (string) Asset mime-type.
  "dataLocation": "string",   // (string) Asset dataLocation (URL or byte array).
  "data": [1],                // (byte) Asset data.
  "urls": [{}],               // (ImageUrlDTO[]) Image urls.
  "name": "string",           // (string) Asset name.
  "category": "string",       // (string) Asset category.
  "isSystem": true,           // (bool) True is asset is system (not overwritable).
  "isShared": true,           // (bool) True is asset can be shared.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.11. AssetLibraryToolSetDTO

Qualified name

com.iobeya.dto.AssetLibraryToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AssetLibraryToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.12. AssetLibraryToolSetItemDTO

Qualified name

com.iobeya.dto.AssetLibraryToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AssetLibraryToolSetItemDTO",
  "asset": {},                // (EntityReferenceDTO)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.13. AssignableElementDTO

Qualified name

com.iobeya.api.dto.abs.AssignableElementDTO

Direct ancestors

BoardElementDTO

Direct descendants

BoardCardDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.AssignableElementDTO",
  "assignees": [{}],          // (List<Assignee>)
  "boardId": "string",        // (string)
  "boardName": "string",      // (string)
  "roomName": "string",       // (string)
  "isArchived": true,         // (bool)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool) True if the element is not allowed to be moved.
  "width": 1,                 // (int) Width of the board element.
  "height": 1,                // (int) Width of the board element.
  "x": 1,                     // (int) Absolute x coordinate of the board element.
  "y": 1,                     // (int) Absolute y coordinate of the board element.
  "zOrder": 1,                // (int) The absolute level of depth of the element among
                              // other elements. It should be equal or greater than 0.
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Usually a board
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.14. AssignmentDTO

DTO defining Affectation.

Qualified name

com.iobeya.dto.AssignmentDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AssignmentDTO",
  "username": "string",       // (string) Username of the user.
  "firstName": "string",      // (string) Firstname of the user.
  "lastName": "string",       // (string) Lastname of the user.
  "color": 1,                 // (int) Color of the user.
  "elementId": "string",      // (string) Board Element Id.
  "assignmentDate": 86400000, // (timestamp) Affectation Date.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.15. AsyncResponse

Response sent when using AsyncService.

Qualified name

com.iobeya.api.async.AsyncResponse

Example JSon object
{
  "@class" : "com.iobeya.api.async.AsyncResponse",
}

3.16. AuthApplicationInstanceDTO

Qualified name

com.iobeya.dto.auth.client.AuthApplicationInstanceDTO

Direct ancestors

HistorizedDTO

Direct descendants

OauthApplicationInstanceDTO, PatApplicationInstanceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.auth.client.AuthApplicationInstanceDTO",
  "id": "string",             // (string)
  "applicationTypeId": "string", // (string)
  "name": "string",           // (string)
  "description": "string",    // (string)
  "baseUrl": "string",        // (string)
  "domainId": "string",       // (string) Domain Id.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.17. AuthApplicationTypeDTO

Qualified name

com.iobeya.dto.auth.client.AuthApplicationTypeDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.auth.client.AuthApplicationTypeDTO",
  "id": "string",             // (string)
  "type": "string",           // (string)
  "description": "string",    // (string)
  "instanceCount": 1,         // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.18. AuthUserTokensDTO

Qualified name

com.iobeya.dto.auth.client.AuthUserTokensDTO

Direct ancestors

DTO

Direct descendants

OauthUserTokensDTO, PatUserTokensDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.auth.client.AuthUserTokensDTO",
  "id": "string",             // (string)
  "name": "string",           // (string)
  "username": "string",       // (string)
  "applicationInstanceId": "string", // (string)
  "applicationInstanceName": "string", // (string)
  "accessToken": "string",    // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.19. AuthenticationMechanismDTO

Created by akartmann on 30/12/2015.

Qualified name

com.iobeya.dto.AuthenticationMechanismDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AuthenticationMechanismDTO",
  "id": "string",             // (string) ID of the source.
  "enabled": true,            // (bool)
  "policy": {},               // (EntityReferenceDTO) Policy.
  "order": 1,                 // (int) Order of mechanism in the set.
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "credentials": "string",    // (string)
  "configuration": {},        // (JsonNode)
  "provider": "string",       // (string)
  "category": "string",       // (string)
  "icon": {},                 // (AssetDTO) DTO of the icon.
  "color": 1,                 // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.20. AuthenticationPolicyBaseDTO

Created by akartmann on 13/09/2017.

Qualified name

com.iobeya.dto.AuthenticationPolicyBaseDTO

Direct ancestors

HistorizedDTO

Direct descendants

AuthenticationPolicyDTO, AuthenticationPolicyMechanismsDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AuthenticationPolicyBaseDTO",
  "id": "string",             // (string) ID of the source.
  "enabled": true,            // (bool)
  "valid": true,              // (bool)
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.21. AuthenticationPolicyDTO

Created by akartmann on 30/12/2015.

Qualified name

com.iobeya.dto.AuthenticationPolicyDTO

Direct ancestors

AuthenticationPolicyBaseDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AuthenticationPolicyDTO",
  "id": "string",             // (string) ID of the source.
  "enabled": true,            // (bool)
  "valid": true,              // (bool)
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.22. AuthenticationPolicyMechanismsDTO

Created by akartmann on 30/12/2015.

Qualified name

com.iobeya.dto.AuthenticationPolicyMechanismsDTO

Direct ancestors

AuthenticationPolicyBaseDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.AuthenticationPolicyMechanismsDTO",
  "mechanisms": [{}],         // (List<AuthenticationMechanismDTO>)
  "id": "string",             // (string) ID of the source.
  "enabled": true,            // (bool)
  "valid": true,              // (bool)
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.23. BoardCardDTO

Only 3 sizes are allowed for the card. Allowed values for width and height are 150/105, 150/150 and 375/225

Qualified name

com.iobeya.dto.BoardCardDTO

Direct ancestors

AssignableElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardCardDTO",
  "asset": {},                // (EntityReferenceDTO) Asset.
  "color": 1,                 // (int) Color of the card.
  "linkLabel": "string",      // (string) Label of the associated hyperlink.
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "props": {},                // (JsonNode)
  "fontFamily": "string",     // (string) Not to be set, used for legacy reasons.
  "entityType": "string",     // (string)
  "checklist": [{}],          // (List<ChecklistItemDTO>)
  "assignees": [{}],          // (List<Assignee>)
  "boardId": "string",        // (string)
  "boardName": "string",      // (string)
  "roomName": "string",       // (string)
  "isArchived": true,         // (bool)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.24. BoardChartDTO

Chart DTO.

Qualified name

com.iobeya.dto.BoardChartDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardChartDTO",
  "kind": "string",           // (string)
  "minScalePolicy": "string", // (string)
  "maxScalePolicy": "string", // (string)
  "minScale": 1.5,            // (double)
  "maxScale": 1.5,            // (double)
  "linkLabel": "string",      // (string)
  "linkUrl": "string",        // (string)
  "isMultiColored": true,     // (bool)
  "color": 1,                 // (int)
  "orientation": "string",    // (string)
  "selectedRow": "string",    // (string)
  "seriesInColumns": true,    // (bool)
  "legendDataType": "string", // (string)
  "showDataLabels": true,     // (bool)
  "dataLabelsUnit": "string", // (string)
  "label": "string",          // (string)
  "asset": {},                // (EntityReferenceDTO)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.25. BoardChildDTO

Abstract BoardChildDTO Class.

Qualified name

com.iobeya.api.dto.abs.BoardChildDTO

Direct ancestors

HistorizedDTO

Direct descendants

FlexibleBoardChildDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.BoardChildDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The container of the child. Must
                              // be a Element container.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.26. BoardDTO

Qualified name

com.iobeya.dto.BoardDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardDTO",
  "id": "string",             // (string)
  "isModel": true,            // (bool) Is it a model ?.
  "container": {},            // (EntityReferenceDTO) The room.
  "elementContainer": {},     // (EntityReferenceDTO) The element container.
  "needScreenshot": true,     // (bool)
  "needPNGScreenshot": true,  // (bool)
  "name": "string",           // (string) Name of the board.
  "description": "string",    // (string) Description of the board.
  "width": 1,                 // (int) Board width, in pixels.
  "height": 1,                // (int) Board height, in pixels.
  "shareStatus": 'c',         // (char) Board sharing status.
  "linkBoardRoomName": "string", // (string) Link board room name.
  "hasControl": true,         // (bool) HasControl property. It's used for linkBoards
                              // only to know if we loose the control.
  "x": 1,                     // (int) Board position in pixels.
  "y": 1,                     // (int) Board position in pixels.
  "backgroundColor": 1,       // (int) Background plain color.
  "screenshot": {},           // (EntityReferenceDTO) Board screenshot.
  "miniature": {},            // (EntityReferenceDTO) Board miniature.
  "background": {},           // (EntityReferenceDTO) Board background.
  "isLocked": true,           // (bool) Whether the board is locked or not.
  "privacy": 1,               // (int) Privacy property of the board (not visible from
                              // guest visitors).
  "permissionMask": 1,        // (int) Permission mask.
  "detailedLoadDate": 86400000, // (timestamp)
  "size": {},                 // (EntityReferenceDTO)
  "boardType": "string",      // (string) entityType for
                              // 'com.iobeya.entity.ElementContainer' .
  "boardProps": {},           // (JsonNode) props for
                              // 'com.iobeya.entity.ElementContainer' .
  "boardDock": {},            // (EntityReferenceDTO) The dock.
  "inSlideshow": true,        // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.27. BoardDockDTO

Board Dock Class.

Qualified name

com.iobeya.dto.BoardDockDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardDockDTO",
  "id": "string",             // (string)
  "room": {},                 // (EntityReferenceDTO)
  "toolSets": [{}],           // (List<EntityReferenceDTO>)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.28. BoardDrawingDTO

Qualified name

com.iobeya.dto.BoardDrawingDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardDrawingDTO",
  "points": [{}],             // (BoardPointDTO[]) Points.
  "shape": [{}],              // (DrawPointDTO[]) Shape.
  "style": "string",          // (string) Style.
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.29. BoardElementChildDTO

Abstract BoardElementChildDTO Class.

Qualified name

com.iobeya.api.dto.abs.BoardElementChildDTO

Direct ancestors

HistorizedDTO

Direct descendants

BoardElementCollectionItemDTO, ChartDataCellDTO, FlexibleBoardElementChildDTO, AbstractChartDataDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.BoardElementChildDTO",
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO) The element of the child. Must be
                              // a BoardElement.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.30. BoardElementCollectionItemDTO

Qualified name

com.iobeya.dto.BoardElementCollectionItemDTO

Direct ancestors

BoardElementChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardElementCollectionItemDTO",
  "itemElementRef": {},       // (EntityReferenceDTO)
  "syncInstancesCount": 1,    // (int)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO) The element of the child. Must be
                              // a BoardElement.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.31. BoardElementContainersDTO

The DTO of BoardElementContainers.

Qualified name

com.iobeya.api.dto.BoardElementContainersDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.BoardElementContainersDTO",
}

3.32. BoardElementDTO

A board element is any element that can be added to a board.

Fields x and y are the absolute position of the board element inside its board container. x and y should be greater than 0 and should not exceed the board container limit.

Fields width and height are the size of the element. An element should always fit inside the board it belongs.

Qualified name

com.iobeya.api.dto.abs.BoardElementDTO

Direct ancestors

HistorizedDTO

Direct descendants

AssignableElementDTO, EdgeBoardElementDTO, BoardChartDTO, BoardDrawingDTO, BoardGaugeDTO, BoardImageDTO, BoardNoteDTO, BoardRollDTO, BoardStickerDTO, BoardTeamDTO, ButtonDTO, AbstractBoardTextDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.BoardElementDTO",
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool) True if the element is not allowed to be moved.
  "width": 1,                 // (int) Width of the board element.
  "height": 1,                // (int) Width of the board element.
  "x": 1,                     // (int) Absolute x coordinate of the board element.
  "y": 1,                     // (int) Absolute y coordinate of the board element.
  "zOrder": 1,                // (int) The absolute level of depth of the element among
                              // other elements. It should be equal or greater than 0.
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Usually a board
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.33. BoardFreetextDTO

Qualified name

com.iobeya.dto.BoardFreetextDTO

Direct ancestors

AbstractBoardTextDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardFreetextDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int) Text color.
  "fontSize": "string",       // (string) A font size to be chosen from predefined
                              // values : 12, 14, 18, 24, 36, 48, 60, 72, 96, 120, 144,
                              // 180, 228, 276.
  "textAlign": "string",      // (string) Horizontal text alignment. Value should be
                              // 'left', 'right', 'center' or 'justify'.
  "textVerticalAlign": "string", // (string) Vertical text alignment. Value should be
                              // 'top', 'middle', 'bottom'.
  "textAutofit": true,        // (bool) Whether the text should fit the element size.
                              // In that case, the fontSize value is not useful.
  "fitToText": true,          // (bool) Whether the element should resize according to
                              // the font size.
  "contentLabel": "string",   // (string) Main label of the element.
  "linkLabel": "string",      // (string) Label of the associated hyperlink '#linkUrl'
                              // .
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "fontFamily": "string",     // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.34. BoardGaugeDTO

Gauge DTO.

Qualified name

com.iobeya.dto.BoardGaugeDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardGaugeDTO",
  "kind": "string",           // (string)
  "minScalePolicy": "string", // (string)
  "maxScalePolicy": "string", // (string)
  "minScale": 1.5,            // (double)
  "maxScale": 1.5,            // (double)
  "linkLabel": "string",      // (string)
  "linkUrl": "string",        // (string)
  "isMultiColored": true,     // (bool)
  "color": 1,                 // (int)
  "needleValue": 1.5,         // (double)
  "themeIndex": 1,            // (int)
  "thresholdsNumber": 1,      // (int)
  "threshold1": 1.5,          // (double)
  "threshold2": 1.5,          // (double)
  "threshold3": 1.5,          // (double)
  "threshold4": 1.5,          // (double)
  "threshold5": 1.5,          // (double)
  "label": "string",          // (string)
  "showValue": true,          // (bool)
  "showMinMax": true,         // (bool)
  "showticks": true,          // (bool)
  "invertColors": true,       // (bool)
  "valueUnit": "string",      // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.35. BoardImageDTO

Qualified name

com.iobeya.api.dto.BoardImageDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.BoardImageDTO",
  "assetId": "string",        // (string)
}

3.36. BoardImageDTO

Qualified name

com.iobeya.dto.BoardImageDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardImageDTO",
  "asset": {},                // (EntityReferenceDTO) A reference to the asset.
  "linkLabel": "string",      // (string) Label of the associated hyperlink '#linkUrl'
                              // .
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "fromLibrary": true,        // (bool) Whether the image has been created from an
                              // image library.
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.37. BoardLabelDTO

Qualified name

com.iobeya.dto.BoardLabelDTO

Direct ancestors

AbstractBoardTextDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardLabelDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int) Text color.
  "fontSize": "string",       // (string) A font size to be chosen from predefined
                              // values : 12, 14, 18, 24, 36, 48, 60, 72, 96, 120, 144,
                              // 180, 228, 276.
  "textAlign": "string",      // (string) Horizontal text alignment. Value should be
                              // 'left', 'right', 'center' or 'justify'.
  "textVerticalAlign": "string", // (string) Vertical text alignment. Value should be
                              // 'top', 'middle', 'bottom'.
  "textAutofit": true,        // (bool) Whether the text should fit the element size.
                              // In that case, the fontSize value is not useful.
  "fitToText": true,          // (bool) Whether the element should resize according to
                              // the font size.
  "contentLabel": "string",   // (string) Main label of the element.
  "linkLabel": "string",      // (string) Label of the associated hyperlink '#linkUrl'
                              // .
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "fontFamily": "string",     // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.38. BoardNoteDTO

Only 3 sizes are allowed for the note. Allowed values for width and height are 150/105, 150/150 and 375/225

Qualified name

com.iobeya.dto.BoardNoteDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardNoteDTO",
  "asset": {},                // (EntityReferenceDTO) Asset.
  "color": 1,                 // (int) Color of the note.
  "linkLabel": "string",      // (string) Label of the associated hyperlink.
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "contentLabel": "string",   // (string) Main label of the element.
  "props": {},                // (JsonNode)
  "fontFamily": "string",     // (string) Not to be set, used for legacy reasons.
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.39. BoardRollDTO

Qualified name

com.iobeya.dto.BoardRollDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardRollDTO",
  "color": 1,                 // (int) Color of the note.
  "linkLabel": "string",      // (string) Label of the associated hyperlink '#linkUrl'
                              // .
  "linkUrl": "string",        // (string) Url of the hyperlink.
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.40. BoardSharedElementDTO

Qualified name

com.iobeya.dto.BoardSharedElementDTO

Direct ancestors

SharedElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardSharedElementDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "elementContainer": {},     // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "contentWidth": 1,          // (int)
  "contentHeight": 1,         // (int)
  "icon": {},                 // (EntityReferenceDTO) icon.
  "kind": "string",           // (string)
  "ids": ["string"],          // (string[])
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.41. BoardSharingProposalDTO

Qualified name

com.iobeya.dto.BoardSharingProposalDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardSharingProposalDTO",
  "id": "string",             // (string)
  "username": "string",       // (string)
  "userFullName": "string",   // (string)
  "board": {},                // (EntityReferenceDTO)
  "roomName": "string",       // (string)
  "status": 'c',              // (char) Status : proposed / active / refused (can't be
                              // null). 'P' /'A'/ 'R';
  "shareStatus": 'c',         // (char)
  "isPublic": true,           // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.42. BoardSizeDTO

Qualified name

com.iobeya.dto.BoardSizeDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardSizeDTO",
  "id": "string",             // (string)
  "label": "string",          // (string)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "outerWidth": 1,            // (int)
  "outerHeight": 1,           // (int)
  "offsetX": 1,               // (int)
  "offsetY": 1,               // (int)
  "nCellX": 1,                // (int)
  "nCellY": 1,                // (int)
  "ratio": 1.5,               // (double)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.43. BoardStickerDTO

Only 3 sizes are allowed for the sticker. Allowed values for width and height are 32/32, 64/64, 112/112

Qualified name

com.iobeya.dto.BoardStickerDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardStickerDTO",
  "stickerImage": {},         // (EntityReferenceDTO) Reference to the image if the
                              // sticker is not a colored sticker.
  "isColoredSticker": true,   // (bool) Whether the sticker is a colored sticker. false
                              // means it's an image.
  "color": 1,                 // (int) Color of the sticker if it's a colored sticker.
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.44. BoardTeamDTO

Qualified name

com.iobeya.dto.BoardTeamDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.BoardTeamDTO",
  "avatar": {},               // (EntityReferenceDTO)
  "username": "string",       // (string)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.45. ButtonDTO

Qualified name

com.iobeya.dto.ButtonDTO

Direct ancestors

BoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ButtonDTO",
  "entityType": "string",     // (string)
  "textAlign": "string",      // (string) Text align.
  "fontColor": 1,             // (int) Text color.
  "backgroundColor": 1,       // (int) Background color.
  "borderColor": 1,           // (int) Border color.
  "label": "string",          // (string)
  "url": "string",            // (string)
  "appendContext": true,      // (bool)
  "followGuide": true,        // (bool)
  "type": {},                 // (ButtonType)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.46. ButtonToolSetDTO

Qualified name

com.iobeya.dto.ButtonToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ButtonToolSetDTO",
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.47. CardToolSetDTO

Qualified name

com.iobeya.dto.CardToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.CardToolSetDTO",
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.48. CardToolSetItemDTO

Qualified name

com.iobeya.dto.CardToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.CardToolSetItemDTO",
  "color": 1,                 // (int)
  "containsSmallSize": true,  // (bool)
  "containsMediumSize": true, // (bool)
  "containsLargeSize": true,  // (bool)
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.49. CatalogDTO

Qualified name

com.iobeya.dto.CatalogDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.CatalogDTO",
  "id": "string",             // (string)
  "name": "string",           // (string) Name of the board.
  "isSystem": true,           // (bool)
  "container": {},            // (EntityReferenceDTO)
  "detailedLoadDate": 86400000, // (timestamp)
  "defaultToolSets": [{}],    // (List<EntityReferenceDTO>)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.50. ChartDataCellDTO

Qualified name

com.iobeya.dto.ChartDataCellDTO

Direct ancestors

BoardElementChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChartDataCellDTO",
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "val": 1.5,                 // (double)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.51. ChartDataColumnDTO

Qualified name

com.iobeya.dto.ChartDataColumnDTO

Direct ancestors

AbstractChartDataDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChartDataColumnDTO",
  "index": 1,                 // (int)
  "label": "string",          // (string)
  "color": 1,                 // (int)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.52. ChartDataRowDTO

Qualified name

com.iobeya.dto.ChartDataRowDTO

Direct ancestors

AbstractChartDataDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChartDataRowDTO",
  "index": 1,                 // (int)
  "label": "string",          // (string)
  "color": 1,                 // (int)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.53. ChartToolSetDTO

Qualified name

com.iobeya.dto.ChartToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChartToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.54. ChartToolSetItemDTO

Qualified name

com.iobeya.dto.ChartToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChartToolSetItemDTO",
  "kind": "string",           // (string)
  "isMultiColored": true,     // (bool)
  "color": 1,                 // (int)
  "iconClass": "string",      // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.55. ChecklistItemDTO

Qualified name

com.iobeya.dto.ChecklistItemDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ChecklistItemDTO",
  "label": "string",          // (string)
  "status": true,             // (bool)
  "index": 1,                 // (int)
  "parentId": "string",       // (string)
  "kind": "string",           // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.56. CloneParamDTO<K>

Qualified name

com.iobeya.dto.CloneParamDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.CloneParamDTO",
  "ids": ["string"],          // (string[]) The IDs of the source objects to clone.
  "dtos": [{}],               // (K[]) The DTOs containing the properties to be
                              // replaced.  The properties taken into account are
                              // chosen by the method using this 'CloneParamDTO' .
}

3.57. CorsDTO

Qualified name

com.iobeya.dto.CorsDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.CorsDTO",
  "id": 1,                    // (Integer)
  "label": "string",          // (string)
  "url": "string",            // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.58. CountdownMessage

Countdown message.

Qualified name

com.iobeya.messaging.message.CountdownMessage

Example JSon object
{
  "@class" : "com.iobeya.messaging.message.CountdownMessage",
  "countdownValue": 1,        // (int) Countdown value.
  "countdownTimeElapsed": true, // (bool) Countdown value is time elapsed or time
                              // remaining.
  "initialCountdownValue": 1, // (int) Countdown initial value.
  "type": "string",           // (string) Type.
  "messageId": "string",      // (string) Message Id.
  "senderClientId": "string", // (string) Sender message Id.
  "destinationClientId": "string", // (string) Destination client Id. If set, only this
                              // client will receive the message.
  "roomId": "string",         // (string) Destination room. If set, only clients in
                              // this room will receive the message.
  "destinationUser": "string", // (string) Destination username. If set, only clients
                              // for this username will receive the message.
  "timestamp": 1,             // (long) Timestamp of creation.
  "timeToLive": 1,            // (long) Time to live. After that message will be
                              // deleted.
  "position": 1,              // (long) Message position in queue. Message are
                              // delivered in order.
}

3.59. DTO<K>

Abstract DTO Class.

Qualified name

com.iobeya.api.dto.abs.DTO

Direct descendants

InstrumentationDetailDTO, InstrumentationItemDTO, HistorizedDTO, AssignmentDTO, BoardSizeDTO, ChecklistItemDTO, CorsDTO, DeletedEntityDTO, DetailedLoadResultDTO, DomainScheduleDTO, ElementZoneDTO, EntityReferenceDTO, GeneralAnnouncementDTO, GroupDTO, GroupExternalDTO, HelpLinkDTO, IframeAllowedDomainDTO, InboxInfoDTO, IncomingBoardProposalDTO, InvitationDTO, OAuthClientDetailsDTO, RoomScheduleDTO, SchedulerHistoryDTO, ServiceResultDTO, ThirdPartyApplicationDTO, UserDTO, UserTokenDTO, VoteDTO, AuthUserTokensDTO, OauthUserRequestTokenDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.DTO",
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.60. DataFolderDTO

Created by akartmann on 19/10/2015.

Qualified name

com.iobeya.dto.DataFolderDTO

Direct ancestors

DataItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DataFolderDTO",
  "id": "string",             // (string) ID of the file. Can be the path, an uri,
                              // whatever can be use by the external source to find the
                              // original folder.
  "name": "string",           // (string) Name of the file.
  "externalDate": 86400000,   // (timestamp) External modification date.
  "source": {},               // (EntityReferenceDTO) Reference of the source.
  "parent": {},               // (EntityReferenceDTO) Parent of the item.
  "asset": {},                // (AssetDTO) DTO of the asset.
  "content": {},              // (JsonNode)
  "inError": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.61. DataImageDTO

Created by akartmann on 19/10/2015.

Qualified name

com.iobeya.dto.DataImageDTO

Direct ancestors

DataItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DataImageDTO",
  "id": "string",             // (string)
  "name": "string",           // (string)
  "externalDate": 86400000,   // (timestamp)
  "source": {},               // (EntityReferenceDTO)
  "parent": {},               // (EntityReferenceDTO)
  "asset": {},                // (AssetDTO)
  "content": {},              // (JsonNode)
  "inError": true,            // (bool)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.62. DataImageToolSetDTO

Qualified name

com.iobeya.dto.DataImageToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DataImageToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.63. DataItemDTO

Qualified name

com.iobeya.dto.DataItemDTO

Direct ancestors

HistorizedDTO

Direct descendants

DataFolderDTO, DataImageDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DataItemDTO",
  "id": "string",             // (string) ID of the file. Can be the path, an uri,
                              // whatever can be use by the external source to find the
                              // original folder.
  "name": "string",           // (string) Name of the file.
  "externalDate": 86400000,   // (timestamp) External modification date.
  "source": {},               // (EntityReferenceDTO) Reference of the source.
  "parent": {},               // (EntityReferenceDTO) Parent of the item.
  "asset": {},                // (AssetDTO) DTO of the asset.
  "content": {},              // (JsonNode)
  "inError": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.64. DataSourceDTO

Created by akartmann on 30/12/2015.

Qualified name

com.iobeya.api.dto.abs.DataSourceDTO

Direct ancestors

HistorizedDTO

Direct descendants

ExternalSourceDTO, LocalSourceDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.DataSourceDTO",
  "id": "string",             // (string) ID of the source.
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "credentials": "string",    // (string)
  "configuration": {},        // (JsonNode)
  "provider": "string",       // (string)
  "synchronizationDate": 86400000, // (timestamp)
  "autoUpdate": true,         // (bool)
  "notifyChange": true,       // (bool)
  "synchronizationRunning": true, // (bool)
  "globalError": true,        // (bool)
  "notificationDuration": 1,  // (Integer)
  "synchronizationFrequency": 1, // (Integer)
  "lastModificationDate": 86400000, // (timestamp)
  "maxNumberOfItems": 1,      // (int)
  "numberOfItems": 1,         // (int)
  "icon": {},                 // (AssetDTO) DTO of the icon.
  "error": "string",          // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.65. DeletedEntityDTO<K>

Qualified name

com.iobeya.dto.DeletedEntityDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DeletedEntityDTO",
  "id": {},                   // (K)
  "type": "string",           // (string)
  "creator": "string",        // (string) Creator.
  "modifier": "string",       // (string) Modifier.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.66. DetailedLoadResultDTO

Qualified name

com.iobeya.dto.DetailedLoadResultDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DetailedLoadResultDTO",
  "id": "string",             // (string)
  "type": "string",           // (string)
  "detailedLoadDate": 86400000, // (timestamp) load date.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.67. DockToolSetDTO

Dock tool set DTO.

Qualified name

com.iobeya.api.dto.abs.DockToolSetDTO

Direct ancestors

HistorizedDTO

Direct descendants

AssetLibraryToolSetDTO, ButtonToolSetDTO, CardToolSetDTO, ChartToolSetDTO, DataImageToolSetDTO, DrawingToolSetDTO, EdgeToolSetDTO, FreetextToolSetDTO, GaugeToolSetDTO, ImageToolSetDTO, LabelToolSetDTO, NoteToolSetDTO, RollToolSetDTO, StickerToolSetDTO, TeamToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.DockToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Usually a room
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.68. DockToolSetItemDTO

Dock tools set item DTO.

Qualified name

com.iobeya.api.dto.abs.DockToolSetItemDTO

Direct ancestors

HistorizedDTO

Direct descendants

AssetLibraryToolSetItemDTO, CardToolSetItemDTO, ChartToolSetItemDTO, EdgeToolSetItemDTO, EraseAllDrawingToolSetItemDTO, GaugeToolSetItemDTO, ImageToolSetItemDTO, NoteToolSetItemDTO, PencilToolSetItemDTO, RollToolSetItemDTO, RubberToolSetItemDTO, StickerToolSetItemDTO, AbstractTextToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.DockToolSetItemDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Usually a room
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.69. DomainChildDTO

Abstract DomainChildDTO Class.

Qualified name

com.iobeya.api.dto.abs.DomainChildDTO

Direct ancestors

HistorizedDTO

Direct descendants

FlexibleDomainChildDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.DomainChildDTO",
  "id": "string",             // (string)
  "domainId": "string",       // (string)
  "domainName": "string",     // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.70. DomainDTO

Qualified name

com.iobeya.dto.DomainDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DomainDTO",
  "id": "string",             // (string) ID of the domain.
  "name": "string",           // (string) Name of the domain.
  "description": "string",    // (string) Description of the domain.
  "maxRoom": 1,               // (int) Number of the maximum of room.
  "maxBoardPerRoom": 1,       // (int) Number of the maximum of board per room.
  "maxUserPerRoom": 1,        // (int) Number of the maximum of user per room.
  "maxAdminPerRoom": 1,       // (int) Number of the maximum of admin per room.
  "maxGroupPerRoom": 1,       // (int) Number of the maximum of group per room.
  "shareRooms": true,         // (bool) Allow to share the rooms inside the domain.
  "allowsRoomRename": true,   // (bool) Allow users to rename room in this domain.
  "allowsRoomCreation": true, // (bool) Allow users to create rooms in this domain.
  "allowsRoomArchive": true,  // (bool) Allow users to archive rooms in this domain.
  "adminEmail": "string",     // (string) email of the domain admin
  "defaultRoomPrivacyPublic": true, // (bool) Default value for the privacy of the
                              // Rooms of the domain (public or private).
  "isLocked": true,           // (bool) Is the domain archived (no reference in the
                              // database, only computed when  'closingDate <'  now).
  "closingDate": "string",    // (string)
  "roomModel": [{}],          // (List<RoomDTO>)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.71. DomainScheduleDTO

Qualified name

com.iobeya.dto.DomainScheduleDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DomainScheduleDTO",
  "id": 1,                    // (Long)
  "domainId": "string",       // (string)
  "scheduleDate": 86400000,   // (timestamp)
  "scheduleType": {},         // (DomainScheduleType)
  "scheduleState": {},        // (ScheduleState)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.72. DrawingToolSetDTO

Qualified name

com.iobeya.dto.DrawingToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.DrawingToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.73. EdgeBoardElementDTO

Edge Board Element DTO.

Qualified name

com.iobeya.api.dto.abs.EdgeBoardElementDTO

Direct ancestors

BoardElementDTO

Direct descendants

EdgeDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.EdgeBoardElementDTO",
  "source": {},               // (EntityReferenceDTO)
  "target": {},               // (EntityReferenceDTO)
  "color": 1,                 // (int)
  "controlPoints": [{}],      // (BoardPointDTO[])
  "offsetX": 1,               // (int)
  "offsetY": 1,               // (int)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.74. EdgeDTO

Qualified name

com.iobeya.dto.EdgeDTO

Direct ancestors

EdgeBoardElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.EdgeDTO",
  "color": 1,                 // (int)
  "type": 1,                  // (int)
  "thickness": 1,             // (int)
  "arrowSourceType": "string", // (string)
  "arrowTargetType": "string", // (string)
  "renderingPolicy": "string", // (string)
  "patterns": "string",       // (string)
  "routePolicy": "string",    // (string)
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "source": {},               // (EntityReferenceDTO)
  "target": {},               // (EntityReferenceDTO)
  "color": 1,                 // (int)
  "controlPoints": [{}],      // (BoardPointDTO[])
  "offsetX": 1,               // (int)
  "offsetY": 1,               // (int)
  "id": "string",             // (string)
  "isLocked": true,           // (bool)
  "isAnchored": true,         // (bool)
  "width": 1,                 // (int)
  "height": 1,                // (int)
  "x": 1,                     // (int)
  "y": 1,                     // (int)
  "zOrder": 1,                // (int)
  "name": "string",           // (string)
  "setName": "string",        // (string)
  "container": {},            // (EntityReferenceDTO)
  "dataItem": {},             // (EntityReferenceDTO)
  "dataItemDate": 86400000,   // (timestamp)
  "dataItemStatus": 'c',      // (char)
  "dataItemUrl": "string",    // (string)
  "dataItemName": "string",   // (string)
  "dataItemIcon": {},         // (EntityReferenceDTO)
  "displayTimestamp": true,   // (bool)
  "dataItemId": "string",     // (string)
  "dataItemSourceId": "string", // (string)
  "score": 1,                 // (int)
  "scoreRatio": 1,            // (int)
  "syncInfo": {},             // (EntityReferenceDTO)
  "collectionSize": 1,        // (int)
  "collectionDoneCount": 1,   // (int)
  "rotationAngle": 1,         // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.75. EdgeToolSetDTO

Qualified name

com.iobeya.dto.EdgeToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.EdgeToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.76. EdgeToolSetItemDTO

Qualified name

com.iobeya.dto.EdgeToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.EdgeToolSetItemDTO",
  "color": 1,                 // (int)
  "colorName": "string",      // (string)
  "type": 1,                  // (int)
  "thickness": 1,             // (int)
  "arrowSourceType": "string", // (string)
  "arrowTargetType": "string", // (string)
  "renderingPolicy": "string", // (string)
  "patterns": "string",       // (string)
  "useAutomaticBundling": true, // (bool)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.77. ElementContainerDTO

Element container Class.

Qualified name

com.iobeya.dto.ElementContainerDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ElementContainerDTO",
  "id": "string",             // (string)
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "width": 1,                 // (int) Board width, in pixels.
  "height": 1,                // (int) Board height, in pixels.
  "contentWidth": 1,          // (int)
  "contentHeight": 1,         // (int)
  "needScreenshot": true,     // (bool) Whether the screenshot need to be updated.
  "needPNGScreenshot": true,  // (bool)
  "backgroundColor": 1,       // (int) Background plain color.
  "room": {},                 // (EntityReferenceDTO) The room.
  "assetContainer": {},       // (EntityReferenceDTO) The asset container.
  "screenshot": {},           // (EntityReferenceDTO) Board screenshot.
  "pngScreenshot": {},        // (EntityReferenceDTO) Board PNG screenshot.
  "miniature": {},            // (EntityReferenceDTO) Board JPEG miniature.
  "background": {},           // (EntityReferenceDTO) Board background.
  "isLocked": true,           // (bool) Whether the container is locked or not.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.78. ElementSharingProposalDTO

Qualified name

com.iobeya.dto.ElementSharingProposalDTO

Direct ancestors

AbstractSyncElementReferenceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ElementSharingProposalDTO",
  "audienceUsernames": [{}],  // (List<String>)
  "audienceGroupIds": [{}],   // (List<Long>)
  "creatorLogin": "string",   // (string) Creator's login.
  "modifierLogin": "string",  // (string) Modifier's login.
  "id": "string",             // (string)
  "boardElement": {},         // (EntityReferenceDTO)
  "weakRef": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.79. ElementSharingRole

Qualified name

com.iobeya.service.ElementSharingService.ElementSharingRole

Example JSon object
{
  "@class" : "com.iobeya.service.ElementSharingService.ElementSharingRole",
  "name": "string",           // (string)
  "ordinal": 1,               // (int)
}

3.80. ElementSyncInfoDTO

Qualified name

com.iobeya.dto.ElementSyncInfoDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ElementSyncInfoDTO",
  "id": "string",             // (string)
  "instanceCount": 1,         // (int)
  "referenceCount": 1,        // (int)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.81. ElementZoneDTO

Qualified name

com.iobeya.dto.ElementZoneDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ElementZoneDTO",
  "label": "string",          // (string)
  "index": 1,                 // (int)
  "parentId": "string",       // (string)
  "type": "string",           // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.82. EntityReferenceDTO

Qualified name

com.iobeya.dto.EntityReferenceDTO

Direct ancestors

DTO

Direct descendants

SyncInfoScreenshotCandidate

Example JSon object
{
  "@class" : "com.iobeya.dto.EntityReferenceDTO",
  "id": "string",             // (string)
  "type": "string",           // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.83. EraseAllDrawingToolSetItemDTO

Qualified name

com.iobeya.dto.EraseAllDrawingToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.EraseAllDrawingToolSetItemDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.84. ExternalItemInfoDTO

Qualified name

com.iobeya.dto.ExternalItemInfoDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ExternalItemInfoDTO",
  "id": "string",             // (string) ID of the file. Can be the path, an uri,
                              // whatever can be use by the external source to find the
                              // original folder.
  "name": "string",           // (string) Name of the file.
  "parentId": "string",       // (string) Id of the parent for this file (must be a
                              // file's id).
  "sourceId": "string",       // (string) Id of the source for this file (must be a
                              // ExterlSourceDTO 's id).
  "itemUrl": "string",        // (string) Url to the item in the source (if available).
  "isRoot": true,             // (bool) True if file is a root folder of a source.
  "isDeleted": true,          // (bool) True if element is deleted.
  "mimeType": "string",       // (string)
  "imageWidth": 1,            // (int)
  "imageHeight": 1,           // (int)
  "itemType": "string",       // (string)
  "binaryContent": [1],       // (byte)
  "inError": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.85. ExternalSourceDTO

Qualified name

com.iobeya.dto.ExternalSourceDTO

Direct ancestors

DataSourceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ExternalSourceDTO",
  "id": "string",             // (string) ID of the source.
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "credentials": "string",    // (string)
  "configuration": {},        // (JsonNode)
  "provider": "string",       // (string)
  "synchronizationDate": 86400000, // (timestamp)
  "autoUpdate": true,         // (bool)
  "notifyChange": true,       // (bool)
  "synchronizationRunning": true, // (bool)
  "globalError": true,        // (bool)
  "notificationDuration": 1,  // (Integer)
  "synchronizationFrequency": 1, // (Integer)
  "lastModificationDate": 86400000, // (timestamp)
  "maxNumberOfItems": 1,      // (int)
  "numberOfItems": 1,         // (int)
  "icon": {},                 // (AssetDTO) DTO of the icon.
  "error": "string",          // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.86. FlexibleBoardChildDTO

Created by akartmann on 13/04/15.

Qualified name

com.iobeya.dto.FlexibleBoardChildDTO

Direct ancestors

BoardChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FlexibleBoardChildDTO",
  "props": {},                // (JsonNode)
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.87. FlexibleBoardElementChildDTO

Created by akartmann on 13/04/15.

Qualified name

com.iobeya.dto.FlexibleBoardElementChildDTO

Direct ancestors

BoardElementChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FlexibleBoardElementChildDTO",
  "props": {},                // (JsonNode)
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "element": {},              // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.88. FlexibleDomainChildDTO

Created by akartmann on 13/04/15.

Qualified name

com.iobeya.dto.FlexibleDomainChildDTO

Direct ancestors

DomainChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FlexibleDomainChildDTO",
  "props": {},                // (JsonNode)
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "domainId": "string",       // (string)
  "domainName": "string",     // (string)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.89. FlexiblePlatformChildDTO

Created by akartmann on 13/04/15.

Qualified name

com.iobeya.dto.FlexiblePlatformChildDTO

Direct ancestors

PlatformChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FlexiblePlatformChildDTO",
  "props": {},                // (JsonNode)
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.90. FlexibleRoomChildDTO

Created by akartmann on 13/04/15.

Qualified name

com.iobeya.dto.FlexibleRoomChildDTO

Direct ancestors

RoomChildDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FlexibleRoomChildDTO",
  "props": {},                // (JsonNode)
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "room": {},                 // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.91. FreetextToolSetDTO

Qualified name

com.iobeya.dto.FreetextToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FreetextToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.92. FreetextToolSetItemDTO

Qualified name

com.iobeya.dto.FreetextToolSetItemDTO

Direct ancestors

AbstractTextToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.FreetextToolSetItemDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int)
  "fontSize": "string",       // (string)
  "textAlign": "string",      // (string)
  "textVerticalAlign": "string", // (string)
  "textAutofit": true,        // (bool)
  "fitToText": true,          // (bool)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.93. GaugeToolSetDTO

Qualified name

com.iobeya.dto.GaugeToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.GaugeToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.94. GaugeToolSetItemDTO

Qualified name

com.iobeya.dto.GaugeToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.GaugeToolSetItemDTO",
  "kind": "string",           // (string)
  "themeIndex": 1,            // (int)
  "color": 1,                 // (int)
  "thresholdsNumber": 1,      // (int)
  "iconClass": "string",      // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.95. GeneralAnnouncementDTO

Qualified name

com.iobeya.dto.GeneralAnnouncementDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.GeneralAnnouncementDTO",
  "diffused": true,           // (bool)
  "id": {},                   // (UUID)
  "title": "string",          // (string)
  "priority": 1,              // (Integer)
  "content": "string",        // (string)
  "startDate": "string",      // (string)
  "endDate": "string",        // (string)
  "linkTitle": "string",      // (string)
  "link": "string",           // (string)
  "creationDate": "string",   // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.96. GroupDTO

Qualified name

com.iobeya.dto.GroupDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.GroupDTO",
  "id": 1,                    // (Long)
  "groupName": "string",      // (string)
  "isHost": true,             // (bool)
  "isAdded": true,            // (bool)
  "authorities": {},          // (Collection<GroupAuthority>)
  "totalUsers": 1,            // (int)
  "nbrUsersOutRoom": 1,       // (int)
  "externalSynchroStatus": "string", // (string)
  "users": [{}],              // (List<UserDTO>)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.97. GroupExternalDTO

Qualified name

com.iobeya.dto.GroupExternalDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.GroupExternalDTO",
  "id": 1,                    // (Long)
  "externalSource": "string", // (string)
  "externalKey": "string",    // (string)
  "externalValue": "string",  // (string)
  "externalSynchroStatus": "string", // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.98. Health

Qualified name

com.iobeya.entity.Health

Example JSon object
{
  "@class" : "com.iobeya.entity.Health",
}

3.99. HelpLinkDTO

Qualified name

com.iobeya.dto.HelpLinkDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.HelpLinkDTO",
  "id": 1,                    // (long)
  "label": "string",          // (string)
  "urlPath": "string",        // (string)
  "domainId": "string",       // (string)
  "appLanguage": "string",    // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.100. HistorizedDTO<K>

Abstract HistorizedDTO Class.

Qualified name

com.iobeya.api.dto.abs.HistorizedDTO

Direct ancestors

DTO

Direct descendants

AbstractSyncElementReferenceDTO, BoardChildDTO, BoardElementChildDTO, BoardElementDTO, DataSourceDTO, DockToolSetDTO, DockToolSetItemDTO, DomainChildDTO, PlatformChildDTO, RoomChildDTO, ToolConfigurationBaseDTO, AnimationReportDTO, AnnouncementDTO, AssetContainerDTO, AssetDTO, AuthenticationMechanismDTO, AuthenticationPolicyBaseDTO, BoardDTO, BoardDockDTO, BoardSharingProposalDTO, CatalogDTO, DataItemDTO, DomainDTO, ElementContainerDTO, ElementSyncInfoDTO, ExternalItemInfoDTO, RoomDTO, SharedElementDTO, WallCategoryDTO, AuthApplicationInstanceDTO, AuthApplicationTypeDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.HistorizedDTO",
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.101. IMessagingClient

Messaging client.

Qualified name

com.iobeya.api.dto.abs.IMessagingClient

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.IMessagingClient",
}

3.102. IframeAllowedDomainDTO

Qualified name

com.iobeya.dto.IframeAllowedDomainDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.IframeAllowedDomainDTO",
  "id": 1,                    // (Long)
  "name": "string",           // (string)
  "url": "string",            // (string)
  "enabled": true,            // (bool)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.103. ImageToolSetDTO

Qualified name

com.iobeya.dto.ImageToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ImageToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.104. ImageToolSetItemDTO

Qualified name

com.iobeya.dto.ImageToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ImageToolSetItemDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.105. ImportReportDTO

ImportReportDTO class.

Qualified name

com.iobeya.dto.ImportReportDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ImportReportDTO",
  "importedElements": [{}],   // (List<DTO<?>>)
  "warnings": [{}],           // (List<CsvWarnDTO>)
}

3.106. InboxInfoDTO

Qualified name

com.iobeya.dto.InboxInfoDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.InboxInfoDTO",
  "username": "string",       // (string)
  "boxEmpty": true,           // (bool)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.107. IncomingBoardProposalDTO

Qualified name

com.iobeya.dto.IncomingBoardProposalDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.IncomingBoardProposalDTO",
  "creator": "string",        // (string) Creator.
  "creatorLogin": "string",   // (string) CreatorLogin.
  "modifier": "string",       // (string) Modifier.
  "modifierLogin": "string",  // (string) ModifierLogin.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string)
  "id": "string",             // (string)
  "boardName": "string",      // (string)
  "boardId": "string",        // (string)
  "width": 1,                 // (int) Board width, in pixels.
  "height": 1,                // (int) Board height, in pixels.
  "size": {},                 // (EntityReferenceDTO)
  "roomName": "string",       // (string)
  "roomId": "string",         // (string)
  "icon": {},                 // (EntityReferenceDTO)
  "background": {},           // (EntityReferenceDTO)
  "shareStatus": 'c',         // (char)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.108. InstrumentationDetailDTO

Qualified name

com.iobeya.api.dto.InstrumentationDetailDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.InstrumentationDetailDTO",
  "id": 1,                    // (Long)
  "label": "string",          // (string)
  "units": "string",          // (string)
  "primary": true,            // (bool)
  "timeStamp": 86400000,      // (timestamp)
  "lastValue": 1.5,           // (double)
  "details": "string",        // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.109. InstrumentationItemDTO

Qualified name

com.iobeya.api.dto.InstrumentationItemDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.InstrumentationItemDTO",
  "id": 1,                    // (Long)
  "label": "string",          // (string)
  "startDate": 86400000,      // (timestamp)
  "endDate": 86400000,        // (timestamp)
  "units": "string",          // (string)
  "hits": 1.5,                // (double)
  "avg": 1.5,                 // (double)
  "total": 1.5,               // (double)
  "lastValue": 1.5,           // (double)
  "min": 1.5,                 // (double)
  "max": 1.5,                 // (double)
  "enabled": true,            // (bool)
  "primary": true,            // (bool)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.110. InvitationDTO

DTO defining Invitation.

Qualified name

com.iobeya.dto.InvitationDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.InvitationDTO",
  "id": "string",             // (string)
  "email": "string",          // (string) Email address used to send invitation.
  "token": "string",          // (string) Token used for private invitation.
  "expirationDate": 86400000, // (timestamp) Invitation expiration date.
  "used": true,               // (bool) Invitation used flag.
  "canEdit": true,            // (bool) Used to mark edit rights for an invitation.
  "isPublic": true,           // (bool) Used to mark if invitation is public.
  "roomId": "string",         // (string) Related room id.
  "boardId": "string",        // (string) Related board id.
  "domainId": "string",       // (string) Related domain id.
  "roomAdminUsername": "string", // (string) Room administrator username.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.111. JSonException

Qualified name

com.iobeya.web.JSonException

Example JSon object
{
  "@class" : "com.iobeya.web.JSonException",
  "statusCode": 1,            // (int)
  "statusMessage": "string",  // (string)
  "id": "string",             // (string)
  "detailMessage": "string",  // (string)
  "cause": {},                // (Throwable)
  "stackTrace": [{}],         // (StackTraceElement[])
  "suppressedExceptions": [{}], // (List<Throwable>)
}

3.112. JSonResult

The class JSonResult is used to return the outcome of an operation with a discrete result combined to detailed messages. The field result can have 4 values: "success", "error", "warning" or "info". The field messages is an array of messages in english that describe the operation’s result in more details.

Qualified name

com.iobeya.web.JSonResult

Example JSon object
{
  "@class" : "com.iobeya.web.JSonResult",
  "result": "string",         // (string)
  "messages": [{}],           // (List<String>)
}

3.113. LabelToolSetDTO

Qualified name

com.iobeya.dto.LabelToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.LabelToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.114. LabelToolSetItemDTO

Qualified name

com.iobeya.dto.LabelToolSetItemDTO

Direct ancestors

AbstractTextToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.LabelToolSetItemDTO",
  "backgroundColor": 1,       // (int)
  "fontColor": 1,             // (int)
  "fontSize": "string",       // (string)
  "textAlign": "string",      // (string)
  "textVerticalAlign": "string", // (string)
  "textAutofit": true,        // (bool)
  "fitToText": true,          // (bool)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.115. LicenseInfoDTO

Qualified name

com.iobeya.dto.LicenseInfoDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.LicenseInfoDTO",
  "licenseType": 1,           // (int)
  "licenseTotalDuration": 1,  // (int)
  "licenseRemainingDuration": 1, // (int)
  "reminderNbOfDays": 1,      // (int)
}

3.116. LocalSourceDTO

Qualified name

com.iobeya.dto.LocalSourceDTO

Direct ancestors

DataSourceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.LocalSourceDTO",
  "id": "string",             // (string) ID of the source.
  "name": "string",           // (string) Name of the source.
  "description": "string",    // (string) Description of the source.
  "credentials": "string",    // (string)
  "configuration": {},        // (JsonNode)
  "provider": "string",       // (string)
  "synchronizationDate": 86400000, // (timestamp)
  "autoUpdate": true,         // (bool)
  "notifyChange": true,       // (bool)
  "synchronizationRunning": true, // (bool)
  "globalError": true,        // (bool)
  "notificationDuration": 1,  // (Integer)
  "synchronizationFrequency": 1, // (Integer)
  "lastModificationDate": 86400000, // (timestamp)
  "maxNumberOfItems": 1,      // (int)
  "numberOfItems": 1,         // (int)
  "icon": {},                 // (AssetDTO) DTO of the icon.
  "error": "string",          // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.117. MeetingConfigurationDTO

DTO defining meeting’s configuration.

Qualified name

com.iobeya.dto.MeetingConfigurationDTO

Direct descendants

VoteConfigurationDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.MeetingConfigurationDTO",
  "duration": 1,              // (long) Duration of the meeting.
  "boardId": "string",        // (string) Brainstorming board id.
  "startTime": 86400000,      // (timestamp) Brainstorming mode starting time.
}

3.118. NoteToolSetDTO

Qualified name

com.iobeya.dto.NoteToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.NoteToolSetDTO",
  "entityType": "string",     // (string)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.119. NoteToolSetItemDTO

Qualified name

com.iobeya.dto.NoteToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.NoteToolSetItemDTO",
  "color": 1,                 // (int)
  "containsSmallSize": true,  // (bool)
  "containsMediumSize": true, // (bool)
  "containsLargeSize": true,  // (bool)
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "asset": {},                // (EntityReferenceDTO)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.120. OAuthClientDetailsDTO

Qualified name

com.iobeya.dto.OAuthClientDetailsDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.OAuthClientDetailsDTO",
  "clientId": "string",       // (string)
  "clientSecret": "string",   // (string)
  "scope": "string",          // (string)
  "grantTypes": {},           // (Set<String>)
  "redirectUri": "string",    // (string)
  "accessTokenValiditySeconds": 1, // (Integer)
  "refreshTokenValiditySeconds": 1, // (Integer)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.121. OauthApplicationInstanceDTO

Qualified name

com.iobeya.dto.oauth.client.OauthApplicationInstanceDTO

Direct ancestors

AuthApplicationInstanceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.oauth.client.OauthApplicationInstanceDTO",
  "requestUrl": "string",     // (string)
  "authorizeUrl": "string",   // (string)
  "tokenUrl": "string",       // (string)
  "clientId": "string",       // (string)
  "clientSecret": "string",   // (string)
  "oauthVersion": "string",   // (string)
  "defaultAccessTokenValidity": 1, // (Long)
  "redirectUrl": "string",    // (string)
  "allowApiCallDelegation": true, // (bool)
  "resource": "string",       // (string)
  "privateKey": "string",     // (string)
  "codeChallengeMethod": "string", // (string)
  "codeVerifier": "string",   // (string)
  "id": "string",             // (string)
  "applicationTypeId": "string", // (string)
  "name": "string",           // (string)
  "description": "string",    // (string)
  "baseUrl": "string",        // (string)
  "domainId": "string",       // (string) Domain Id.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.122. OauthTokenResponseDTO

Qualified name

com.iobeya.dto.oauth.client.OauthTokenResponseDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.oauth.client.OauthTokenResponseDTO",
  "accessTokenFound": true,   // (bool) Return true if there is already a valid access
                              // token or false il you must generate one.
  "authorizationUrl": "string", // (string) Oauth authorization Url used to start oauth
                              // dance.
  "message": "string",        // (string) Processing access token request message. Give
                              // details on token status.
}

3.123. OauthUserRequestTokenDTO

Qualified name

com.iobeya.dto.oauth.client.OauthUserRequestTokenDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.oauth.client.OauthUserRequestTokenDTO",
  "id": "string",             // (string)
  "username": "string",       // (string)
  "applicationInstanceId": "string", // (string)
  "requestToken": "string",   // (string)
  "requestTokenSecret": "string", // (string)
  "scopes": "string",         // (string)
  "authorizeUrl": "string",   // (string)
  "creationDate": 86400000,   // (timestamp)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.124. OauthUserTokensDTO

Qualified name

com.iobeya.dto.oauth.client.OauthUserTokensDTO

Direct ancestors

AuthUserTokensDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.oauth.client.OauthUserTokensDTO",
  "refreshToken": "string",   // (string)
  "verificationCode": "string", // (string)
  "accessTokenValidity": 1,   // (Long)
  "accessTokenExpirationDate": 86400000, // (timestamp)
  "refreshTokenValidity": 1,  // (Long)
  "refreshTokenExpirationDate": 86400000, // (timestamp)
  "scopes": "string",         // (string)
  "id": "string",             // (string)
  "name": "string",           // (string)
  "username": "string",       // (string)
  "applicationInstanceId": "string", // (string)
  "applicationInstanceName": "string", // (string)
  "accessToken": "string",    // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.125. PagedResultDTO

Qualified name

com.iobeya.dto.PagedResultDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.PagedResultDTO",
  "pageNumber": 1,            // (int)
  "nbPages": 1,               // (int)
  "resultCount": 1,           // (int)
  "results": [{}],            // (List<?>)
}

3.126. PasswordPolicySettingDTO

DTO defining Password policy settings.

Qualified name

com.iobeya.dto.PasswordPolicySettingDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.PasswordPolicySettingDTO",
  "passwordPolicyStatus": true, // (bool) Password policy status.
  "passwordPolicyLevel": "string", // (string) Password policy level.
  "passwordMinLength": 1,     // (long) Password minimum Length constraint.
  "passwordOneNumber": true,  // (bool) Password one number constraint.
  "passwordCase": true,       // (bool) Password case constraint.
  "passwordOneSpecialChar": true, // (bool) Password one special character constraint.
}

3.127. PasswordValidationDTO

DTO defining Password constraints validation.

Qualified name

com.iobeya.dto.PasswordValidationDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.PasswordValidationDTO",
  "passwordMinLength": true,  // (bool) Password minimum Length Validation.
  "passwordOneNumber": true,  // (bool) Password one number Validation.
  "passwordCase": true,       // (bool) Password case Validation.
  "passwordOneSpecialChar": true, // (bool) Password one special character Validation.
}

3.128. PatApplicationInstanceDTO

Qualified name

com.iobeya.dto.pat.client.PatApplicationInstanceDTO

Direct ancestors

AuthApplicationInstanceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.pat.client.PatApplicationInstanceDTO",
  "id": "string",             // (string)
  "applicationTypeId": "string", // (string)
  "name": "string",           // (string)
  "description": "string",    // (string)
  "baseUrl": "string",        // (string)
  "domainId": "string",       // (string) Domain Id.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.129. PatUserTokensDTO

Qualified name

com.iobeya.dto.pat.client.PatUserTokensDTO

Direct ancestors

AuthUserTokensDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.pat.client.PatUserTokensDTO",
  "id": "string",             // (string)
  "name": "string",           // (string)
  "username": "string",       // (string)
  "applicationInstanceId": "string", // (string)
  "applicationInstanceName": "string", // (string)
  "accessToken": "string",    // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.130. PencilToolSetItemDTO

Qualified name

com.iobeya.dto.PencilToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.PencilToolSetItemDTO",
  "icon": {},                 // (EntityReferenceDTO)
  "pencilType": "string",     // (string)
  "color": 1,                 // (int)
  "alpha": 1.5,               // (double)
  "colorName": "string",      // (string)
  "size": 1,                  // (int)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.131. PlanningAreaDTO

DTO defining a planning area.

Qualified name

com.iobeya.dto.PlanningAreaDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.PlanningAreaDTO",
  "kind": "string",           // (string)
  "rowId": "string",          // (string)
  "rowY": 1,                  // (Integer)
  "rowIndex": 1,              // (Integer)
  "rowLabel": "string",       // (string)
  "zone": "string",           // (string)
}

3.132. PlatformChildDTO

Abstract PlatformChildDTO Class.

Qualified name

com.iobeya.api.dto.abs.PlatformChildDTO

Direct ancestors

HistorizedDTO

Direct descendants

FlexiblePlatformChildDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.PlatformChildDTO",
  "id": "string",             // (string)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.133. RemoveFromCollectionParamDTO

Qualified name

com.iobeya.dto.RemoveFromCollectionParamDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RemoveFromCollectionParamDTO",
  "masterId": "string",       // (string) The id of the parent element master.
  "elementId": "string",      // (string) The id of the parent element.
  "childrenMastersIds": ["string"], // (string[]) List of children items masters ids.
  "modifierClientId": "string", // (string)
}

3.134. ReverseProxyRequestDTO

Qualified name

com.iobeya.dto.oauth.client.ReverseProxyRequestDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.oauth.client.ReverseProxyRequestDTO",
}

3.135. RollToolSetDTO

Qualified name

com.iobeya.dto.RollToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RollToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.136. RollToolSetItemDTO

Qualified name

com.iobeya.dto.RollToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RollToolSetItemDTO",
  "color": 1,                 // (int)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.137. RoomChildDTO

Abstract RoomChildDTO Class.

Qualified name

com.iobeya.api.dto.abs.RoomChildDTO

Direct ancestors

HistorizedDTO

Direct descendants

FlexibleRoomChildDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.RoomChildDTO",
  "id": "string",             // (string)
  "room": {},                 // (EntityReferenceDTO) The room of the child. Must be a
                              // Room.
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.138. RoomDTO

Qualified name

com.iobeya.dto.RoomDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomDTO",
  "id": "string",             // (string)
  "isModel": true,            // (bool) Is it a model ?.
  "name": "string",           // (string) Name of the room.
  "description": "string",    // (string) Description of the room.
  "domainId": "string",       // (string) Domain Id to create.update Room
  "domainName": "string",     // (string) Domain name to know domain if load Room.
  "isUltraSecured": true,     // (bool) Is the room ultra-secured.
  "isActive": true,           // (bool) Is room active or not. Should be false before
                              // completing the entire creation process.
  "isPublicRoom": true,       // (bool) The room is "public" or "private".
  "isLocked": true,           // (bool) Locks the room.
  "meetingState": "string",   // (string) Room's animation state.
  "maximumBoards": 1,         // (int) Room's number of maximum boards.
  "maximumUsers": 1,          // (int) Room's number of maximum users.
  "category": "string",       // (string) Room's category.
  "permissionMask": 1,        // (int) Permission mask.
  "closingDate": 86400000,    // (timestamp) Closing/Archiving date for room.
  "daysLeftBeforeClosing": 1, // (int) The number of days left before closing the room.
  "lastConnection": 86400000, // (timestamp) Last connection on this room.
  "wallHeight": 1,            // (int)
  "icon": {},                 // (EntityReferenceDTO) Room icon.
  "detailedLoadDate": 86400000, // (timestamp)
  "administrator": "string",  // (string)
  "catalog": {},              // (EntityReferenceDTO)
  "assetContainer": {},       // (EntityReferenceDTO)
  "roomType": "string",       // (string)
  "props": {},                // (JsonNode)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.139. RoomGlobalParamsDTO

RoomGlobalParamsDTO class.

Qualified name

com.iobeya.dto.RoomGlobalParamsDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomGlobalParamsDTO",
  "roomId": "string",         // (string) Room identifier.
  "nbUsers": 1,               // (int)
  "nbAdmins": 1,              // (int)
  "nbBoards": 1,              // (int)
  "maxUsers": 1,              // (int)
  "maxAdmins": 1,             // (int)
  "maxBoards": 1,             // (int)
  "nbWritablePermissionUsers": 1, // (int)
  "icon": {},                 // (EntityReferenceDTO) Room icon.
  "creationDate": 86400000,   // (timestamp)
  "closingDate": 86400000,    // (timestamp)
}

3.140. RoomPermissionInfoDTO

Qualified name

com.iobeya.dto.RoomPermissionInfoDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomPermissionInfoDTO",
  "maxUsers": 1,              // (int)
  "maxAdmins": 1,             // (int)
  "users": [{}],              // (List<UserRoomDTO>)
  "groups": [{}],             // (List<GroupRoomDTO>)
}

3.141. RoomScheduleDTO

Qualified name

com.iobeya.dto.RoomScheduleDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomScheduleDTO",
  "id": 1,                    // (Long)
  "room": {},                 // (EntityReferenceDTO)
  "scheduleDate": 86400000,   // (timestamp)
  "scheduleType": {},         // (RoomScheduleType)
  "scheduleState": {},        // (ScheduleState)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.142. RoomSharedElementDTO

Qualified name

com.iobeya.dto.RoomSharedElementDTO

Direct ancestors

SharedElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomSharedElementDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "elementContainer": {},     // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "contentWidth": 1,          // (int)
  "contentHeight": 1,         // (int)
  "icon": {},                 // (EntityReferenceDTO) icon.
  "kind": "string",           // (string)
  "ids": ["string"],          // (string[])
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.143. RoomStatisticsDTO

Qualified name

com.iobeya.dto.RoomStatisticsDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RoomStatisticsDTO",
  "roomId": "string",         // (string)
  "wallLength": 1.5,          // (Double)
  "wallArea": 1.5,            // (Double)
  "drawingLength": 1.5,       // (Double)
  "notesCount": 1,            // (Long)
  "cardsCount": 1,            // (Long)
  "rollsCount": 1,            // (Long)
  "stickersCount": 1,         // (Long)
  "imagesCount": 1,           // (Long)
}

3.144. RubberToolSetItemDTO

Qualified name

com.iobeya.dto.RubberToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.RubberToolSetItemDTO",
  "icon": {},                 // (EntityReferenceDTO)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.145. SchedulerHistoryDTO

Qualified name

com.iobeya.dto.SchedulerHistoryDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.SchedulerHistoryDTO",
  "id": 1,                    // (Long)
  "hostIp": "string",         // (string)
  "hostName": "string",       // (string)
  "schedulerName": "string",  // (string)
  "eventType": "string",      // (string)
  "eventName": "string",      // (string)
  "eventTime": 86400000,      // (timestamp)
  "info1": "string",          // (string)
  "info2": "string",          // (string)
  "info3": "string",          // (string)
  "info4": "string",          // (string)
  "info5": "string",          // (string)
  "jobResult": "string",      // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.146. ServiceResultDTO<K>

Qualified name

com.iobeya.dto.ServiceResultDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ServiceResultDTO",
  "id": {},                   // (K)
  "type": "string",           // (string)
  "creator": "string",        // (string) Creator.
  "modifier": "string",       // (string) Modifier.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.147. SharedElementDTO

Qualified name

com.iobeya.dto.SharedElementDTO

Direct ancestors

HistorizedDTO

Direct descendants

BoardSharedElementDTO, RoomSharedElementDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.SharedElementDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "elementContainer": {},     // (EntityReferenceDTO) The context of this container.
                              // Should be a room
  "contentWidth": 1,          // (int)
  "contentHeight": 1,         // (int)
  "icon": {},                 // (EntityReferenceDTO) icon.
  "kind": "string",           // (string)
  "ids": ["string"],          // (string[])
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.148. StickerToolSetDTO

Qualified name

com.iobeya.dto.StickerToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.StickerToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.149. StickerToolSetItemDTO

Qualified name

com.iobeya.dto.StickerToolSetItemDTO

Direct ancestors

DockToolSetItemDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.StickerToolSetItemDTO",
  "color": 1,                 // (int)
  "isColoredSticker": true,   // (bool)
  "asset": {},                // (EntityReferenceDTO)
  "containsSmallSize": true,  // (bool)
  "containsMediumSize": true, // (bool)
  "containsLargeSize": true,  // (bool)
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "label": "string",          // (string)
  "sortOrder": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.150. SyncElementReferenceDTO

Qualified name

com.iobeya.dto.SyncElementReferenceDTO

Direct ancestors

AbstractSyncElementReferenceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.SyncElementReferenceDTO",
  "weakRef": true,            // (bool)
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "id": "string",             // (string)
  "boardElement": {},         // (EntityReferenceDTO)
  "weakRef": true,            // (bool)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.151. SyncInfoScreenshotCandidate

Qualified name

com.iobeya.dto.SyncInfoScreenshotCandidate

Direct ancestors

EntityReferenceDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.SyncInfoScreenshotCandidate",
  "instanceCount": 1,         // (int)
  "referenceCount": 1,        // (int)
  "id": "string",             // (string)
  "type": "string",           // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.152. TeamToolSetDTO

Qualified name

com.iobeya.dto.TeamToolSetDTO

Direct ancestors

DockToolSetDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.TeamToolSetDTO",
  "id": "string",             // (string)
  "container": {},            // (EntityReferenceDTO)
  "icon": {},                 // (EntityReferenceDTO)
  "iconClass": "string",      // (string)
  "label": "string",          // (string)
  "description": "string",    // (string)
  "isDefault": true,          // (bool)
  "nbrBoards": 1,             // (int)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.153. ThirdPartyApplicationDTO

Qualified name

com.iobeya.dto.ThirdPartyApplicationDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ThirdPartyApplicationDTO",
  "applicationId": "string",  // (string)
  "applicationUrl": "string", // (string)
  "applicationName": "string", // (string)
  "applicationType": "string", // (string)
  "enabled": true,            // (bool)
  "deletable": true,          // (bool)
  "clientDetails": {},        // (OAuthClientDetailsDTO)
  "authorizationCodeGrant": "string", // (string)
  "refreshTokenGrant": "string", // (string)
  "implicitGrant": "string",  // (string)
  "hasTokens": true,          // (bool)
  "oauthGrantTypeSelectedCount": 1, // (Integer)
  "accessTokenValidityLabel": "string", // (string)
  "refreshTokenValidityLabel": "string", // (string)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.154. ToolConfigurationBaseDTO

Abstract ToolConfigurationBaseDTO Class.

Qualified name

com.iobeya.api.dto.abs.ToolConfigurationBaseDTO

Direct ancestors

HistorizedDTO

Direct descendants

ToolConfigurationDTO

Example JSon object
{
  "@class" : "com.iobeya.api.dto.abs.ToolConfigurationBaseDTO",
  "id": "string",             // (string)
  "kind": "string",           // (string)
  "isActive": true,           // (bool)
  "container": {},            // (EntityReferenceDTO) The container of the element.
                              // Board or Room
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.155. ToolConfigurationDTO

Qualified name

com.iobeya.dto.ToolConfigurationDTO

Direct ancestors

ToolConfigurationBaseDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ToolConfigurationDTO",
  "entityType": "string",     // (string)
  "props": {},                // (JsonNode)
  "id": "string",             // (string)
  "kind": "string",           // (string)
  "isActive": true,           // (bool)
  "container": {},            // (EntityReferenceDTO)
  "creator": "string",        // (string)
  "modifier": "string",       // (string)
  "creationDate": 86400000,   // (timestamp)
  "modificationDate": 86400000, // (timestamp)
  "modifierClientId": "string", // (string)
  "isReadOnly": true,         // (bool)
  "relevance": 1.5,           // (Float)
}

3.156. UserDTO

Qualified name

com.iobeya.dto.UserDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.UserDTO",
  "userId": {},               // (UserId)
  "username": "string",       // (string)
  "login": {},                // (UserLogin)
  "password": "string",       // (string)
  "firstName": "string",      // (string)
  "lastName": "string",       // (string)
  "email": "string",          // (string)
  "service": "string",        // (string)
  "site": "string",           // (string)
  "language": "string",       // (string)
  "country": "string",        // (string)
  "enabled": true,            // (bool)
  "groups": {},               // (Set<GroupDTO>)
  "isAdded": true,            // (bool)
  "connected": true,          // (bool)
  "isExternal": true,         // (bool)
  "lastConnection": 86400000, // (timestamp)
  "pwdToChange": true,        // (bool)
  "color": 1,                 // (Integer)
  "avatar": {},               // (AssetDTO)
  "hasCustomAvatar": true,    // (bool)
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.157. UserPasswordsDTO

DTO defining User Passwords.

Qualified name

com.iobeya.dto.UserPasswordsDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.UserPasswordsDTO",
  "username": "string",       // (string) Username of the related user.
  "oldPwd": "string",         // (string) User old password.
  "newPwd": "string",         // (string) User new password.
}

3.158. UserTokenDTO

DTO defining User Token.

Qualified name

com.iobeya.dto.UserTokenDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.UserTokenDTO",
  "id": "string",             // (string) User Token id.
  "token": "string",          // (string) Value of token.
  "username": "string",       // (string) Username of the related user.
  "password": "string",       // (string) Password to update.
  "language": "string",       // (string) User's language.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.159. ViewportDTO

DTO defining View port for guidance.

Qualified name

com.iobeya.dto.ViewportDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.ViewportDTO",
  "location": "string",       // (string) Location in the format
                              // /roomId/boardId/modalName.
  "boardViewportX": 1,        // (long) View port X position.
  "boardViewportY": 1,        // (long) View port Y position.
  "boardViewportWidth": 1,    // (long) View port width.
  "boardViewportHeight": 1,   // (long) View port height.
  "roomViewportScaleX": 1.5,  // (double) View port scale for room (X position).
  "roomViewportScaleY": 1.5,  // (double) View port scale for room (Y position).
  "roomViewportPositionRatio": 1.5, // (double) View port room position ratio.
  "scrollPosition": 1.5,      // (double)
  "currentElementId": "string", // (string)
  "exposeClass": "string",    // (string)
  "exposedElements": "string", // (string)
  "editedElement": "string",  // (string)
  "editorOptionsShown": true, // (bool)
}

3.160. VoteConfigurationDTO

DTO defining Vote’s configuration.

Qualified name

com.iobeya.dto.VoteConfigurationDTO

Direct ancestors

MeetingConfigurationDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.VoteConfigurationDTO",
  "id": "string",             // (string) Id of vote configuration.
  "maxScore": 1,              // (int) the Maximum number of vote per element for each
                              // user.
  "elementIds": [{}],         // (List<String>) list of the board elements Ids to be
                              // voted.
  "rootElementIds": [{}],     // (List<String>) list of board root elements Ids
                              // handling the vote.
  "roomId": "string",         // (string) room Id in which the vote is launched.
  "duration": 1,              // (long) Duration of the meeting.
  "boardId": "string",        // (string) Brainstorming board id.
  "startTime": 86400000,      // (timestamp) Brainstorming mode starting time.
}

3.161. VoteDTO

DTO defining Vote.

Qualified name

com.iobeya.dto.VoteDTO

Direct ancestors

DTO

Example JSon object
{
  "@class" : "com.iobeya.dto.VoteDTO",
  "username": "string",       // (string) Username of the user that voted.
  "elementId": "string",      // (string) Board Element Id voted.
  "score": 1,                 // (int) Vote score per element per user.
  "voteConfigurationId": "string", // (string) Related Vote Configuration id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}

3.162. VoteSessionDTO

DTO defining Vote Session.

Qualified name

com.iobeya.dto.VoteSessionDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.VoteSessionDTO",
  "votes": [{}],              // (List<VoteDTO>) Vote elements list.
  "voteConfiguration": {},    // (VoteConfigurationDTO) Related Vote Configuration.
}

3.163. WallCategoryDTO

Qualified name

com.iobeya.dto.WallCategoryDTO

Direct ancestors

HistorizedDTO

Example JSon object
{
  "@class" : "com.iobeya.dto.WallCategoryDTO",
  "id": "string",             // (string)
  "name": "string",           // (string) Name of the board.
  "room": {},                 // (EntityReferenceDTO) Container room.
  "posX": 1,                  // (int)
  "color": 1,                 // (int)
  "size": {},                 // (EntityReferenceDTO)
  "creator": "string",        // (string) Creator's username.
  "modifier": "string",       // (string) Modifier's username.
  "creationDate": 86400000,   // (timestamp) Creation date.
  "modificationDate": 86400000, // (timestamp) Last modification date.
  "modifierClientId": "string", // (string) Modifier's client id.
  "isReadOnly": true,         // (bool) True if the DTO is read only.
  "relevance": 1.5,           // (Float)
}