Package com.seeq.api
Class FoldersApi
java.lang.Object
com.seeq.api.FoldersApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionarchiveFolder
(String folderId) Archive a folder and all of its contentarchiveFolderWithHeadersAndHttpInfo
(String folderId, Map<String, String> customHeaders) Archive a folder and all of its contentarchiveFolderWithHttpInfo
(String folderId) Archive a folder and all of its contentcreateFolder
(FolderInputV1 body) Create a foldercreateFolderWithHeadersAndHttpInfo
(FolderInputV1 body, Map<String, String> customHeaders) Create a folderCreate a foldergetAncestors
(String folderId, String root) Get navigation context for a folder.Get navigation context for a folder.getAncestorsWithHttpInfo
(String folderId, String root) Get navigation context for a folder.Get information about a foldergetFolders
(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses) Get all root folders and workbooks, or folder content if a parent folder id is specified.getFoldersWithHeadersAndHttpInfo
(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses, Map<String, String> customHeaders) Get all root folders and workbooks, or folder content if a parent folder id is specified.getFoldersWithHttpInfo
(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses) Get all root folders and workbooks, or folder content if a parent folder id is specified.getFolderWithHeadersAndHttpInfo
(String folderId, Map<String, String> customHeaders) Get information about a foldergetFolderWithHttpInfo
(String folderId) Get information about a folderlong
getSubfolders
(String folderId, String root) Get subfolders of a folder.Get subfolders of a folder.getSubfoldersWithHttpInfo
(String folderId, String root) Get subfolders of a folder.moveItemToFolder
(String folderId, String itemId) Move specified item to specified foldermoveItemToFolderWithHeadersAndHttpInfo
(String folderId, String itemId, Map<String, String> customHeaders) Move specified item to specified foldermoveItemToFolderWithHttpInfo
(String folderId, String itemId) Move specified item to specified folderremoveItemFromFolder
(String folderId, String itemId) Remove specified item from specified folder.removeItemFromFolderWithHeadersAndHttpInfo
(String folderId, String itemId, Map<String, String> customHeaders) Remove specified item from specified folder.removeItemFromFolderWithHttpInfo
(String folderId, String itemId) Remove specified item from specified folder.void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout)
-
Constructor Details
-
FoldersApi
public FoldersApi() -
FoldersApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveFolder
Archive a folder and all of its content- Parameters:
folderId
- ID of the folder to archive (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveFolderWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveFolderWithHttpInfo(String folderId) throws ApiException Archive a folder and all of its content- Parameters:
folderId
- ID of the folder to archive (required)- Throws:
ApiException
- if fails to make API call
-
archiveFolderWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveFolderWithHeadersAndHttpInfo(String folderId, Map<String, String> customHeaders) throws ApiExceptionArchive a folder and all of its content- Parameters:
folderId
- ID of the folder to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createFolder
Create a folder- Parameters:
body
- Folder information (required)- Returns:
- FolderOutputV1
- Throws:
ApiException
- if fails to make API call
-
createFolderWithHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> createFolderWithHttpInfo(FolderInputV1 body) throws ApiException Create a folder- Parameters:
body
- Folder information (required)- Throws:
ApiException
- if fails to make API call
-
createFolderWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> createFolderWithHeadersAndHttpInfo(FolderInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a folder- Parameters:
body
- Folder information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getAncestors
Get navigation context for a folder.- Parameters:
folderId
- ID of the folder to retrieve. (required)root
- What sharing category results should be returned for (optional)- Returns:
- FolderNavigationOutputV1
- Throws:
ApiException
- if fails to make API call
-
getAncestorsWithHttpInfo
public ApiClient.ApiResponse<FolderNavigationOutputV1> getAncestorsWithHttpInfo(String folderId, String root) throws ApiException Get navigation context for a folder.- Parameters:
folderId
- ID of the folder to retrieve. (required)root
- What sharing category results should be returned for (optional)- Throws:
ApiException
- if fails to make API call
-
getAncestorsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderNavigationOutputV1> getAncestorsWithHeadersAndHttpInfo(String folderId, String root, Map<String, String> customHeaders) throws ApiExceptionGet navigation context for a folder.- Parameters:
folderId
- ID of the folder to retrieve. (required)root
- What sharing category results should be returned for (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFolder
Get information about a folder- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', or 'users' (admins only) fetch the authenticated user's home folder, the corporate folder, or the folder of all home folders, respectively. (required)- Returns:
- FolderOutputV1
- Throws:
ApiException
- if fails to make API call
-
getFolderWithHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> getFolderWithHttpInfo(String folderId) throws ApiException Get information about a folder- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', or 'users' (admins only) fetch the authenticated user's home folder, the corporate folder, or the folder of all home folders, respectively. (required)- Throws:
ApiException
- if fails to make API call
-
getFolderWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> getFolderWithHeadersAndHttpInfo(String folderId, Map<String, String> customHeaders) throws ApiExceptionGet information about a folder- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', or 'users' (admins only) fetch the authenticated user's home folder, the corporate folder, or the folder of all home folders, respectively. (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getFolders
public WorkbenchItemOutputListV1 getFolders(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses) throws ApiException Get all root folders and workbooks, or folder content if a parent folder id is specified.- Parameters:
filter
- If set to 'mine' or 'owner', only workbench items under the current user's home folder will be returned. If set to 'public' only workbench items shared with the Everyone group will be returned, excluding items under the corporate folder. If set to 'sharedOrPublic' only workbench items shared with the current user or a group they belong to are returned, excluding items under the corporate folder. If set to 'sharedDirectlyWithMe' only workbench items directly shared with the current user will be returned, excluding items under the corporate folder and items shared with groups the user belongs to. If set to 'shared' only workbench items shared with the current user or a group they belong to (except the Everyone group) are returned, excluding items under the corporate folder. If set to 'corporate', only workbench items under the corporate folder are returned. If set to 'users', only items under other user's home folders are returned. If set to 'all' (or not specified), all workbench items the current user has access to will be returned. (optional, default to all)userId
- The user ID to return folders for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)isArchived
- When true, returns only archived workbench items. (optional, default to false)sortOrder
- A field by which to order the folders followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name, owner (optional, default to createdAt asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)onlyPinned
- When true, returns only pinned workbench items are returned. The given folderId is not applied. (optional, default to false)folderId
- The folder to return the content of. If not specified, only root folders are returned unless filtering to specific IDs, filtering to pinned or archived items, sorting by last opened timestamp, or a text search is provided. (optional)ids
- The IDs of items to return. (optional)types
- The types of items to return. (optional)textSearch
- Search text by which to filter items' names. (optional)isExact
- If true, uses the exact query terms supplied by the user instead of stemming the query to its root words (optional, default to false)root
- The highest ancestor that items should have, if possible (optional)searchFields
- Search by name, description, or document body. Searches name by default when no field is supplied (optional)creatorIds
- List of creator IDs to filter on (optional)ownerIds
- List of owner IDs to filter on (optional)locations
- List of locations to search under, may be 'mine', 'others', or 'corporate'. 'mine' searches all items under the current user's home folder. 'others' searches items under home folders belonging to all users other than the current user. 'corporate' searches the corporate folder, if enabled. Values may be used together. No values searches all locations. (optional)accessStatuses
- List of access statuses to search by, may be 'public', 'groups', or 'directly'. 'public' searches items shared with the Everyone group, if enabled. 'groups' searches items shared with groups the current user belongs to. 'directly' searches items directly accessible by the current user. No values searches all access statuses. (optional)- Returns:
- WorkbenchItemOutputListV1
- Throws:
ApiException
- if fails to make API call
-
getFoldersWithHttpInfo
public ApiClient.ApiResponse<WorkbenchItemOutputListV1> getFoldersWithHttpInfo(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses) throws ApiException Get all root folders and workbooks, or folder content if a parent folder id is specified.- Parameters:
filter
- If set to 'mine' or 'owner', only workbench items under the current user's home folder will be returned. If set to 'public' only workbench items shared with the Everyone group will be returned, excluding items under the corporate folder. If set to 'sharedOrPublic' only workbench items shared with the current user or a group they belong to are returned, excluding items under the corporate folder. If set to 'sharedDirectlyWithMe' only workbench items directly shared with the current user will be returned, excluding items under the corporate folder and items shared with groups the user belongs to. If set to 'shared' only workbench items shared with the current user or a group they belong to (except the Everyone group) are returned, excluding items under the corporate folder. If set to 'corporate', only workbench items under the corporate folder are returned. If set to 'users', only items under other user's home folders are returned. If set to 'all' (or not specified), all workbench items the current user has access to will be returned. (optional, default to all)userId
- The user ID to return folders for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)isArchived
- When true, returns only archived workbench items. (optional, default to false)sortOrder
- A field by which to order the folders followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name, owner (optional, default to createdAt asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)onlyPinned
- When true, returns only pinned workbench items are returned. The given folderId is not applied. (optional, default to false)folderId
- The folder to return the content of. If not specified, only root folders are returned unless filtering to specific IDs, filtering to pinned or archived items, sorting by last opened timestamp, or a text search is provided. (optional)ids
- The IDs of items to return. (optional)types
- The types of items to return. (optional)textSearch
- Search text by which to filter items' names. (optional)isExact
- If true, uses the exact query terms supplied by the user instead of stemming the query to its root words (optional, default to false)root
- The highest ancestor that items should have, if possible (optional)searchFields
- Search by name, description, or document body. Searches name by default when no field is supplied (optional)creatorIds
- List of creator IDs to filter on (optional)ownerIds
- List of owner IDs to filter on (optional)locations
- List of locations to search under, may be 'mine', 'others', or 'corporate'. 'mine' searches all items under the current user's home folder. 'others' searches items under home folders belonging to all users other than the current user. 'corporate' searches the corporate folder, if enabled. Values may be used together. No values searches all locations. (optional)accessStatuses
- List of access statuses to search by, may be 'public', 'groups', or 'directly'. 'public' searches items shared with the Everyone group, if enabled. 'groups' searches items shared with groups the current user belongs to. 'directly' searches items directly accessible by the current user. No values searches all access statuses. (optional)- Throws:
ApiException
- if fails to make API call
-
getFoldersWithHeadersAndHttpInfo
public ApiClient.ApiResponse<WorkbenchItemOutputListV1> getFoldersWithHeadersAndHttpInfo(String filter, String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Boolean onlyPinned, String folderId, List<UUID> ids, List<String> types, String textSearch, Boolean isExact, String root, List<String> searchFields, List<UUID> creatorIds, List<UUID> ownerIds, List<String> locations, List<String> accessStatuses, Map<String, String> customHeaders) throws ApiExceptionGet all root folders and workbooks, or folder content if a parent folder id is specified.- Parameters:
filter
- If set to 'mine' or 'owner', only workbench items under the current user's home folder will be returned. If set to 'public' only workbench items shared with the Everyone group will be returned, excluding items under the corporate folder. If set to 'sharedOrPublic' only workbench items shared with the current user or a group they belong to are returned, excluding items under the corporate folder. If set to 'sharedDirectlyWithMe' only workbench items directly shared with the current user will be returned, excluding items under the corporate folder and items shared with groups the user belongs to. If set to 'shared' only workbench items shared with the current user or a group they belong to (except the Everyone group) are returned, excluding items under the corporate folder. If set to 'corporate', only workbench items under the corporate folder are returned. If set to 'users', only items under other user's home folders are returned. If set to 'all' (or not specified), all workbench items the current user has access to will be returned. (optional, default to all)userId
- The user ID to return folders for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)isArchived
- When true, returns only archived workbench items. (optional, default to false)sortOrder
- A field by which to order the folders followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name, owner (optional, default to createdAt asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)onlyPinned
- When true, returns only pinned workbench items are returned. The given folderId is not applied. (optional, default to false)folderId
- The folder to return the content of. If not specified, only root folders are returned unless filtering to specific IDs, filtering to pinned or archived items, sorting by last opened timestamp, or a text search is provided. (optional)ids
- The IDs of items to return. (optional)types
- The types of items to return. (optional)textSearch
- Search text by which to filter items' names. (optional)isExact
- If true, uses the exact query terms supplied by the user instead of stemming the query to its root words (optional, default to false)root
- The highest ancestor that items should have, if possible (optional)searchFields
- Search by name, description, or document body. Searches name by default when no field is supplied (optional)creatorIds
- List of creator IDs to filter on (optional)ownerIds
- List of owner IDs to filter on (optional)locations
- List of locations to search under, may be 'mine', 'others', or 'corporate'. 'mine' searches all items under the current user's home folder. 'others' searches items under home folders belonging to all users other than the current user. 'corporate' searches the corporate folder, if enabled. Values may be used together. No values searches all locations. (optional)accessStatuses
- List of access statuses to search by, may be 'public', 'groups', or 'directly'. 'public' searches items shared with the Everyone group, if enabled. 'groups' searches items shared with groups the current user belongs to. 'directly' searches items directly accessible by the current user. No values searches all access statuses. (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSubfolders
Get subfolders of a folder.- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', or 'users' can be used to fetch the top level categories. (required)root
- What sharing category results should be returned for (optional)- Returns:
- FolderNavigationOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSubfoldersWithHttpInfo
public ApiClient.ApiResponse<FolderNavigationOutputV1> getSubfoldersWithHttpInfo(String folderId, String root) throws ApiException Get subfolders of a folder.- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', or 'users' can be used to fetch the top level categories. (required)root
- What sharing category results should be returned for (optional)- Throws:
ApiException
- if fails to make API call
-
getSubfoldersWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderNavigationOutputV1> getSubfoldersWithHeadersAndHttpInfo(String folderId, String root, Map<String, String> customHeaders) throws ApiExceptionGet subfolders of a folder.- Parameters:
folderId
- ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', or 'users' can be used to fetch the top level categories. (required)root
- What sharing category results should be returned for (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
moveItemToFolder
Move specified item to specified folder- Parameters:
folderId
- ID of folder to move item to. Special values of 'mine' or 'corporate' move the item to the authenticated user's home folder or the corporate folder, respectively. (required)itemId
- ID of item to move to folder (required)- Returns:
- FolderOutputV1
- Throws:
ApiException
- if fails to make API call
-
moveItemToFolderWithHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> moveItemToFolderWithHttpInfo(String folderId, String itemId) throws ApiException Move specified item to specified folder- Parameters:
folderId
- ID of folder to move item to. Special values of 'mine' or 'corporate' move the item to the authenticated user's home folder or the corporate folder, respectively. (required)itemId
- ID of item to move to folder (required)- Throws:
ApiException
- if fails to make API call
-
moveItemToFolderWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> moveItemToFolderWithHeadersAndHttpInfo(String folderId, String itemId, Map<String, String> customHeaders) throws ApiExceptionMove specified item to specified folder- Parameters:
folderId
- ID of folder to move item to. Special values of 'mine' or 'corporate' move the item to the authenticated user's home folder or the corporate folder, respectively. (required)itemId
- ID of item to move to folder (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
removeItemFromFolder
Remove specified item from specified folder. The item will be moved to the root level.- Parameters:
folderId
- ID of folder to remove item from (required)itemId
- ID of item to remove from folder (required)- Returns:
- FolderOutputV1
- Throws:
ApiException
- if fails to make API call
-
removeItemFromFolderWithHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> removeItemFromFolderWithHttpInfo(String folderId, String itemId) throws ApiException Remove specified item from specified folder. The item will be moved to the root level.- Parameters:
folderId
- ID of folder to remove item from (required)itemId
- ID of item to remove from folder (required)- Throws:
ApiException
- if fails to make API call
-
removeItemFromFolderWithHeadersAndHttpInfo
public ApiClient.ApiResponse<FolderOutputV1> removeItemFromFolderWithHeadersAndHttpInfo(String folderId, String itemId, Map<String, String> customHeaders) throws ApiExceptionRemove specified item from specified folder. The item will be moved to the root level.- Parameters:
folderId
- ID of folder to remove item from (required)itemId
- ID of item to remove from folder (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-