Get With Minimal Response
//trimblecloud-fileservice/trimblecloud.fileservice/FoldersAPI/getWithMinimalResponse
getWithMinimalResponse
[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<MinimalFolder>>
Retrieves a folder by ID with minimal details. Default filter is applied. It retrieves folders with status = active.
Return
- A future that resolves to the folder response with minimal details.
Parameters
JVM
| spaceId | - The space id. |
| folderId | - The folder id. |
Throws
| TCPServiceException | - If an error occurs due to API or network-related issues. |
| SDKClientException | - If a client-side error occurs within the SDK. |
[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>>
Retrieves a folder by ID with minimal details.
Return
- A future that resolves to the folder response with minimal details.
Parameters
JVM
| spaceId | - The space id. |
| folderId | - The folder id. |
| status | - The status query parameter is used to filter the resources based on their status. |
Throws
| TCPServiceException | - If an error occurs due to API or network-related issues. |
| SDKClientException | - If a client-side error occurs within the SDK. |
[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFolder>>
Retrieves a folder by path with minimal details. Default filter is applied. It retrieves folders with status = active.
Return
- A future that resolves to the folder response with minimal details.
Parameters
JVM
| spaceId | - The space id. |
| path | - The path of the folder. |
Throws
| TCPServiceException | - If an error occurs due to API or network-related issues. |
| SDKClientException | - If a client-side error occurs within the SDK. |
[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>>
Retrieves a folder by path with minimal details.
Return
- A future that resolves to the folder response with minimal details.
Parameters
JVM
| spaceId | - The space id. |
| path | - The path of the folder. |
| status | - The status query parameter is used to filter the resources based on their status. |
Throws
| TCPServiceException | - If an error occurs due to API or network-related issues. |
| SDKClientException | - If a client-side error occurs within the SDK. |