Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
Items
Functions for managing groups of items: documents, folders, workspaces
Function Summary
Name Path Version Description

getAllFavoritesV30

/items/allFavorites

3.0

getFavoritesV30

/items/favorites

3.0

getRecentSharedWithMeV30

/items/recent/sharedWithMe

3.0

getSharedWithMeV30

/items/sharedWithMe

3.0

markItemsFavoriteV30

/items/markFavorite

3.0

Marks a specified list of items (folders, workspaces/rooms, documents) as starred or unstarred (favorite).

Function Details

getAllFavoritesV30

Gets a list of all starred (favorite) items workspaces, documents or folders for the user

Version: 3.0
Synopsis: POST
Path: /items/allFavorites
Request Body: ListAllFavoriteItems
Response Headers: N/A
Response Body: PagingItemListJson of type Document or Folder

Request format:

POST /items/allFavorites

Authorization: Bearer <ssid>
Content-type: application/json

{
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
itemOrder: ApiFavoriteItemOrder,
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Json )
}

getFavoritesV30

Gets a list of starred (favorite) items workspaces, documents or folders for the user under the specified location

Version: 3.0
Synopsis: POST
Path: /items/favorites
Request Body: ListFavoriteItems
Response Headers: N/A
Response Body: PagingItemListJson of type Document or Folder

Request format:

POST /items/favorites

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuids: Set(String),
folderGuid: String,
filter: ApiDocumentFilter,
pagination:
{
pageSize: Integer,
pageNumber: Integer
},
itemOrder: ApiFavoriteItemOrder,
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Json )
}

getRecentSharedWithMeV30

Version: 3.0
Synopsis: POST
Path: /items/recent/sharedWithMe
Request Body: RecentSharedWithMe
Response Headers: N/A
Response Body: ItemListJson of type SharedWithMeResponse

Request format:

POST /items/recent/sharedWithMe

Authorization: Bearer <ssid>
Content-type: application/json

{
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(SharedWithMeResponse )
}

getSharedWithMeV30

Version: 3.0
Synopsis: POST
Path: /items/sharedWithMe
Request Body: SharedWithMe
Response Headers: N/A
Response Body: PagingItemListJson of type SharedWithMeResponse

Request format:

POST /items/sharedWithMe

Authorization: Bearer <ssid>
Content-type: application/json

{
paginationJson:
{
pageSize: Integer,
pageNumber: Integer
},
orderAscending: Boolean,
order: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(SharedWithMeResponse )
}

markItemsFavoriteV30

Marks a specified list of items (folders, workspaces/rooms, documents) as starred or unstarred (favorite).

Version: 3.0
Synopsis: POST
Path: /items/markFavorite
Request Body: MarkItemsStarred
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /items/markFavorite

Authorization: Bearer <ssid>
Content-type: application/json

{
documentGuids: Set(String),
folderGuids: Set(String),
workspaceGuids: Set(String),
value: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}