Skip to content
File Service

TrimbleCloud.FileService

TrimbleCloud.FileService

Section titled “TrimbleCloud.FileService”

Contents

Section titled “Contents”

APIBase type

Section titled “APIBase type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Base class for API requests

JsonContentType constants

Section titled “JsonContentType constants”
Summary
Section titled “Summary”

Content type for JSON requests

JsonWrapperFormat constants

Section titled “JsonWrapperFormat constants”
Summary
Section titled “Summary”

JSON wrapper format string for API requests/responses

_client constants

Section titled “_client constants”
Summary
Section titled “Summary”

The HTTP client instance for making requests

_wrapperName constants

Section titled “_wrapperName constants”
Summary
Section titled “Summary”

The wrapper name for API responses

GetRequestId(message) method

Section titled “GetRequestId(message) method”
Summary
Section titled “Summary”

Extracts the request ID from the HTTP response headers

Returns
Section titled “Returns”

The request ID if present, otherwise an empty string

Parameters
Section titled “Parameters”
Name Type Description
message System.Net.Http.HttpResponseMessage The HTTP response message

ThrowErrorAsync(response) method

Section titled “ThrowErrorAsync(response) method”
Summary
Section titled “Summary”

Throws a TrimbleServiceException for HTTP error responses

Parameters
Section titled “Parameters”
Name Type Description
response System.Net.Http.HttpResponseMessage The HTTP response message
Exceptions
Section titled “Exceptions”
Name Description
TrimbleCloud.FileService.TrimbleServiceException Always thrown with error details (includes ArgumentNullException as inner exception if response is null)

Acl type

Section titled “Acl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the actor role mapping for the resources.

AccessExpiresAt property

Section titled “AccessExpiresAt property”
Summary
Section titled “Summary”

Time when the actor’s access to the resource expires.

Actor property

Section titled “Actor property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

Role property

Section titled “Role property”
Summary
Section titled “Summary”

The role assigned to the actor.

AclActor type

Section titled “AclActor type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an actor in the ACL (Access Control List).

Actor property

Section titled “Actor property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

AclApplicationIdentity type

Section titled “AclApplicationIdentity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an application identity in the access control list (ACL).

#ctor(applicationId) constructor

Section titled “#ctor(applicationId) constructor”
Summary
Section titled “Summary”

Creates an application identity.

Parameters
Section titled “Parameters”
Name Type Description
applicationId System.Guid The application id

FormatEntity() method

Section titled “FormatEntity() method”
Summary
Section titled “Summary”

Returns the TRN (Trimble Resource Name) of the application.

Parameters
Section titled “Parameters”

This method has no parameters.

AclCustomIdentity type

Section titled “AclCustomIdentity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a custom identity in the access control list (ACL).

#ctor(entityTrn) constructor

Section titled “#ctor(entityTrn) constructor”
Summary
Section titled “Summary”

Creates a custom identity.

Parameters
Section titled “Parameters”
Name Type Description
entityTrn System.String The TRN of the custom entity

FormatEntity() method

Section titled “FormatEntity() method”
Summary
Section titled “Summary”

Returns the TRN (Trimble Resource Name) of the custom entity.

Parameters
Section titled “Parameters”

This method has no parameters.

AclDeviceIdentity type

Section titled “AclDeviceIdentity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a device identity in the access control list (ACL).

#ctor(deviceId) constructor

Section titled “#ctor(deviceId) constructor”
Summary
Section titled “Summary”

Creates a device identity.

Parameters
Section titled “Parameters”
Name Type Description
deviceId System.Guid The device id

FormatEntity() method

Section titled “FormatEntity() method”
Summary
Section titled “Summary”

Returns the TRN (Trimble Resource Name) of the device.

Parameters
Section titled “Parameters”

This method has no parameters.

AclIdentity type

Section titled “AclIdentity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an identity in the access control list (ACL).

EntityId property

Section titled “EntityId property”
Summary
Section titled “Summary”

The entity ID

Equals(obj) method

Section titled “Equals(obj) method”
Summary
Section titled “Summary”

Check if two entities are equal

Returns
Section titled “Returns”

True if the entities are equal

Parameters
Section titled “Parameters”
Name Type Description
obj System.Object The entity to compare

FormatEntity() method

Section titled “FormatEntity() method”
Summary
Section titled “Summary”

Format the entity as a TRN string

Returns
Section titled “Returns”

The formatted TRN string

Parameters
Section titled “Parameters”

This method has no parameters.

GetHashCode() method

Section titled “GetHashCode() method”
Summary
Section titled “Summary”

Get the hash code for the entity

Returns
Section titled “Returns”

The hash code

Parameters
Section titled “Parameters”

This method has no parameters.

Parse(entityTrn) method

Section titled “Parse(entityTrn) method”
Summary
Section titled “Summary”

Construct an ACL identity

Returns
Section titled “Returns”

The ACL identity

Parameters
Section titled “Parameters”
Name Type Description
entityTrn System.String The entity ID

ToString() method

Section titled “ToString() method”
Summary
Section titled “Summary”

Create a string representation of the entity

Returns
Section titled “Returns”

The string representation

Parameters
Section titled “Parameters”

This method has no parameters.

AclIdentityConverter type

Section titled “AclIdentityConverter type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Converter for ACLIdentity

CanConvertFrom() method

Section titled “CanConvertFrom() method”
Summary
Section titled “Summary”

Check if the type can be converted from a string

Parameters
Section titled “Parameters”

This method has no parameters.

ConvertFrom() method

Section titled “ConvertFrom() method”
Summary
Section titled “Summary”

Convert a string to an ACLIdentity

Parameters
Section titled “Parameters”

This method has no parameters.

AclRole type

Section titled “AclRole type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Permissions types

ContentContributor constants

Section titled “ContentContributor constants”
Summary
Section titled “Summary”

ContentContributor has all operations on the file and folder except for the ACL control.

ContentManager constants

Section titled “ContentManager constants”
Summary
Section titled “Summary”

ContentManager almost as many permissions as SpaceManager, but cannot update/delete the file space.

ContentViewer constants

Section titled “ContentViewer constants”
Summary
Section titled “Summary”

ContentViewer has all read permissions on the file and folder.

LimitedViewer constants

Section titled “LimitedViewer constants”
Summary
Section titled “Summary”

LimitedViewer has restricted permissions on files and folders.

SpaceManager constants

Section titled “SpaceManager constants”
Summary
Section titled “Summary”

SpaceManager has highest level of permissions in the file space. Can perform all operations on the file space.

SupportFileAdmin constants

Section titled “SupportFileAdmin constants”
Summary
Section titled “Summary”

SupportFileAdmin has administrative permissions specifically for support files.

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown role type

AclUserIdentity type

Section titled “AclUserIdentity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a user identity in the access control list (ACL).

#ctor(userId) constructor

Section titled “#ctor(userId) constructor”
Summary
Section titled “Summary”

Creates a user identity.

Parameters
Section titled “Parameters”
Name Type Description
userId System.Guid The user id

FormatEntity() method

Section titled “FormatEntity() method”
Summary
Section titled “Summary”

Returns the TRN (Trimble Resource Name) of the user.

Parameters
Section titled “Parameters”

This method has no parameters.

BatchFolderCreate type

Section titled “BatchFolderCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Create batch folders request

Folders property

Section titled “Folders property”
Summary
Section titled “Summary”

Folders to create in batch

BatchFolderList type

Section titled “BatchFolderList type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

List of Folders and Invalid Folder Items returned by the Batch Folder List API

InvalidItems property

Section titled “InvalidItems property”
Summary
Section titled “Summary”

List of Invalid Folder Items

Items property

Section titled “Items property”
Summary
Section titled “Summary”

List of Valid Folder Items

BatchMinimalFolderList type

Section titled “BatchMinimalFolderList type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Response for Batch Get Minimal Folder List

InvalidItems property

Section titled “InvalidItems property”
Summary
Section titled “Summary”

List of Invalid Folder Items

Items property

Section titled “Items property”
Summary
Section titled “Summary”

List of Valid Folder Items

BatchResourceListResponse type

Section titled “BatchResourceListResponse type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Batch Get Resources Response

InvalidItems property

Section titled “InvalidItems property”
Summary
Section titled “Summary”

List of Invalid Resource Items

Items property

Section titled “Items property”
Summary
Section titled “Summary”

List of Valid Resource Items

Capabilities type

Section titled “Capabilities type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a filespace in File Service.

CanCheckIn property

Section titled “CanCheckIn property”
Summary
Section titled “Summary”

Whether the user can check in the file. The actor who checked out the file or an actor with the ContentManager role attached to the file or parent resource is allowed to checkout the file.

CanCheckOut property

Section titled “CanCheckOut property”
Summary
Section titled “Summary”

Whether the user can check out the file. Checking out a file will prevent other actors from creating a new version or other mutation operations. A checked out file will be deleted in a recursive parent deletion. Support files cannot be checked out.

CanCreate property

Section titled “CanCreate property”
Summary
Section titled “Summary”

Whether the user can create a child resource (Folder/File) under the given resource.

CanDelete property

Section titled “CanDelete property”
Summary
Section titled “Summary”

Whether the user can delete the resource.

CanLock property

Section titled “CanLock property”
Summary
Section titled “Summary”

Whether the user can lock the given file.

CanManageAccess property

Section titled “CanManageAccess property”
Summary
Section titled “Summary”

Whether the user can update the permissions of the resource.

CanRead property

Section titled “CanRead property”
Summary
Section titled “Summary”

Whether the user can read the resource.

CanUnlock property

Section titled “CanUnlock property”
Summary
Section titled “Summary”

Whether the user can unlock the given file. For Unlock, a user must have the ContentManager role or have locked the file themselves. Note: The canUnlock capability is true if the user has the ContentManager role, regardless of who locked the file.

CanUpdate property

Section titled “CanUpdate property”
Summary
Section titled “Summary”

Whether the user can perform Update, Move, Rename, or Restore operations on the resource. Note: Move and Restore operations consider destination access for authorization, but canUpdate is determined solely by user roles.

Checkout type

Section titled “Checkout type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a checkout of a file in File Service.

CheckedOutAt property

Section titled “CheckedOutAt property”
Summary
Section titled “Summary”

The date and time when the file was checked out.

CheckedOutBy property

Section titled “CheckedOutBy property”
Summary
Section titled “Summary”

The actor who checked out the file.

Reason property

Section titled “Reason property”
Summary
Section titled “Summary”

The reason for checking out the file.

CopyFileRequest type

Section titled “CopyFileRequest type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Request object for file copying operations

CopyAcl property

Section titled “CopyAcl property”
Summary
Section titled “Summary”

Whether to copy the ACL of the file. If true, the copied file will have the same ACL as the original file of permissionLocal and not permissionInherited

FileId property

Section titled “FileId property”
Summary
Section titled “Summary”

The file ID to copy

Headers property

Section titled “Headers property”
Summary
Section titled “Summary”

Custom HTTP headers to include with the request

IncludeSupportFiles property

Section titled “IncludeSupportFiles property”
Summary
Section titled “Summary”

Copy support files and links along with the files

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The new name of the copied file. If not specified, the file will be copied with its original name

OverwriteExisting property

Section titled “OverwriteExisting property”
Summary
Section titled “Summary”

Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the file.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID

TargetParentId property

Section titled “TargetParentId property”
Summary
Section titled “Summary”

The target parent ID where the file will be copied to

Version property

Section titled “Version property”
Summary
Section titled “Summary”

All specified versions will be copied. If not specified, the latest version will be copied

CopyFolderRequest type

Section titled “CopyFolderRequest type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Request object for file copying operations

CopyAcl property

Section titled “CopyAcl property”
Summary
Section titled “Summary”

Whether to copy the ACL of the file. If true, the copied file will have the same ACL as the original file of permissionLocal and not permissionInherited

FolderId property

Section titled “FolderId property”
Summary
Section titled “Summary”

The file ID to copy

Headers property

Section titled “Headers property”
Summary
Section titled “Summary”

Custom HTTP headers to include with the request

IncludeSupportFiles property

Section titled “IncludeSupportFiles property”
Summary
Section titled “Summary”

Copy support files and links along with the files

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The new name of the copied file. If not specified, the file will be copied with its original name

OverwriteExisting property

Section titled “OverwriteExisting property”
Summary
Section titled “Summary”

Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the file.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID

TargetParentId property

Section titled “TargetParentId property”
Summary
Section titled “Summary”

The target parent ID where the file will be copied to

Download type

Section titled “Download type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Contains the download URL of a file.

Url property

Section titled “Url property”
Summary
Section titled “Summary”

The download URL of the file.

DownloadUrlHelper type

Section titled “DownloadUrlHelper type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

Helpers for download URLs returned by the File Service API.

RemoveWildcardFromDownloadUrl(url) method

Section titled “RemoveWildcardFromDownloadUrl(url) method”
Summary
Section titled “Summary”

Removes a placeholder asterisk from a presigned download URL so HTTP range requests work (for example zip or fileset downloads).

Returns
Section titled “Returns”

The URL with the wildcard removed, or the original value if null, empty, or no asterisk is present.

Parameters
Section titled “Parameters”
Name Type Description
url System.String The download URL from Download.

EnumConverter`1 type

Section titled “EnumConverter`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Generic converter for enums

ReadJson() method

Section titled “ReadJson() method”
Summary
Section titled “Summary”

Read an enum value from a JSON string

Parameters
Section titled “Parameters”

This method has no parameters.

EnumHelper`1 type

Section titled “EnumHelper`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

Helper class for Enum

GetEnumMemberValue() method

Section titled “GetEnumMemberValue() method”
Summary
Section titled “Summary”

Get the EnumMember value of an Enum

Parameters
Section titled “Parameters”

This method has no parameters.

Export type

Section titled “Export type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an Export in File Service.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the export was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this export.

ExportTrn property

Section titled “ExportTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the export.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the export.

Output property

Section titled “Output property”
Summary
Section titled “Summary”

The job output information.

ResourceId property

Section titled “ResourceId property”
Summary
Section titled “Summary”

The identifier of the target folder to download.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the resource.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The identifier of the space.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status of the export operation.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the export was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this export.

File type

Section titled “File type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a file in File Service.

Capabilities property

Section titled “Capabilities property”
Summary
Section titled “Summary”

The actions that can be performed on the resource by the current user.

Checkout property

Section titled “Checkout property”
Summary
Section titled “Summary”

The checkout details of the file, if it is checked out.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this file.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Download property

Section titled “Download property”
Summary
Section titled “Summary”

The download URL of the file.

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

The time period when the file object gets automatically removed.

FileSet property

Section titled “FileSet property”
Summary
Section titled “Summary”

Whether the object consists of a set of multiple files that should be treated as a single file.

LastMalwareScanDate property

Section titled “LastMalwareScanDate property”
Summary
Section titled “Summary”

The date and time of the last malware scan for the file.

Section titled “Links property”
Summary
Section titled “Summary”

The support file links

Lock property

Section titled “Lock property”
Summary
Section titled “Summary”

The lock details of the file

MD5 property

Section titled “MD5 property”
Summary
Section titled “Summary”

MD5 hash of the file.

MalwareScanResult property

Section titled “MalwareScanResult property”
Summary
Section titled “Summary”

The result of the malware scan for the file. Only applicable when the MalwareScanStatus is INFECTED or CANNOT_SCAN.

MalwareScanStatus property

Section titled “MalwareScanStatus property”
Summary
Section titled “Summary”

The status of the malware scan for the file.

MalwareType property

Section titled “MalwareType property”
Summary
Section titled “Summary”

The type of malware detected. Only applicable when the MalwareScanStatus is INFECTED. Format is threat type (virus, adware, spyware, pua etc):threat name. For suspicious files the threat type is ‘unknown’.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the folder.

Multipart property

Section titled “Multipart property”
Summary
Section titled “Summary”

True if the client will split the upload into multiple parts.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The parent folder identifier where the file was created.

ParentTrn property

Section titled “ParentTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the parent folder.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type.

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The path where file is created.

PermissionsEvaluated property

Section titled “PermissionsEvaluated property”
Summary
Section titled “Summary”

Permissions evaluated for the actors on the resource. It shows the most permissible role applicable for the actor, considering both the direct and inherited permissions.

PermissionsInherited property

Section titled “PermissionsInherited property”
Summary
Section titled “Summary”

Permissions inherited from the entire parent hierarchy applicable for the actor.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the file.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

True if the download url of the file should expire as per ExpiresAt property.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the file in bytes.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier for the space where the file is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space where the file is stored.

Statistics property

Section titled “Statistics property”
Summary
Section titled “Summary”

The statistics of the file.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the file, represented in a ‘major.minor’ format.

FileAcl type

Section titled “FileAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the actor role mapping for file resources with version information.

AccessExpiresAt property

Section titled “AccessExpiresAt property”
Summary
Section titled “Summary”

Time when the actor’s access to the resource expires.

Actor property

Section titled “Actor property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

Role property

Section titled “Role property”
Summary
Section titled “Summary”

The role assigned to the actor.

Versions property

Section titled “Versions property”
Summary
Section titled “Summary”

List of versions associated with this ACL entry.

FileInputUploadDetails type

Section titled “FileInputUploadDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The input file information.

Section titled “AddToLinks property”
Summary
Section titled “Summary”

Whether the support file should be linked to the parent file

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

The expiration date of the file.

FileId property

Section titled “FileId property”
Summary
Section titled “Summary”

The unique identifier of the file.

FileSet property

Section titled “FileSet property”
Summary
Section titled “Summary”

Whether the object consists of a set of multiple files that should be treated as a single file.

FileTrn property

Section titled “FileTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the file.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the file.

Multipart property

Section titled “Multipart property”
Summary
Section titled “Summary”

True if the client will split the upload into multiple parts.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the file that was created.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The parent folder identifier where the file was created.

ParentMajorVersion property

Section titled “ParentMajorVersion property”
Summary
Section titled “Summary”

Parent major version for support files.

ParentTrn property

Section titled “ParentTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the parent folder where the file was created.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type.

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The path where file is created.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

True if the download url of the file shouldn’t expire.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier for the space where the file is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space where the file is stored.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status of the file upload.

SupportFileKey property

Section titled “SupportFileKey property”
Summary
Section titled “Summary”

The key of the support file

Upload property

Section titled “Upload property”
Summary
Section titled “Summary”

The upload URL and type of upload for the file.

FileOrFolder type

Section titled “FileOrFolder type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a file or folder in File Service.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the children was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of children. Children can be a file or a folder.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the children.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The Resource Trn of the children

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier for the space where the file/folder is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The Space Trn for the space

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the children either it can be file or folder.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the children was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the children, represented in a ‘major.minor’ format.

FilePart type

Section titled “FilePart type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a part that was uploaded.

ETag property

Section titled “ETag property”
Summary
Section titled “Summary”

Entity tag for the part.

PartNumber property

Section titled “PartNumber property”
Summary
Section titled “Summary”

The sequence number of the part.

FilePermissionsLocal type

Section titled “FilePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions explicitly assigned to a file.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors and their roles.

Remarks
Section titled “Remarks”

This property is deprecated. Use FileAcl instead, which supports file versions restriction to the acl actor.

FileAcl property

Section titled “FileAcl property”
Summary
Section titled “Summary”

The list of actors, their roles and versions.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

FileServiceClient type

Section titled “FileServiceClient type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

A client for the Trimble Cloud Platform File Service

#ctor(httpClientProvider) constructor

Section titled “#ctor(httpClientProvider) constructor”
Summary
Section titled “Summary”

Public constructor for File Service client

Parameters
Section titled “Parameters”
Name Type Description
httpClientProvider Trimble.ID.IHttpClientProvider A provider of a pre-configured HttpClient used for API calls made by this client
Exceptions
Section titled “Exceptions”
Name Description
System.ArgumentNullException Thrown when httpClientProvider is null

#ctor(httpClientProvider,clientConfig) constructor

Section titled “#ctor(httpClientProvider,clientConfig) constructor”
Summary
Section titled “Summary”

Public constructor for File Service client

Parameters
Section titled “Parameters”
Name Type Description
httpClientProvider Trimble.ID.IHttpClientProvider A provider of a pre-configured HttpClient used for API calls made by this client
clientConfig TrimbleCloud.FileService.FileServiceClientConfig The configuration values for the client

#ctor(httpClientProvider,httpMessageHandler) constructor

Section titled “#ctor(httpClientProvider,httpMessageHandler) constructor”
Summary
Section titled “Summary”

Public constructor for File Service client

Parameters
Section titled “Parameters”
Name Type Description
httpClientProvider Trimble.ID.IHttpClientProvider A provider of a pre-configured HttpClient used for API calls made by this client
httpMessageHandler System.Net.Http.HttpMessageHandler The HttpMessageHandler to use the custom Http Message handler
Exceptions
Section titled “Exceptions”
Name Description
System.ArgumentNullException Thrown when httpClientProvider is null
System.ArgumentNullException Thrown when httpMessageHandler is null

Exports property

Section titled “Exports property”
Summary
Section titled “Summary”

Exports API

Files property

Section titled “Files property”
Summary
Section titled “Summary”

Files API

Folders property

Section titled “Folders property”
Summary
Section titled “Summary”

Folders API

Jobs property

Section titled “Jobs property”
Summary
Section titled “Summary”

Jobs API

ObjectTypes property

Section titled “ObjectTypes property”
Summary
Section titled “Summary”

Object Types API

Objects property

Section titled “Objects property”
Summary
Section titled “Summary”

Objects API

Resources property

Section titled “Resources property”
Summary
Section titled “Summary”

Resources API

Spaces property

Section titled “Spaces property”
Summary
Section titled “Summary”

Spaces API

_clientConfig property

Section titled “_clientConfig property”
Summary
Section titled “Summary”

Configuration values for the client

_httpClientProvider property

Section titled “_httpClientProvider property”
Summary
Section titled “Summary”

Provider of a pre-configured HttpClient used for API calls made by this client

FileServiceClientConfig type

Section titled “FileServiceClientConfig type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Configuration values for the File Service client

#ctor() constructor

Section titled “#ctor() constructor”
Summary
Section titled “Summary”

Public constructor for File Service client configuration

Parameters
Section titled “Parameters”

This constructor has no parameters.

HttpTimeout property

Section titled “HttpTimeout property”
Summary
Section titled “Summary”

The timeout for HTTP requests

Retries property

Section titled “Retries property”
Summary
Section titled “Summary”

The number of times to retry a request if it fails

RetryInterval property

Section titled “RetryInterval property”
Summary
Section titled “Summary”

The interval between retries

FileStatistics type

Section titled “FileStatistics type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the statistics of a file.

DecompressedSize property

Section titled “DecompressedSize property”
Summary
Section titled “Summary”

The size of decompressed file in bytes. This field is only applicable for fileset.

SupportFilesCount property

Section titled “SupportFilesCount property”
Summary
Section titled “Summary”

The count of support files under the main file.

SupportFilesSize property

Section titled “SupportFilesSize property”
Summary
Section titled “Summary”

The cumulative size of all the latest versions of the support files in bytes.

SupportFilesUpdatedAt property

Section titled “SupportFilesUpdatedAt property”
Summary
Section titled “Summary”

The date and time when the support files were last updated.

FileStatus type

Section titled “FileStatus type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The status of the File upload

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown status

Uploadable constants

Section titled “Uploadable constants”
Summary
Section titled “Summary”

The file is uploadable

Uploaded constants

Section titled “Uploaded constants”
Summary
Section titled “Summary”

The file has been uploaded

FileUpdate type

Section titled “FileUpdate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a file update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

Time period when the file object gets automatically removed. Must be at least 1 hour after the current time. Should not exceed 20 years from the current time.

Section titled “Links property”
Summary
Section titled “Summary”

Update the support file link for the file.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Update the metadata for the file.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the file.

FileUpdateAcl type

Section titled “FileUpdateAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to update file ACL.

Add property

Section titled “Add property”
Summary
Section titled “Summary”

Add new roles to the existing permissions on the resource. If an actor already has a permission on the resource and is included in the request again, their existing permissions will be replaced with the new ones specified.

Remarks
Section titled “Remarks”

This property is deprecated. Use AddFileAcl instead, which supports file versions restriction to the acl actor.

AddFileAcl property

Section titled “AddFileAcl property”
Summary
Section titled “Summary”

Add new roles with version support to the existing permissions on the resource. If an actor already has a permission on the resource and is included in the request again, their existing permissions will be replaced with the new ones specified.

Remove property

Section titled “Remove property”
Summary
Section titled “Summary”

The actors to be removed from the permissions.

FileUpdatePermissionsLocal type

Section titled “FileUpdatePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a file permissions update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

ReplaceAcl property

Section titled “ReplaceAcl property”
Summary
Section titled “Summary”

Completely replace the existing permissions on the resource. When this field is used, all previous permissions are overwritten by the new ones.

Remarks
Section titled “Remarks”

This property is deprecated. Use ReplaceFileAcl instead, which supports file versions restriction to the acl actor.

ReplaceFileAcl property

Section titled “ReplaceFileAcl property”
Summary
Section titled “Summary”

Completely replace the existing permissions on the resource with file ACL entries that support versions. When this field is used, all previous permissions are overwritten by the new ones.

UpdateAcl property

Section titled “UpdateAcl property”
Summary
Section titled “Summary”

Add or remove roles to the existing permissions on the resource.

FileUploadCreate type

Section titled “FileUploadCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a file creation request.

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

Time period when the file object gets automatically removed. Must be at least 1 hour after the current time. Should not exceed 20 years from the current time.

Fileset property

Section titled “Fileset property”
Summary
Section titled “Summary”

Whether the object consists of a set of multiple files that should be treated as a single file.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the file.

Multipart property

Section titled “Multipart property”
Summary
Section titled “Summary”

True if the client will split the upload into multiple parts.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the file.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The parent folder identifier to which the file has to be uploaded.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

Set to false if the download url of the file shouldn’t be expired. Whereas when true download url expiration takes place according to the configured value.

FilesAPI type

Section titled “FilesAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

GetDefaultUrlDuration() method

Section titled “GetDefaultUrlDuration() method”
Summary
Section titled “Summary”

Gets the default URL duration based on file size. For files larger than 10GB, returns 2 days; otherwise returns 60 minutes.

Parameters
Section titled “Parameters”

This method has no parameters.

Folder type

Section titled “Folder type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a folder in File Service.

Capabilities property

Section titled “Capabilities property”
Summary
Section titled “Summary”

The actions that can be performed on the resource by the current user.

Checkout property

Section titled “Checkout property”
Summary
Section titled “Summary”

The checkout details of the folder, if it is checked out.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this filespace.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the folder.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

Folder identifier of the parent folder.

ParentTrn property

Section titled “ParentTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the parent folder.

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The path of the folder.

PermissionsEvaluated property

Section titled “PermissionsEvaluated property”
Summary
Section titled “Summary”

Permissions evaluated for the actors on the resource. It shows the most permissible role applicable for the actor, considering both the direct and inherited permissions.

PermissionsInherited property

Section titled “PermissionsInherited property”
Summary
Section titled “Summary”

Permissions inherited from the entire parent hierarchy applicable for the actor.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the folder.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the folder in bytes.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier of the space where the folder is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space where the folder is stored.

Statistics property

Section titled “Statistics property”
Summary
Section titled “Summary”

The statistics of the folder.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this filespace.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The folder version.

FolderCreate type

Section titled “FolderCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a folder creation request.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the folder.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the folder.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The identifier of the parent.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

FolderCreateChild type

Section titled “FolderCreateChild type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Create child folder request

Children property

Section titled “Children property”
Summary
Section titled “Summary”

List of nested child folders to create within this folder

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Metadata associated with the folder

Name property

Section titled “Name property”
Summary
Section titled “Summary”

Name of the child folder to create

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

The permissions for the folder

FolderCreateWithChildren type

Section titled “FolderCreateWithChildren type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Create parent folder request

Children property

Section titled “Children property”
Summary
Section titled “Summary”

List of nested child folders to create within this folder

FolderListChildrenRequest type

Section titled “FolderListChildrenRequest type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Request object for listing children of a folder. Either FolderId or Path must be specified, but not both.

FilterCriteria property

Section titled “FilterCriteria property”
Summary
Section titled “Summary”

The filter criteria to apply to the list. Use FolderListFilterCriteria to filter by resource type.

FolderId property

Section titled “FolderId property”
Summary
Section titled “Summary”

The folder ID to list children from. Either FolderId or Path must be specified, but not both.

MaxItems property

Section titled “MaxItems property”
Summary
Section titled “Summary”

The number of items to return in each page (1-1000). Default is 100.

NextPageToken property

Section titled “NextPageToken property”
Summary
Section titled “Summary”

The token to retrieve the next page of items

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The folder path to list children from. Either FolderId or Path must be specified, but not both.

Recursive property

Section titled “Recursive property”
Summary
Section titled “Summary”

Whether to recursively list children of all subfolders. Default is false.

SortBy property

Section titled “SortBy property”
Summary
Section titled “Summary”

The field to sort results by

SortOrder property

Section titled “SortOrder property”
Summary
Section titled “Summary”

The sort order (asc or desc)

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID

FolderListFilterCriteria type

Section titled “FolderListFilterCriteria type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Criteria for filtering a list of files

ResourceType property

Section titled “ResourceType property”
Summary
Section titled “Summary”

Gets or sets the type of the Resource to filter by.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

Gets or sets the folder status.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

Gets or sets the file URL duration.

FolderPermissionsLocal type

Section titled “FolderPermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions explicitly assigned to a folder.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors and their roles.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

FolderStatistics type

Section titled “FolderStatistics type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the statistics of a folder.

ContentsUpdatedAt property

Section titled “ContentsUpdatedAt property”
Summary
Section titled “Summary”

The date and time when the contents of the folder were last updated.

ImmediateFilesCount property

Section titled “ImmediateFilesCount property”
Summary
Section titled “Summary”

The count of files directly under the folder.

ImmediateFoldersCount property

Section titled “ImmediateFoldersCount property”
Summary
Section titled “Summary”

The count of folders directly under the folder.

SupportFilesSize property

Section titled “SupportFilesSize property”
Summary
Section titled “Summary”

The cumulative size of all the latest versions of the support files in bytes.

FolderUpdate type

Section titled “FolderUpdate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a folder update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Update the metadata for the folder.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the folder.

FolderUpdateAcl type

Section titled “FolderUpdateAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to update folder ACL.

Add property

Section titled “Add property”
Summary
Section titled “Summary”

Add new roles to the existing permissions on the resource. If an actor already has a permission on the resource and is included in the request again, their existing permissions will be replaced with the new ones specified.

Remove property

Section titled “Remove property”
Summary
Section titled “Summary”

The actors to be removed from the permissions.

FolderUpdatePermissionsLocal type

Section titled “FolderUpdatePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a folder permissions update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

ReplaceAcl property

Section titled “ReplaceAcl property”
Summary
Section titled “Summary”

Completely replace the existing permissions on the resource. When this field is used, all previous permissions are overwritten by the new ones.

UpdateAcl property

Section titled “UpdateAcl property”
Summary
Section titled “Summary”

Add or remove roles to the existing permissions on the resource.

GetJobQueryParams type

Section titled “GetJobQueryParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Query parameters for retrieving job details in File Service.

FastCheck property

Section titled “FastCheck property”
Summary
Section titled “Summary”

Optimize internal polling frequency. Effective only if longpoll is true

LongPoll property

Section titled “LongPoll property”
Summary
Section titled “Summary”

Performs a long-polling request for the status

GetObjectParams type

Section titled “GetObjectParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Parameters for getting an object.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status filter for the object.

GetQueryParameters() method

Section titled “GetQueryParameters() method”
Summary
Section titled “Summary”

Gets query parameters for the request.

Returns
Section titled “Returns”

Dictionary of query parameters

Parameters
Section titled “Parameters”

This method has no parameters.

GetObjectVersionParams type

Section titled “GetObjectVersionParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Parameters for getting a specific object version.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status filter for the object.

GetQueryParameters() method

Section titled “GetQueryParameters() method”
Summary
Section titled “Summary”

Gets query parameters for the request.

Returns
Section titled “Returns”

Dictionary of query parameters

Parameters
Section titled “Parameters”

This method has no parameters.

GetUploadDetailsQueryParams type

Section titled “GetUploadDetailsQueryParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The query parameters for retrieving upload details.

FastCheck property

Section titled “FastCheck property”
Summary
Section titled “Summary”

Optimize internal polling frequency. Effective only if longpoll is true

LongPoll property

Section titled “LongPoll property”
Summary
Section titled “Summary”

Performs a long-polling request for the status

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

Gets or sets the file URL duration.

HttpClientResponse type

Section titled “HttpClientResponse type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

HTTP client response implementation for the common Response class

#ctor(requestId,responseMessage) constructor

Section titled “#ctor(requestId,responseMessage) constructor”
Summary
Section titled “Summary”

Initializes a new instance of the HttpClientResponse class

Parameters
Section titled “Parameters”
Name Type Description
requestId System.String The request ID
responseMessage System.Net.Http.HttpResponseMessage The HTTP response message

ContentLength property

Section titled “ContentLength property”
Summary
Section titled “Summary”

Gets the content length of the response

IsError property

Section titled “IsError property”
Summary
Section titled “Summary”

Gets a value indicating whether this response represents an error

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Gets the response headers as metadata

ReasonPhrase property

Section titled “ReasonPhrase property”
Summary
Section titled “Summary”

Gets the HTTP reason phrase

RequestId property

Section titled “RequestId property”
Summary
Section titled “Summary”

Gets or sets the request ID

Status property

Section titled “Status property”
Summary
Section titled “Summary”

Gets the HTTP status code

Dispose() method

Section titled “Dispose() method”
Summary
Section titled “Summary”

Disposes the response and underlying resources

Parameters
Section titled “Parameters”

This method has no parameters.

Dispose(disposing) method

Section titled “Dispose(disposing) method”
Summary
Section titled “Summary”

Disposes the underlying HTTP response message

Parameters
Section titled “Parameters”
Name Type Description
disposing System.Boolean True if called from Dispose(), false if called from finalizer

ToString() method

Section titled “ToString() method”
Summary
Section titled “Summary”

Returns the string representation of the HTTP response

Returns
Section titled “Returns”

String representation of the response

Parameters
Section titled “Parameters”

This method has no parameters.

IExportsAPI type

Section titled “IExportsAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Exports API

Create(spaceId,folderId,includeTopLevel) method

Section titled “Create(spaceId,folderId,includeTopLevel) method”
Summary
Section titled “Summary”

Start a job to download and zip all children of a folder into a single file

Returns
Section titled “Returns”

A Task that resolves to Guid of the export

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
includeTopLevel System.Boolean

Get(spaceId,exportId,urlDuration) method

Section titled “Get(spaceId,exportId,urlDuration) method”
Summary
Section titled “Summary”

Get an export by ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains Export data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
exportId System.Guid The export ID
urlDuration System.Nullable{System.TimeSpan} The export download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days.

IFileServiceClient type

Section titled “IFileServiceClient type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Trimble Cloud Platform File Service Client

Exports property

Section titled “Exports property”
Summary
Section titled “Summary”

Exports API

Files property

Section titled “Files property”
Summary
Section titled “Summary”

Files API

Folders property

Section titled “Folders property”
Summary
Section titled “Summary”

Folders API

Jobs property

Section titled “Jobs property”
Summary
Section titled “Summary”

Jobs API

ObjectTypes property

Section titled “ObjectTypes property”
Summary
Section titled “Summary”

Object Types API

Objects property

Section titled “Objects property”
Summary
Section titled “Summary”

Objects API

Resources property

Section titled “Resources property”
Summary
Section titled “Summary”

Resources API

Spaces property

Section titled “Spaces property”
Summary
Section titled “Summary”

Spaces API

IFilesAPI type

Section titled “IFilesAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Files API

CheckInFile(spaceId,fileId) method

Section titled “CheckInFile(spaceId,fileId) method”
Summary
Section titled “Summary”

Checking in a file will allow other actors to create a new version or perform other mutation operations

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
fileId System.Guid

CheckInFileWithMinimalResponse(spaceId,fileId) method

Section titled “CheckInFileWithMinimalResponse(spaceId,fileId) method”
Summary
Section titled “Summary”

Checkin a file with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
fileId System.Guid

CheckOutFile(spaceId,fileId,reason,headers) method

Section titled “CheckOutFile(spaceId,fileId,reason,headers) method”
Summary
Section titled “Summary”

Checking out a file will prevent other actors from creating a new version or other mutation operations

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
fileId System.Guid
reason System.String
headers System.Collections.Generic.IDictionary{System.String,System.String}

CheckOutFileWithMinimalResponse(spaceId,fileId,reason,headers) method

Section titled “CheckOutFileWithMinimalResponse(spaceId,fileId,reason,headers) method”
Summary
Section titled “Summary”

Checkout a file with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
fileId System.Guid
reason System.String
headers System.Collections.Generic.IDictionary{System.String,System.String}

CompleteMultipartUpload(spaceId,uploadId,parts) method

Section titled “CompleteMultipartUpload(spaceId,uploadId,parts) method”
Summary
Section titled “Summary”

Mark the multipart file upload status to be completed

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
uploadId System.Guid The upload ID
parts System.Collections.Generic.IEnumerable{TrimbleCloud.FileService.Models.FilePart} List of parts that are uploaded

Copy(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) method

Section titled “Copy(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) method”
Summary
Section titled “Summary”

Copy a file to a new location within the same space

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
name System.String The new name of the copied file. If not specified, the file will be copied with its original name
includeSupportFiles System.Boolean Copy support files and links along with the files
overwriteExisting System.Boolean Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

Copy(copyFileRequest) method

Section titled “Copy(copyFileRequest) method”
Summary
Section titled “Summary”

Copy a file to a new location within the same space

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
copyFileRequest TrimbleCloud.FileService.Models.CopyFileRequest

CopyWithMinimalResponse(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) method

Section titled “CopyWithMinimalResponse(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) method”
Summary
Section titled “Summary”

Copy a file to a new location within the same space and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
name System.String The new name of the copied file. If not specified, the file will be copied with its original name
includeSupportFiles System.Boolean Copy support files and links along with the file
overwriteExisting System.Boolean Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

CopyWithMinimalResponse(copyFileRequest) method

Section titled “CopyWithMinimalResponse(copyFileRequest) method”
Summary
Section titled “Summary”

Copy a file to a new location within the same space and get minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
copyFileRequest TrimbleCloud.FileService.Models.CopyFileRequest

Section titled “CreateFileUpload(spaceId,file,urlDuration,includeLinks) method”
Summary
Section titled “Summary”

Create a file upload

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
file TrimbleCloud.FileService.Models.FileUploadCreate The information of the file to create
urlDuration System.Nullable{System.TimeSpan} The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
includeLinks System.Boolean Whether to include the links from the last version during a parent file’s major version change.

Section titled “CreateFileUpload(spaceId,file,headers,urlDuration,includeLinks) method”
Summary
Section titled “Summary”

Create a file upload with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
file TrimbleCloud.FileService.Models.FileUploadCreate The information of the file to create
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
urlDuration System.Nullable{System.TimeSpan} The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
includeLinks System.Boolean Whether to include the links from the last version during a parent file’s major version change.

Section titled “CreateOrUpdateLinks(spaceId,fileId,fileMajorVersion,links) method”
Summary
Section titled “Summary”

Create or update support file links of a file

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
fileMajorVersion System.Int32 The major version of the file
links System.Collections.Generic.IDictionary{System.String,TrimbleCloud.FileService.Models.SupportFileLink} The links to create or update as dictionary of key and SupportFileLink

Section titled “CreateOrUpdateLinksWithMinimalResponse(spaceId,fileId,fileMajorVersion,links) method”
Summary
Section titled “Summary”

Create or update support file links of a file and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
fileMajorVersion System.Int32 The major version of the file
links System.Collections.Generic.IDictionary{System.String,TrimbleCloud.FileService.Models.SupportFileLink} The links to create or update as dictionary of key and SupportFileLink

CreatePackageUpload(spaceId,packageUpload,urlDuration) method

Section titled “CreatePackageUpload(spaceId,packageUpload,urlDuration) method”
Summary
Section titled “Summary”

Create a package upload

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
packageUpload TrimbleCloud.FileService.Models.PackageUploadCreate The information of the package upload to create
urlDuration System.Nullable{System.TimeSpan} The package upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreatePackageUpload(spaceId,packageUpload,headers,urlDuration) method

Section titled “CreatePackageUpload(spaceId,packageUpload,headers,urlDuration) method”
Summary
Section titled “Summary”

Create a package upload with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
packageUpload TrimbleCloud.FileService.Models.PackageUploadCreate The information of the package upload to create
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
urlDuration System.Nullable{System.TimeSpan} The package upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreateSupportFileUpload(spaceId,supportFile,urlDuration) method

Section titled “CreateSupportFileUpload(spaceId,supportFile,urlDuration) method”
Summary
Section titled “Summary”

Create a support file upload

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
supportFile TrimbleCloud.FileService.Models.SupportFileUploadCreate The information of the support file to create
urlDuration System.Nullable{System.TimeSpan} The support file’s upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreateSupportFileUpload(spaceId,supportFile,headers,urlDuration) method

Section titled “CreateSupportFileUpload(spaceId,supportFile,headers,urlDuration) method”
Summary
Section titled “Summary”

Create a support file upload with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
supportFile TrimbleCloud.FileService.Models.SupportFileUploadCreate The information of the support file to create
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
urlDuration System.Nullable{System.TimeSpan} The support file’s upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

Delete(spaceId,fileId,permanent) method

Section titled “Delete(spaceId,fileId,permanent) method”
Summary
Section titled “Summary”

Delete a file

Returns
Section titled “Returns”

A Task that resolves to possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
permanent System.Boolean Permanently delete the file

Delete(spaceId,fileId,headers,permanent) method

Section titled “Delete(spaceId,fileId,headers,permanent) method”
Summary
Section titled “Summary”

Delete a file with custom headers

Returns
Section titled “Returns”

A Task that resolves to possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
permanent System.Boolean Permanently delete the file

Download(spaceId,fileId,stream,chunkSize,maxConcurrentRequests) method

Section titled “Download(spaceId,fileId,stream,chunkSize,maxConcurrentRequests) method”
Summary
Section titled “Summary”

Downloads a file given the file ID

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
stream System.IO.Stream The stream to write content to
chunkSize System.Int32 The size of the chunks in bytes if provided; otherwise 15MB chunks are used
maxConcurrentRequests System.Int32 The number of concurrent download tasks if provided; otherwise 8 tasks are used

Download(spaceId,path,stream,chunkSize,maxConcurrentRequests) method

Section titled “Download(spaceId,path,stream,chunkSize,maxConcurrentRequests) method”
Summary
Section titled “Summary”

Downloads a file given the file path

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
stream System.IO.Stream The stream to write content to
chunkSize System.Int32 The size of the chunks in bytes if provided; otherwise 15MB chunks are used
maxConcurrentRequests System.Int32 The number of concurrent download tasks if provided; otherwise 8 tasks are used

Download(spaceId,fileId,stream,urlDuration,transferConfiguration) method

Section titled “Download(spaceId,fileId,stream,urlDuration,transferConfiguration) method”
Summary
Section titled “Summary”

Downloads a file given the file ID with custom URL duration

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
stream System.IO.Stream The stream to write content to
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
transferConfiguration TrimbleCloud.FileService.Models.TransferFileConfiguration Chunk size and concurrency for the transfer.

Download(spaceId,path,stream,urlDuration,transferConfiguration) method

Section titled “Download(spaceId,path,stream,urlDuration,transferConfiguration) method”
Summary
Section titled “Summary”

Downloads a file given the file path with custom URL duration

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
stream System.IO.Stream The stream to write content to
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
transferConfiguration TrimbleCloud.FileService.Models.TransferFileConfiguration Chunk size and concurrency for the transfer.

Get(spaceId,fileId,status,urlDuration,responseContentType) method

Section titled “Get(spaceId,fileId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get a file given the file ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

Get(spaceId,path,status,urlDuration,responseContentType) method

Section titled “Get(spaceId,path,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get a file given the file path

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetUploadDetails(spaceId,uploadId,urlDuration) method

Section titled “GetUploadDetails(spaceId,uploadId,urlDuration) method”
Summary
Section titled “Summary”

Get details of the upload

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
uploadId System.Guid The upload ID
urlDuration System.Nullable{System.TimeSpan} The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

GetUploadDetails(spaceId,uploadId,queryParams) method

Section titled “GetUploadDetails(spaceId,uploadId,queryParams) method”
Summary
Section titled “Summary”

Get details of the upload

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
uploadId System.Guid
queryParams TrimbleCloud.FileService.Models.GetUploadDetailsQueryParams

GetVersion(spaceId,fileId,versionId,status,urlDuration,responseContentType) method

Section titled “GetVersion(spaceId,fileId,versionId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get file version details given the file ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
versionId System.String The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersion(spaceId,path,versionId,status,urlDuration,responseContentType) method

Section titled “GetVersion(spaceId,path,versionId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get file version details given the file path

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
versionId System.String The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersionWithMinimalResponse(spaceId,fileId,versionId,status,urlDuration,responseContentType) method

Section titled “GetVersionWithMinimalResponse(spaceId,fileId,versionId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get file version details given the file ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
versionId System.String The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersionWithMinimalResponse(spaceId,path,versionId,status,urlDuration,responseContentType) method

Section titled “GetVersionWithMinimalResponse(spaceId,path,versionId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get file version details given the file path with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
versionId System.String The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetWithMinimalResponse(spaceId,fileId,status,urlDuration,responseContentType) method

Section titled “GetWithMinimalResponse(spaceId,fileId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get a file given the file ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetWithMinimalResponse(spaceId,path,status,urlDuration,responseContentType) method

Section titled “GetWithMinimalResponse(spaceId,path,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

Get a file given the file path with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
status TrimbleCloud.FileService.Models.ResourceStatus The status of the file
urlDuration System.Nullable{System.TimeSpan} The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType System.String Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

ListManifestFiles(spaceId,fileId,nextPageToken,maxItems,urlDuration) method

Section titled “ListManifestFiles(spaceId,fileId,nextPageToken,maxItems,urlDuration) method”
Summary
Section titled “Summary”

Lists all files from inside the unpacked fileset.

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
fileId System.Guid
nextPageToken System.String
maxItems System.Int32
urlDuration System.Nullable{System.TimeSpan}

ListSupportFiles(spaceId,fileId,nextPageToken,maxItems,listFilter) method

Section titled “ListSupportFiles(spaceId,fileId,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all support files for a file given the file ID

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListSupportFiles(spaceId,path,nextPageToken,maxItems,listFilter) method

Section titled “ListSupportFiles(spaceId,path,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all support files for a file given the file path

Returns
Section titled “Returns”

A Task that resolves toIPage`1 that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListSupportFilesWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) method

Section titled “ListSupportFilesWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all support files for a file given the file ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListSupportFilesWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) method

Section titled “ListSupportFilesWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all support files for a file given the file path with minimal response

Returns
Section titled “Returns”

A Task that resolves toIPage`1 that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListVersions(spaceId,fileId,nextPageToken,maxItems,listFilter) method

Section titled “ListVersions(spaceId,fileId,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all versions for a file given the file ID

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListVersions(spaceId,path,nextPageToken,maxItems,listFilter) method

Section titled “ListVersions(spaceId,path,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all versions for a file given the file path

Returns
Section titled “Returns”

A Task that resolves to IPage that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListVersionsWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) method

Section titled “ListVersionsWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all versions for a file given the file ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) method

Section titled “ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) method”
Summary
Section titled “Summary”

List all versions for a file given the file with minimal response

Returns
Section titled “Returns”

A Task that resolves to IPage that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The file path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list

Lock(spaceId,fileId,reason) method

Section titled “Lock(spaceId,fileId,reason) method”
Summary
Section titled “Summary”

Lock a file

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
reason System.String Reason for locking the file

Lock(spaceId,fileId,headers,reason) method

Section titled “Lock(spaceId,fileId,headers,reason) method”
Summary
Section titled “Summary”

Lock a file with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
reason System.String Reason for locking the file

LockWithMinimalResponse(spaceId,fileId,reason) method

Section titled “LockWithMinimalResponse(spaceId,fileId,reason) method”
Summary
Section titled “Summary”

Lock a file and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
reason System.String Reason for locking the file

LockWithMinimalResponse(spaceId,fileId,headers,reason) method

Section titled “LockWithMinimalResponse(spaceId,fileId,headers,reason) method”
Summary
Section titled “Summary”

Lock a file and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
reason System.String Reason for locking the file

Move(spaceId,fileId,targetParentId,name) method

Section titled “Move(spaceId,fileId,targetParentId,name) method”
Summary
Section titled “Summary”

Move a file to a new location within the same space

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
name System.String The new name of the file. If not specified, the file will be moved with its original name

Move(spaceId,fileId,targetParentId,headers,name) method

Section titled “Move(spaceId,fileId,targetParentId,headers,name) method”
Summary
Section titled “Summary”

Move a file to a new location within the same space with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
name System.String The new name of the file. If not specified, the file will be moved with its original name

MoveWithMinimalResponse(spaceId,fileId,targetParentId,name) method

Section titled “MoveWithMinimalResponse(spaceId,fileId,targetParentId,name) method”
Summary
Section titled “Summary”

Move a file to a new location within the same space and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
name System.String The new name of the file. If not specified, the file will be moved with its original name

MoveWithMinimalResponse(spaceId,fileId,targetParentId,headers,name) method

Section titled “MoveWithMinimalResponse(spaceId,fileId,targetParentId,headers,name) method”
Summary
Section titled “Summary”

Move a file to a new location within the same space and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
targetParentId System.Guid The target parent ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
name System.String The new name of the file. If not specified, the file will be moved with its original name

PollForMalwareScanCompletion(spaceId,fileId,timeout,interval,callback) method

Section titled “PollForMalwareScanCompletion(spaceId,fileId,timeout,interval,callback) method”
Summary
Section titled “Summary”

Poll for malware scan completion

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
timeout System.Nullable{System.TimeSpan} The maximum time to listen for the malware scan. Default is 3 minutes
interval System.Nullable{System.TimeSpan} The time interval to poll the malware scan status. Default is 5 seconds
callback System.Action{System.Nullable{TrimbleCloud.FileService.Models.MalwareScanStatus}} The callback to be called after each check

Rename(spaceId,fileId,name) method

Section titled “Rename(spaceId,fileId,name) method”
Summary
Section titled “Summary”

Rename a file with a new name

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the file

Rename(spaceId,fileId,name,headers) method

Section titled “Rename(spaceId,fileId,name,headers) method”
Summary
Section titled “Summary”

Rename a file with a new name with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the file
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers

RenameWithMinimalResponse(spaceId,fileId,name) method

Section titled “RenameWithMinimalResponse(spaceId,fileId,name) method”
Summary
Section titled “Summary”

Rename a file with a new name and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the file

RenameWithMinimalResponse(spaceId,fileId,name,headers) method

Section titled “RenameWithMinimalResponse(spaceId,fileId,name,headers) method”
Summary
Section titled “Summary”

Rename a file with a new name and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the file
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers

Restore(spaceId,fileId,name,targetParentId) method

Section titled “Restore(spaceId,fileId,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a file and any support files linked to it from the deleted state

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the file to. If not specified, the file will be restored to its original location

Restore(spaceId,fileId,headers,name,targetParentId) method

Section titled “Restore(spaceId,fileId,headers,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a file and any support files linked to it from the deleted state with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
name System.String The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the file to. If not specified, the file will be restored to its original location

RestoreWithMinimalResponse(spaceId,fileId,name,targetParentId) method

Section titled “RestoreWithMinimalResponse(spaceId,fileId,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a file and any support files linked to it from the deleted state and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
name System.String The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the file to. If not specified, the file will be restored to its original location

RestoreWithMinimalResponse(spaceId,fileId,headers,name,targetParentId) method

Section titled “RestoreWithMinimalResponse(spaceId,fileId,headers,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a file and any support files linked to it from the deleted state and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers
name System.String The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the file to. If not specified, the file will be restored to its original location

Unlock(spaceId,fileId) method

Section titled “Unlock(spaceId,fileId) method”
Summary
Section titled “Summary”

Unlock a file

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID

UnlockWithMinimalResponse(spaceId,fileId) method

Section titled “UnlockWithMinimalResponse(spaceId,fileId) method”
Summary
Section titled “Summary”

Unlock a file and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID

Update(spaceId,fileId,file) method

Section titled “Update(spaceId,fileId,file) method”
Summary
Section titled “Summary”

Update a file given the file ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
file TrimbleCloud.FileService.Models.FileUpdate The file information to update

Update(spaceId,fileId,file,headers) method

Section titled “Update(spaceId,fileId,file,headers) method”
Summary
Section titled “Summary”

Update a file given the file ID with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains File data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
file TrimbleCloud.FileService.Models.FileUpdate The file information to update
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers

UpdateWithMinimalResponse(spaceId,fileId,file) method

Section titled “UpdateWithMinimalResponse(spaceId,fileId,file) method”
Summary
Section titled “Summary”

Update a file given the file ID and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
file TrimbleCloud.FileService.Models.FileUpdate The file information to update

UpdateWithMinimalResponse(spaceId,fileId,file,headers) method

Section titled “UpdateWithMinimalResponse(spaceId,fileId,file,headers) method”
Summary
Section titled “Summary”

Update a file given the file ID and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFile data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
fileId System.Guid The file ID
file TrimbleCloud.FileService.Models.FileUpdate The file information to update
headers System.Collections.Generic.IDictionary{System.String,System.String} Dictionary of custom headers

Upload(request,chunkSize,maxConcurrentRequests) method

Section titled “Upload(request,chunkSize,maxConcurrentRequests) method”
Summary
Section titled “Summary”

Upload a file

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
request TrimbleCloud.FileService.Models.UploadRequest The upload request
chunkSize System.Int32 The size of the chunks in bytes if provided; otherwise 15MB chunks are used
maxConcurrentRequests System.Int32 The number of concurrent upload tasks if provided; otherwise 8 tasks are used

Upload(request,chunkSize,maxConcurrentRequests) method

Section titled “Upload(request,chunkSize,maxConcurrentRequests) method”
Summary
Section titled “Summary”

Upload a package

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
request TrimbleCloud.FileService.Models.PackageUploadRequest The package upload request
chunkSize System.Int32 The size of the chunks in bytes if provided; otherwise 15MB chunks are used
maxConcurrentRequests System.Int32 The number of concurrent upload tasks if provided; otherwise 8 tasks are used

Upload(uploadDetails,stream,transferConfiguration) method

Section titled “Upload(uploadDetails,stream,transferConfiguration) method”
Summary
Section titled “Summary”

Upload a file using pre-fetched upload details

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
uploadDetails TrimbleCloud.FileService.Models.UploadDetails The pre-fetched upload details
stream System.IO.Stream The file stream to upload
transferConfiguration TrimbleCloud.FileService.Models.TransferFileConfiguration Chunk size and concurrency for the transfer.

Upload(uploadDetails,mainFileStream,supportFiles,transferConfiguration) method

Section titled “Upload(uploadDetails,mainFileStream,supportFiles,transferConfiguration) method”
Summary
Section titled “Summary”

Upload a package using pre-fetched upload details

Returns
Section titled “Returns”

A Task that resolves to completion

Parameters
Section titled “Parameters”
Name Type Description
uploadDetails TrimbleCloud.FileService.Models.UploadDetails The pre-fetched upload details
mainFileStream System.IO.Stream The main file stream to upload
supportFiles System.Collections.Generic.IList{TrimbleCloud.FileService.Models.SupportFileResourceUploadItem} The support files to upload
transferConfiguration TrimbleCloud.FileService.Models.TransferFileConfiguration Chunk size and concurrency for the transfer.

WaitForUpload(spaceId,uploadId,timeout,interval,callback) method

Section titled “WaitForUpload(spaceId,uploadId,timeout,interval,callback) method”
Summary
Section titled “Summary”

Waits for upload to finish

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
uploadId System.Guid The upload ID
timeout System.Nullable{System.TimeSpan} The maximum time to wait for the upload to finish. Default is 3 minutes
interval System.Nullable{System.TimeSpan} The time interval to poll the upload status. Default is 5 seconds
callback System.Action{TrimbleCloud.FileService.Models.UploadDetails} The callback to be called after each check

WaitForUpload(spaceId,uploadId,urlDuration,timeout,interval,callback) method

Section titled “WaitForUpload(spaceId,uploadId,urlDuration,timeout,interval,callback) method”
Summary
Section titled “Summary”

Waits for upload to finish with custom URL duration

Returns
Section titled “Returns”

A Task that resolves to Response that contains UploadDetails data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
uploadId System.Guid The upload ID
urlDuration System.Nullable{System.TimeSpan} The upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
timeout System.Nullable{System.TimeSpan} The maximum time to wait for the upload to finish. Default is 3 minutes
interval System.Nullable{System.TimeSpan} The time interval to poll the upload status. Default is 5 seconds
callback System.Action{TrimbleCloud.FileService.Models.UploadDetails} The callback to be called after each check

IFoldersAPI type

Section titled “IFoldersAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Folders API

CheckInFolder(spaceId,folderId) method

Section titled “CheckInFolder(spaceId,folderId) method”
Summary
Section titled “Summary”

Checking in a folder will allow other actors to create a new version or perform other mutation operations

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderId System.Guid

CheckInFolderWithMinimalResponse(spaceId,folderId) method

Section titled “CheckInFolderWithMinimalResponse(spaceId,folderId) method”
Summary
Section titled “Summary”

Checkin a folder with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderId System.Guid

CheckOutFolder(spaceId,folderId,reason,headers) method

Section titled “CheckOutFolder(spaceId,folderId,reason,headers) method”
Summary
Section titled “Summary”

Checking out a folder will prevent other actors from creating a new version or other mutation operations

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderId System.Guid
reason System.String
headers System.Collections.Generic.IDictionary{System.String,System.String}

CheckOutFolderWithMinimalResponse(spaceId,folderId,reason,headers) method

Section titled “CheckOutFolderWithMinimalResponse(spaceId,folderId,reason,headers) method”
Summary
Section titled “Summary”

Checkout a folder with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderId System.Guid
reason System.String
headers System.Collections.Generic.IDictionary{System.String,System.String}

Copy(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting) method

Section titled “Copy(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting) method”
Summary
Section titled “Summary”

Copy a folder to a new location within the same space

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.String The new name of the copied folder. If not specified, the folder will be copied with its original name
includeSupportFiles System.Boolean Copy support files and links along with the files
overwriteExisting System.Boolean Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

Copy(copyFolderRequest) method

Section titled “Copy(copyFolderRequest) method”
Summary
Section titled “Summary”

Copy a folder and its children to a new location within the same space

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
copyFolderRequest TrimbleCloud.FileService.Models.CopyFolderRequest

CopyWithMinimalResponse(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting) method

Section titled “CopyWithMinimalResponse(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting) method”
Summary
Section titled “Summary”

Copy a folder to a new location within the same space and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.String The new name of the copied folder. If not specified, the folder will be copied with its original name
includeSupportFiles System.Boolean Copy support files and links along with the files
overwriteExisting System.Boolean Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

CopyWithMinimalResponse(copyFolderRequest) method

Section titled “CopyWithMinimalResponse(copyFolderRequest) method”
Summary
Section titled “Summary”

Copy a folder and its children to a new location within the same space with custom headers

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
copyFolderRequest TrimbleCloud.FileService.Models.CopyFolderRequest

Create(spaceId,folder) method

Section titled “Create(spaceId,folder) method”
Summary
Section titled “Summary”

Create a folder

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folder TrimbleCloud.FileService.Models.FolderCreate The information of the folder to create

CreateBatch(spaceId,folderRequest) method

Section titled “CreateBatch(spaceId,folderRequest) method”
Summary
Section titled “Summary”

Create folders in batch mode. This allows you to create multiple folders at once, including nested folders.

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderRequest TrimbleCloud.FileService.Models.BatchFolderCreate

CreateBatchWithMinimalResponse(spaceId,folderRequest) method

Section titled “CreateBatchWithMinimalResponse(spaceId,folderRequest) method”
Summary
Section titled “Summary”

Create folders in batch mode with minimal response. This allows you to create multiple folders at once, including nested folders.

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
folderRequest TrimbleCloud.FileService.Models.BatchFolderCreate

CreateWithMinimalResponse(spaceId,folder) method

Section titled “CreateWithMinimalResponse(spaceId,folder) method”
Summary
Section titled “Summary”

Create a folder and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folder TrimbleCloud.FileService.Models.FolderCreate The information of the folder to create

Delete(spaceId,folderId,recursive,permanent) method

Section titled “Delete(spaceId,folderId,recursive,permanent) method”
Summary
Section titled “Summary”

Delete a folder

Returns
Section titled “Returns”

A Task that resolves to possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
recursive System.Boolean Delete descendant folders and files
permanent System.Boolean Permanently delete the folder

Delete(spaceId,folderId,headers,recursive,permanent) method

Section titled “Delete(spaceId,folderId,headers,recursive,permanent) method”
Summary
Section titled “Summary”

Delete a folder with custom headers

Returns
Section titled “Returns”

A Task that resolves to possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request
recursive System.Boolean Delete descendant folders and files
permanent System.Boolean Permanently delete the folder

Get(spaceId,folderId,status) method

Section titled “Get(spaceId,folderId,status) method”
Summary
Section titled “Summary”

Get a folder given the folder ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

Get(spaceId,path,status) method

Section titled “Get(spaceId,path,status) method”
Summary
Section titled “Summary”

Get a folder given the folder path

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetVersion(spaceId,folderId,versionId,status) method

Section titled “GetVersion(spaceId,folderId,versionId,status) method”
Summary
Section titled “Summary”

Get folder version details given the folder ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
versionId System.Int32 The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetVersion(spaceId,path,versionId,status) method

Section titled “GetVersion(spaceId,path,versionId,status) method”
Summary
Section titled “Summary”

Get folder version details given the folder path

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
versionId System.Int32 The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetVersionWithMinimalResponse(spaceId,folderId,versionId,status) method

Section titled “GetVersionWithMinimalResponse(spaceId,folderId,versionId,status) method”
Summary
Section titled “Summary”

Get folder version details given the folder ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
versionId System.Int32 The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetVersionWithMinimalResponse(spaceId,path,versionId,status) method

Section titled “GetVersionWithMinimalResponse(spaceId,path,versionId,status) method”
Summary
Section titled “Summary”

Get folder version details given the folder path with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
versionId System.Int32 The version ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetWithMinimalResponse(spaceId,folderId,status) method

Section titled “GetWithMinimalResponse(spaceId,folderId,status) method”
Summary
Section titled “Summary”

Get a folder given the folder ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

GetWithMinimalResponse(spaceId,path,status) method

Section titled “GetWithMinimalResponse(spaceId,path,status) method”
Summary
Section titled “Summary”

Get a folder given the folder path with minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

ListChildren(spaceId,folderId,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) method

Section titled “ListChildren(spaceId,folderId,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) method”
Summary
Section titled “Summary”

List the children of a folder given the folder ID

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list
sortBy System.String
sortOrder System.String
recursive System.Boolean

ListChildren(spaceId,path,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) method

Section titled “ListChildren(spaceId,path,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) method”
Summary
Section titled “Summary”

List the children of a folder given the folder path

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
listFilter TrimbleCloud.FileService.Models.ListFilterCriteria The filter to apply to the list
sortBy System.String
sortOrder System.String
recursive System.Boolean

ListChildren(request) method

Section titled “ListChildren(request) method”
Summary
Section titled “Summary”

List the children of a folder using a request object. Either FolderId or Path must be specified in the request, but not both.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
request TrimbleCloud.FileService.Models.FolderListChildrenRequest The request object containing all parameters for listing children

ListVersions(spaceId,folderId,nextPageToken,maxItems,status) method

Section titled “ListVersions(spaceId,folderId,nextPageToken,maxItems,status) method”
Summary
Section titled “Summary”

List all versions for a folder in a space given the folder ID

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

ListVersions(spaceId,path,nextPageToken,maxItems,status) method

Section titled “ListVersions(spaceId,path,nextPageToken,maxItems,status) method”
Summary
Section titled “Summary”

List all versions for a folder in a space given the folder path

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

ListVersionsWithMinimalResponse(spaceId,folderId,nextPageToken,maxItems,status) method

Section titled “ListVersionsWithMinimalResponse(spaceId,folderId,nextPageToken,maxItems,status) method”
Summary
Section titled “Summary”

List all versions for a folder in a space given the folder ID with minimal response

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,status) method

Section titled “ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,status) method”
Summary
Section titled “Summary”

List all versions for a folder in a space given the folder path with minimal response

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
path System.String The folder path
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
status TrimbleCloud.FileService.Models.ResourceStatus The status of the folder

Move(spaceId,folderId,targetParentId,name) method

Section titled “Move(spaceId,folderId,targetParentId,name) method”
Summary
Section titled “Summary”

Move a folder to a new location within the same space

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.String

Move(spaceId,folderId,targetParentId,name,headers) method

Section titled “Move(spaceId,folderId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Move a folder to a new location within the same space with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.Collections.Generic.IDictionary{System.String,System.String}
headers System.String Custom HTTP headers to include in the request

MoveWithMinimalResponse(spaceId,folderId,targetParentId,name) method

Section titled “MoveWithMinimalResponse(spaceId,folderId,targetParentId,name) method”
Summary
Section titled “Summary”

Move a folder to a new location within the same space and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.String

MoveWithMinimalResponse(spaceId,folderId,targetParentId,name,headers) method

Section titled “MoveWithMinimalResponse(spaceId,folderId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Move a folder to a new location within the same space and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
targetParentId System.Guid The target parent ID
name System.Collections.Generic.IDictionary{System.String,System.String}
headers System.String Custom HTTP headers to include in the request

Rename(spaceId,folderId,name) method

Section titled “Rename(spaceId,folderId,name) method”
Summary
Section titled “Summary”

Rename a folder with a new name

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the folder

Rename(spaceId,folderId,name,headers) method

Section titled “Rename(spaceId,folderId,name,headers) method”
Summary
Section titled “Summary”

Rename a folder with a new name with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the folder
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request

RenameWithMinimalResponse(spaceId,folderId,name) method

Section titled “RenameWithMinimalResponse(spaceId,folderId,name) method”
Summary
Section titled “Summary”

Rename a folder with a new name and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the folder

RenameWithMinimalResponse(spaceId,folderId,name,headers) method

Section titled “RenameWithMinimalResponse(spaceId,folderId,name,headers) method”
Summary
Section titled “Summary”

Rename a folder with a new name and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the folder
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request

Restore(spaceId,folderId,name,targetParentId) method

Section titled “Restore(spaceId,folderId,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a folder and its children from the deleted state

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

Restore(spaceId,folderId,headers,name,targetParentId) method

Section titled “Restore(spaceId,folderId,headers,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a folder and its children from the deleted state with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request
name System.String The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

RestoreWithMinimalResponse(spaceId,folderId,name,targetParentId) method

Section titled “RestoreWithMinimalResponse(spaceId,folderId,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a folder and its children from the deleted state and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
name System.String The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

RestoreWithMinimalResponse(spaceId,folderId,headers,name,targetParentId) method

Section titled “RestoreWithMinimalResponse(spaceId,folderId,headers,name,targetParentId) method”
Summary
Section titled “Summary”

Restore a folder and its children from the deleted state and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request
name System.String The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId System.Nullable{System.Guid} The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

Update(spaceId,folderId,folder) method

Section titled “Update(spaceId,folderId,folder) method”
Summary
Section titled “Summary”

Update a folder

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
folder TrimbleCloud.FileService.Models.FolderUpdate The folder information to update

Update(spaceId,folderId,folder,headers) method

Section titled “Update(spaceId,folderId,folder,headers) method”
Summary
Section titled “Summary”

Update a folder with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains Folder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
folder TrimbleCloud.FileService.Models.FolderUpdate The folder information to update
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request

UpdateWithMinimalResponse(spaceId,folderId,folder) method

Section titled “UpdateWithMinimalResponse(spaceId,folderId,folder) method”
Summary
Section titled “Summary”

Update a folder and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
folder TrimbleCloud.FileService.Models.FolderUpdate The folder information to update

UpdateWithMinimalResponse(spaceId,folderId,folder,headers) method

Section titled “UpdateWithMinimalResponse(spaceId,folderId,folder,headers) method”
Summary
Section titled “Summary”

Update a folder and get minimal response with custom headers

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
folderId System.Guid The folder ID
folder TrimbleCloud.FileService.Models.FolderUpdate The folder information to update
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom HTTP headers to include in the request

IJobsAPI type

Section titled “IJobsAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Jobs API

Get(id) method

Section titled “Get(id) method”
Summary
Section titled “Summary”

Get a job given the job id

Returns
Section titled “Returns”

A Task that resolves to Response that contains Job data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The job id

Get(jobId,queryParams) method

Section titled “Get(jobId,queryParams) method”
Summary
Section titled “Summary”

Get a job given the job id

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
jobId System.Guid
queryParams TrimbleCloud.FileService.Models.GetJobQueryParams

WaitForJob(id,timeout,interval,callback) method

Section titled “WaitForJob(id,timeout,interval,callback) method”
Summary
Section titled “Summary”

Waits for job to finish

Returns
Section titled “Returns”

A Task that resolves to Response that contains Job data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The job id
timeout System.Nullable{System.TimeSpan} The maximum time to wait for the job to finish. Default is 3 minutes
interval System.Nullable{System.TimeSpan} The time interval to poll the job status. Default is 5 seconds
callback System.Action{TrimbleCloud.FileService.Models.Job} The callback function to be called when the job status is polled

IObjectTypesAPI type

Section titled “IObjectTypesAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for Object Types API.

Create(request) method

Section titled “Create(request) method”
Summary
Section titled “Summary”

Creates a new object type definition.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectType data on completion

Parameters
Section titled “Parameters”
Name Type Description
request TrimbleCloud.FileService.Models.ObjectTypeCreate The object type to create.
Exceptions
Section titled “Exceptions”
Name Description
TrimbleCloud.FileService.TrimbleServiceException Thrown when an API or network error occurs
System.ArgumentNullException Thrown when request is null

Get(objectTypeId) method

Section titled “Get(objectTypeId) method”
Summary
Section titled “Summary”

Gets an object type by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectType data on completion

Parameters
Section titled “Parameters”
Name Type Description
objectTypeId System.String The object type ID.
Exceptions
Section titled “Exceptions”
Name Description
TrimbleCloud.FileService.TrimbleServiceException Thrown when an API or network error occurs
System.ArgumentException Thrown when objectTypeId is null or empty

IObjectsAPI type

Section titled “IObjectsAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for Objects API. Objects are containers for external resources made accessible through Connect.

Checkin(spaceId,objectId) method

Section titled “Checkin(spaceId,objectId) method”
Summary
Section titled “Summary”

Checks in an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

Checkin(spaceId,objectId,headers) method

Section titled “Checkin(spaceId,objectId,headers) method”
Summary
Section titled “Summary”

Checks in an object by ID with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

CheckinWithMinimalResponse(spaceId,objectId) method

Section titled “CheckinWithMinimalResponse(spaceId,objectId) method”
Summary
Section titled “Summary”

Checks in an object by ID with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

CheckinWithMinimalResponse(spaceId,objectId,headers) method

Section titled “CheckinWithMinimalResponse(spaceId,objectId,headers) method”
Summary
Section titled “Summary”

Checks in an object by ID with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Checkout(spaceId,objectId,reason) method

Section titled “Checkout(spaceId,objectId,reason) method”
Summary
Section titled “Summary”

Checks out an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
reason System.String The reason for checkout.

Checkout(spaceId,objectId,reason,headers) method

Section titled “Checkout(spaceId,objectId,reason,headers) method”
Summary
Section titled “Summary”

Checks out an object by ID with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
reason System.String The reason for checkout.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

CheckoutWithMinimalResponse(spaceId,objectId,reason) method

Section titled “CheckoutWithMinimalResponse(spaceId,objectId,reason) method”
Summary
Section titled “Summary”

Checks out an object by ID with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
reason System.String The reason for checkout.

CheckoutWithMinimalResponse(spaceId,objectId,reason,headers) method

Section titled “CheckoutWithMinimalResponse(spaceId,objectId,reason,headers) method”
Summary
Section titled “Summary”

Checks out an object by ID with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
reason System.String The reason for checkout.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Create(spaceId,request) method

Section titled “Create(spaceId,request) method”
Summary
Section titled “Summary”

Creates a new object.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
request TrimbleCloud.FileService.Models.ObjectCreate The create object request.

CreateWithMinimalResponse(spaceId,request) method

Section titled “CreateWithMinimalResponse(spaceId,request) method”
Summary
Section titled “Summary”

Creates a new object with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
request TrimbleCloud.FileService.Models.ObjectCreate The create object request.

Delete(spaceId,objectId,permanent) method

Section titled “Delete(spaceId,objectId,permanent) method”
Summary
Section titled “Summary”

Deletes an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
permanent System.Boolean Whether to permanently delete the object.

Delete(spaceId,objectId,permanent,headers) method

Section titled “Delete(spaceId,objectId,permanent,headers) method”
Summary
Section titled “Summary”

Deletes an object by ID with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
permanent System.Boolean Whether to permanently delete the object.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Get(spaceId,objectId) method

Section titled “Get(spaceId,objectId) method”
Summary
Section titled “Summary”

Gets an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

Get(spaceId,objectId,parameters) method

Section titled “Get(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Gets an object by ID with parameters.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.GetObjectParams The get parameters.

Get(spaceId,objectPath) method

Section titled “Get(spaceId,objectPath) method”
Summary
Section titled “Summary”

Gets an object by path.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

Get(spaceId,objectPath,parameters) method

Section titled “Get(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Gets an object by path with parameters.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.GetObjectParams The get parameters.

GetVersion(spaceId,objectId,versionId) method

Section titled “GetVersion(spaceId,objectId,versionId) method”
Summary
Section titled “Summary”

Gets a specific version of an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
versionId System.Int32 The version ID.

GetVersion(spaceId,objectId,versionId,parameters) method

Section titled “GetVersion(spaceId,objectId,versionId,parameters) method”
Summary
Section titled “Summary”

Gets a specific version of an object by ID with parameters.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
versionId System.Int32 The version ID.
parameters TrimbleCloud.FileService.Models.GetObjectVersionParams The get parameters.

GetVersion(spaceId,objectPath,versionId) method

Section titled “GetVersion(spaceId,objectPath,versionId) method”
Summary
Section titled “Summary”

Gets a specific version of an object by path.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
versionId System.Int32 The version ID.

GetVersion(spaceId,objectPath,versionId,parameters) method

Section titled “GetVersion(spaceId,objectPath,versionId,parameters) method”
Summary
Section titled “Summary”

Gets a specific version of an object by path with parameters.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
versionId System.Int32 The version ID.
parameters TrimbleCloud.FileService.Models.GetObjectVersionParams The get parameters.

GetWithMinimalResponse(spaceId,objectId) method

Section titled “GetWithMinimalResponse(spaceId,objectId) method”
Summary
Section titled “Summary”

Gets an object by ID with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

GetWithMinimalResponse(spaceId,objectId,parameters) method

Section titled “GetWithMinimalResponse(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Gets an object by ID with parameters and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.GetObjectParams The get parameters.

GetWithMinimalResponse(spaceId,objectPath) method

Section titled “GetWithMinimalResponse(spaceId,objectPath) method”
Summary
Section titled “Summary”

Gets an object by path with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

GetWithMinimalResponse(spaceId,objectPath,parameters) method

Section titled “GetWithMinimalResponse(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Gets an object by path with parameters and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.GetObjectParams The get parameters.

LinkSupportFiles(spaceId,objectId,request) method

Section titled “LinkSupportFiles(spaceId,objectId,request) method”
Summary
Section titled “Summary”

Links support files to a specific object version and returns the full object entity.

Returns
Section titled “Returns”

A Task that resolves to Response`1 on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectLink The link request.

LinkSupportFilesWithMinimalResponse(spaceId,objectId,request) method

Section titled “LinkSupportFilesWithMinimalResponse(spaceId,objectId,request) method”
Summary
Section titled “Summary”

Links support files to an object and returns a minimal object entity.

Returns
Section titled “Returns”

A Task that resolves to Response`1 on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectLink The link request.

ListResources(spaceId,objectId) method

Section titled “ListResources(spaceId,objectId) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by ID.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of File on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

ListResources(spaceId,objectId,parameters) method

Section titled “ListResources(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by ID with parameters.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of File on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.ListObjectResourcesParams The list parameters.

ListResources(spaceId,objectPath) method

Section titled “ListResources(spaceId,objectPath) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by path.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of File on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

ListResources(spaceId,objectPath,parameters) method

Section titled “ListResources(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by path with parameters.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of File on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.ListObjectResourcesParams The list parameters.

ListResourcesWithMinimalResponse(spaceId,objectId) method

Section titled “ListResourcesWithMinimalResponse(spaceId,objectId) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by ID and returns a minimal file response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalFile on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

ListResourcesWithMinimalResponse(spaceId,objectId,parameters) method

Section titled “ListResourcesWithMinimalResponse(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by ID with parameters and returns a minimal file response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalFile on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.ListObjectResourcesParams The list parameters.

ListResourcesWithMinimalResponse(spaceId,objectPath) method

Section titled “ListResourcesWithMinimalResponse(spaceId,objectPath) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by path and returns a minimal file response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalFile on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

ListResourcesWithMinimalResponse(spaceId,objectPath,parameters) method

Section titled “ListResourcesWithMinimalResponse(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Lists resources (support files) for an object by path with parameters and returns a minimal file response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalFile on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.ListObjectResourcesParams The list parameters.

ListVersions(spaceId,objectId) method

Section titled “ListVersions(spaceId,objectId) method”
Summary
Section titled “Summary”

Lists all versions of an object by ID.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of ObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

ListVersions(spaceId,objectId,parameters) method

Section titled “ListVersions(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Lists all versions of an object by ID with parameters.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of ObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.ListObjectVersionsParams The list parameters.

ListVersions(spaceId,objectPath) method

Section titled “ListVersions(spaceId,objectPath) method”
Summary
Section titled “Summary”

Lists all versions of an object by path.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of ObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

ListVersions(spaceId,objectPath,parameters) method

Section titled “ListVersions(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Lists all versions of an object by path with parameters.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of ObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.ListObjectVersionsParams The list parameters.

ListVersionsWithMinimalResponse(spaceId,objectId) method

Section titled “ListVersionsWithMinimalResponse(spaceId,objectId) method”
Summary
Section titled “Summary”

Lists all versions of an object by ID with minimal response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.

ListVersionsWithMinimalResponse(spaceId,objectId,parameters) method

Section titled “ListVersionsWithMinimalResponse(spaceId,objectId,parameters) method”
Summary
Section titled “Summary”

Lists all versions of an object by ID with parameters and minimal response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
parameters TrimbleCloud.FileService.Models.ListObjectVersionsParams The list parameters.

ListVersionsWithMinimalResponse(spaceId,objectPath) method

Section titled “ListVersionsWithMinimalResponse(spaceId,objectPath) method”
Summary
Section titled “Summary”

Lists all versions of an object by path with minimal response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.

ListVersionsWithMinimalResponse(spaceId,objectPath,parameters) method

Section titled “ListVersionsWithMinimalResponse(spaceId,objectPath,parameters) method”
Summary
Section titled “Summary”

Lists all versions of an object by path with parameters and minimal response.

Returns
Section titled “Returns”

A Task that resolves to IPage`1 of MinimalObjectEntity on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectPath System.String The object path.
parameters TrimbleCloud.FileService.Models.ListObjectVersionsParams The list parameters.

Move(spaceId,objectId,targetParentId,name) method

Section titled “Move(spaceId,objectId,targetParentId,name) method”
Summary
Section titled “Summary”

Moves an object to a new location.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Guid The target parent folder ID.
name System.String The new name (optional).

Move(spaceId,objectId,targetParentId,name,headers) method

Section titled “Move(spaceId,objectId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Moves an object to a new location with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Guid The target parent folder ID.
name System.String The new name (optional).
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

MoveWithMinimalResponse(spaceId,objectId,targetParentId,name) method

Section titled “MoveWithMinimalResponse(spaceId,objectId,targetParentId,name) method”
Summary
Section titled “Summary”

Moves an object to a new location with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Guid The target parent folder ID.
name System.String The new name (optional).

MoveWithMinimalResponse(spaceId,objectId,targetParentId,name,headers) method

Section titled “MoveWithMinimalResponse(spaceId,objectId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Moves an object to a new location with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Guid The target parent folder ID.
name System.String The new name (optional).
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Rename(spaceId,objectId,name) method

Section titled “Rename(spaceId,objectId,name) method”
Summary
Section titled “Summary”

Renames an object.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
name System.String The new name.

Rename(spaceId,objectId,name,headers) method

Section titled “Rename(spaceId,objectId,name,headers) method”
Summary
Section titled “Summary”

Renames an object with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
name System.String The new name.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

RenameWithMinimalResponse(spaceId,objectId,name) method

Section titled “RenameWithMinimalResponse(spaceId,objectId,name) method”
Summary
Section titled “Summary”

Renames an object with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
name System.String The new name.

RenameWithMinimalResponse(spaceId,objectId,name,headers) method

Section titled “RenameWithMinimalResponse(spaceId,objectId,name,headers) method”
Summary
Section titled “Summary”

Renames an object with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
name System.String The new name.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Restore(spaceId,objectId,targetParentId,name) method

Section titled “Restore(spaceId,objectId,targetParentId,name) method”
Summary
Section titled “Summary”

Restores a deleted object.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Nullable{System.Guid} The target parent folder ID (optional).
name System.String The new name (optional).

Restore(spaceId,objectId,targetParentId,name,headers) method

Section titled “Restore(spaceId,objectId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Restores a deleted object with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Nullable{System.Guid} The target parent folder ID (optional).
name System.String The new name (optional).
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name) method

Section titled “RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name) method”
Summary
Section titled “Summary”

Restores a deleted object with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Nullable{System.Guid} The target parent folder ID (optional).
name System.String The new name (optional).

RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name,headers) method

Section titled “RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name,headers) method”
Summary
Section titled “Summary”

Restores a deleted object with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectJobResponse data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
targetParentId System.Nullable{System.Guid} The target parent folder ID (optional).
name System.String The new name (optional).
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

Update(spaceId,objectId,request) method

Section titled “Update(spaceId,objectId,request) method”
Summary
Section titled “Summary”

Updates an object by ID.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectUpdate The update request.

Update(spaceId,objectId,request,headers) method

Section titled “Update(spaceId,objectId,request,headers) method”
Summary
Section titled “Summary”

Updates an object by ID with custom headers.

Returns
Section titled “Returns”

A Task that resolves to Response that contains ObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectUpdate The update request.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

UpdateWithMinimalResponse(spaceId,objectId,request) method

Section titled “UpdateWithMinimalResponse(spaceId,objectId,request) method”
Summary
Section titled “Summary”

Updates an object by ID with minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectUpdate The update request.

UpdateWithMinimalResponse(spaceId,objectId,request,headers) method

Section titled “UpdateWithMinimalResponse(spaceId,objectId,request,headers) method”
Summary
Section titled “Summary”

Updates an object by ID with custom headers and minimal response.

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalObjectEntity data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID.
objectId System.Guid The object ID.
request TrimbleCloud.FileService.Models.ObjectUpdate The update request.
headers System.Collections.Generic.IDictionary{System.String,System.String} Custom headers (e.g., If-Match).

IPage`1 type

Section titled “IPage`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Defines a page interface in responses.

Generic Types
Section titled “Generic Types”
Name Description
T The type of the items in the page.

NextPageToken property

Section titled “NextPageToken property”
Summary
Section titled “Summary”

Gets the link to the next page.

IResourcesAPI type

Section titled “IResourcesAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for accessing resources in the Trimble Cloud File Service API.

BatchGet(spaceId,resourceIds,status,urlDuration,responseContentType) method

Section titled “BatchGet(spaceId,resourceIds,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

batch gets resources by their IDs or paths

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourceIds System.Collections.Generic.IList{System.Guid}
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

BatchGet(spaceId,resourcePaths,status,urlDuration,responseContentType) method

Section titled “BatchGet(spaceId,resourcePaths,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

batch gets resources by their paths

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourcePaths System.Collections.Generic.IList{System.String}
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

BatchGetWithMinimalResponse(spaceId,resourceIds,status,urlDuration,responseContentType) method

Section titled “BatchGetWithMinimalResponse(spaceId,resourceIds,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

batch gets resources by their IDs with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourceIds System.Collections.Generic.IList{System.Guid}
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

BatchGetWithMinimalResponse(spaceId,resourcePaths,status,urlDuration,responseContentType) method

Section titled “BatchGetWithMinimalResponse(spaceId,resourcePaths,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

batch gets resources by their paths with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourcePaths System.Collections.Generic.IList{System.String}
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

Get(spaceId,resourceId,status,urlDuration,responseContentType) method

Section titled “Get(spaceId,resourceId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

gets a resource by its ID

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourceId System.Guid
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

Get(spaceId,resourcePath,status,urlDuration,responseContentType) method

Section titled “Get(spaceId,resourcePath,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

gets a resource by its path

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourcePath System.String
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

GetWithMinimalResponse(spaceId,resourceId,status,urlDuration,responseContentType) method

Section titled “GetWithMinimalResponse(spaceId,resourceId,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

gets a resource by its ID with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourceId System.Guid
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

GetWithMinimalResponse(spaceId,resourcePath,status,urlDuration,responseContentType) method

Section titled “GetWithMinimalResponse(spaceId,resourcePath,status,urlDuration,responseContentType) method”
Summary
Section titled “Summary”

gets a resource by its path with minimal response

Returns
Section titled “Returns”
Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid
resourcePath System.String
status TrimbleCloud.FileService.Models.ResourceStatus
urlDuration System.Nullable{System.TimeSpan}
responseContentType System.String

ISpacesAPI type

Section titled “ISpacesAPI type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Interface for the Spaces API

Create(space) method

Section titled “Create(space) method”
Summary
Section titled “Summary”

Create a space

Returns
Section titled “Returns”

A Task that resolves to Response that contains Space data on completion

Parameters
Section titled “Parameters”
Name Type Description
space TrimbleCloud.FileService.Models.SpaceCreate The information of the space to create

CreateWithMinimalResponse(space) method

Section titled “CreateWithMinimalResponse(space) method”
Summary
Section titled “Summary”

Create a space and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalSpace data on completion

Parameters
Section titled “Parameters”
Name Type Description
space TrimbleCloud.FileService.Models.SpaceCreate The information of the space to create

Delete(id,recursive,permanent) method

Section titled “Delete(id,recursive,permanent) method”
Summary
Section titled “Summary”

Delete a space given the space ID

Returns
Section titled “Returns”

A Task that resolves to possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID
recursive System.Boolean Delete descendant folders and files
permanent System.Boolean Permanently delete the space

Get(id,status) method

Section titled “Get(id,status) method”
Summary
Section titled “Summary”

Get a space given the space ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains Space data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the space

GetWithMinimalResponse(id,status) method

Section titled “GetWithMinimalResponse(id,status) method”
Summary
Section titled “Summary”

Get a space with minimal response given the space ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalSpace data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID
status TrimbleCloud.FileService.Models.ResourceStatus The status of the space

ListChildren(spaceId,nextPageToken,maxItems,includeSupportFiles,listFilter,sortOrder) method

Section titled “ListChildren(spaceId,nextPageToken,maxItems,includeSupportFiles,listFilter,sortOrder) method”
Summary
Section titled “Summary”

List the children of a space given the space ID

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page
includeSupportFiles System.Boolean
listFilter TrimbleCloud.FileService.Models.SpaceListFilterCriteria The filter to apply to the list
sortOrder System.String

ListPublicResources(spaceId,nextPageToken,maxItems) method

Section titled “ListPublicResources(spaceId,nextPageToken,maxItems) method”
Summary
Section titled “Summary”

Get list of public resources in space with anonymous access

Returns
Section titled “Returns”

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters
Section titled “Parameters”
Name Type Description
spaceId System.Guid The space ID
nextPageToken System.String The token to retrieve the next page of items
maxItems System.Int32 The number of items to return in each page

Restore(id) method

Section titled “Restore(id) method”
Summary
Section titled “Summary”

Restore a deleted space, given the space ID, within 30 days of its deletion

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of Space data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID

RestoreWithMinimalResponse(id) method

Section titled “RestoreWithMinimalResponse(id) method”
Summary
Section titled “Summary”

Restore a deleted space given the space ID, within 30 days of its deletion and get minimal response

Returns
Section titled “Returns”

A Task that resolves to the a Tuple of Response of MinimalSpace data and possible JobId on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID

Update(id,space) method

Section titled “Update(id,space) method”
Summary
Section titled “Summary”

Update a space given the space ID

Returns
Section titled “Returns”

A Task that resolves to Response that contains Space data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID
space TrimbleCloud.FileService.Models.SpaceUpdate The space information to update

UpdateWithMinimalResponse(id,space) method

Section titled “UpdateWithMinimalResponse(id,space) method”
Summary
Section titled “Summary”

Update a space given the space ID and get minimal response

Returns
Section titled “Returns”

A Task that resolves to Response that contains MinimalSpace data on completion

Parameters
Section titled “Parameters”
Name Type Description
id System.Guid The space ID
space TrimbleCloud.FileService.Models.SpaceUpdate The space information to update

InheritedAcl type

Section titled “InheritedAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the actor role mapping for the resources that are inherited.

Actor property

Section titled “Actor property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

InheritedFrom property

Section titled “InheritedFrom property”
Summary
Section titled “Summary”

Indicates the source of the inherited permission.

InheritedFromTrn property

Section titled “InheritedFromTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the resource from which the permission is inherited.

Role property

Section titled “Role property”
Summary
Section titled “Summary”

The role assigned to the actor.

Versions property

Section titled “Versions property”
Summary
Section titled “Summary”

List of versions associated with this ACL entry.

InvalidFolderItem type

Section titled “InvalidFolderItem type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Invalid Folder Item

Code property

Section titled “Code property”
Summary
Section titled “Summary”

represents a error code that can be used for programmatic handling of the error

Detail property

Section titled “Detail property”
Summary
Section titled “Summary”

represents a detailed explanation of the error

Path property

Section titled “Path property”
Summary
Section titled “Summary”

Path of the invalid folder item

Status property

Section titled “Status property”
Summary
Section titled “Summary”

represents the HTTP status code for the error

Title property

Section titled “Title property”
Summary
Section titled “Summary”

represents a short, human-readable summary of the problem SERVICE_ERROR, API_ERROR etc.,

Type property

Section titled “Type property”
Summary
Section titled “Summary”

represents the type of error that occurred

InvalidResourceItem type

Section titled “InvalidResourceItem type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

api invalid resource item

Code property

Section titled “Code property”
Summary
Section titled “Summary”

represents a error code that can be used for programmatic handling of the error

Detail property

Section titled “Detail property”
Summary
Section titled “Summary”

represents a detailed explanation of the error

Id property

Section titled “Id property”
Summary
Section titled “Summary”

represents the unique identifier of the resource item

Status property

Section titled “Status property”
Summary
Section titled “Summary”

represents the HTTP status code for the error

Title property

Section titled “Title property”
Summary
Section titled “Summary”

represents a short, human-readable summary of the problem SERVICE_ERROR, API_ERROR etc.,

Type property

Section titled “Type property”
Summary
Section titled “Summary”

represents the type of error that occurred

Job type

Section titled “Job type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a job in File Service.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the job was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this job.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the job.

Message property

Section titled “Message property”
Summary
Section titled “Summary”

The message of the job.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the job.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status of the job.

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of job.

JobStatus type

Section titled “JobStatus type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The status of the job

Completed constants

Section titled “Completed constants”
Summary
Section titled “Summary”

Job completed

Failed constants

Section titled “Failed constants”
Summary
Section titled “Summary”

Job failed

Queued constants

Section titled “Queued constants”
Summary
Section titled “Summary”

Job queued

Running constants

Section titled “Running constants”
Summary
Section titled “Summary”

Job running

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown job status

JobType type

Section titled “JobType type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The type of job

Copy constants

Section titled “Copy constants”
Summary
Section titled “Summary”

Copy job

Delete constants

Section titled “Delete constants”
Summary
Section titled “Summary”

Delete job

Export constants

Section titled “Export constants”
Summary
Section titled “Summary”

Export job

FileDeletion constants

Section titled “FileDeletion constants”
Summary
Section titled “Summary”

File delete job

FileRestore constants

Section titled “FileRestore constants”
Summary
Section titled “Summary”

File restore job

FolderDeletion constants

Section titled “FolderDeletion constants”
Summary
Section titled “Summary”

Folder delete job

Move constants

Section titled “Move constants”
Summary
Section titled “Summary”

Move job

Rename constants

Section titled “Rename constants”
Summary
Section titled “Summary”

Rename job

Restore constants

Section titled “Restore constants”
Summary
Section titled “Summary”

Restore job

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown job type

Upload constants

Section titled “Upload constants”
Summary
Section titled “Summary”

Upload job

JsonRawStringConverter type

Section titled “JsonRawStringConverter type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

JSON converter that serializes a string property as a raw JSON object/array instead of a double-encoded JSON string, and deserializes a JSON object/array back into a compact JSON string.

Remarks
Section titled “Remarks”

The converter validates the string is valid JSON during serialization.

ReadJson() method

Section titled “ReadJson() method”
Summary
Section titled “Summary”

Reads a JSON object/array token and converts it to a compact JSON string.

Parameters
Section titled “Parameters”

This method has no parameters.

WriteJson() method

Section titled “WriteJson() method”
Summary
Section titled “Summary”

Validates the string is valid JSON, then writes it as a raw JSON object/array instead of as a double-encoded string.

Parameters
Section titled “Parameters”

This method has no parameters.

Exceptions
Section titled “Exceptions”
Name Description
Newtonsoft.Json.JsonSerializationException Thrown when the string is not valid JSON.

ListFilterBase type

Section titled “ListFilterBase type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Base class for list filters

ListFilterCriteria type

Section titled “ListFilterCriteria type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Criteria for filtering a list of files

Status property

Section titled “Status property”
Summary
Section titled “Summary”

Gets or sets the file status.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

Gets or sets the file URL duration.

ListObjectResourcesParams type

Section titled “ListObjectResourcesParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Parameters for listing object resources (support files).

NextPageToken property

Section titled “NextPageToken property”
Summary
Section titled “Summary”

The token for the next page of results.

PageSize property

Section titled “PageSize property”
Summary
Section titled “Summary”

The maximum number of items to return per page.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status filter for resources.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

The validity duration for download URLs.

GetQueryParameters() method

Section titled “GetQueryParameters() method”
Summary
Section titled “Summary”

Gets query parameters for the request.

Returns
Section titled “Returns”

Dictionary of query parameters

Parameters
Section titled “Parameters”

This method has no parameters.

ListObjectVersionsParams type

Section titled “ListObjectVersionsParams type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Parameters for listing object versions.

NextPageToken property

Section titled “NextPageToken property”
Summary
Section titled “Summary”

The token for the next page of results.

PageSize property

Section titled “PageSize property”
Summary
Section titled “Summary”

The maximum number of items to return per page.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status filter for objects.

GetQueryParameters() method

Section titled “GetQueryParameters() method”
Summary
Section titled “Summary”

Gets query parameters for the request.

Returns
Section titled “Returns”

Dictionary of query parameters

Parameters
Section titled “Parameters”

This method has no parameters.

ListQueryStringFormatter`1 type

Section titled “ListQueryStringFormatter`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

Query String Formatter

ToQueryString() method

Section titled “ToQueryString() method”
Summary
Section titled “Summary”

Convert the filter to query string

Parameters
Section titled “Parameters”

This method has no parameters.

Lock type

Section titled “Lock type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Contains the lock details of a file

LockedAt property

Section titled “LockedAt property”
Summary
Section titled “Summary”

The date and time when the file was locked.

LockedBy property

Section titled “LockedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that locked this file.

Reason property

Section titled “Reason property”
Summary
Section titled “Summary”

The reason for locking the file.

MalwareScanStatus type

Section titled “MalwareScanStatus type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the status of a malware scan.

CannotScan constants

Section titled “CannotScan constants”
Summary
Section titled “Summary”

File cannot be scanned

Clean constants

Section titled “Clean constants”
Summary
Section titled “Summary”

Malware scan clean

Failed constants

Section titled “Failed constants”
Summary
Section titled “Summary”

Malware scan failed

Infected constants

Section titled “Infected constants”
Summary
Section titled “Summary”

Malware scan infected

QueuedForScan constants

Section titled “QueuedForScan constants”
Summary
Section titled “Summary”

Malware scan queued

Scanning constants

Section titled “Scanning constants”
Summary
Section titled “Summary”

Malware scan scanning

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown malware scan status

Unscanned constants

Section titled “Unscanned constants”
Summary
Section titled “Summary”

File is unscanned

ManifestFile type

Section titled “ManifestFile type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

A manifest file from a fileset.

Download property

Section titled “Download property”
Summary
Section titled “Summary”

The download URL of the file.

MD5 property

Section titled “MD5 property”
Summary
Section titled “Summary”

MD5 hash of the file.

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The path where file is created.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the file in bytes.

MinimalFile type

Section titled “MinimalFile type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a minimal representation of a file.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this file.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the file.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier for the space where the file is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space where the file is stored.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the file, represented in a ‘major.minor’ format.

MinimalFolder type

Section titled “MinimalFolder type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a minimal representation of a folder.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this filespace.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the folder.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier of the space where the folder is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space where the folder is stored.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this filespace.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The folder version.

MinimalObjectEntity type

Section titled “MinimalObjectEntity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a minimal object entity response. Contains only essential fields for performance optimization.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this object.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the object.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier of the space in which the object is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space in which the object is stored.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this object.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the object. Whole numbers only (e.g., “1”, “2”, “3”).

MinimalObjectJobResponse type

Section titled “MinimalObjectJobResponse type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a minimal job response for object operations (move, rename, restore). Contains the job ID and minimal object details for performance optimization.

JobId property

Section titled “JobId property”
Summary
Section titled “Summary”

The job ID for tracking the async operation. Extracted from the Location header in the response.

Resource property

Section titled “Resource property”
Summary
Section titled “Summary”

The object resource with minimal details returned by the operation.

MinimalSpace type

Section titled “MinimalSpace type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a minimal representation of a filespace.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this filespace.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the space has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the filespace.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the filespace.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the filespace.

RootId property

Section titled “RootId property”
Summary
Section titled “Summary”

The unique identifier of the root folder.

RootTrn property

Section titled “RootTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the root folder.

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the resource.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this filespace.

MinimalSpaceList type

Section titled “MinimalSpaceList type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the minimal File or Folder including Space

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the children was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of children. Children can be a file or a folder.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the children.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The Resource Trn of the children

RootId property

Section titled “RootId property”
Summary
Section titled “Summary”

The unique identifier for the root

RootTrn property

Section titled “RootTrn property”
Summary
Section titled “Summary”

The Root Trn for the space

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier for the space where the file/folder is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The Space Trn for the space

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the children either it can be file or folder.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the children was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the children, represented in a ‘major.minor’ format.

ObjectAcl type

Section titled “ObjectAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the actor role mapping for object resources with version information.

AccessExpiresAt property

Section titled “AccessExpiresAt property”
Summary
Section titled “Summary”

Time when the actor’s access to the resource expires.

Actor property

Section titled “Actor property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

Role property

Section titled “Role property”
Summary
Section titled “Summary”

The role assigned to the actor.

Versions property

Section titled “Versions property”
Summary
Section titled “Summary”

List of versions associated with this ACL entry. For objects, versions are whole numbers (e.g., “1”, “2”, “3”).

ObjectCheckin type

Section titled “ObjectCheckin type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to checkin an object. Checking in an object releases the checkout and allows other actors to perform operations.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

ObjectCheckout type

Section titled “ObjectCheckout type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to checkout an object. Checking out an object prevents other actors from creating a new version or performing mutation operations.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

Reason property

Section titled “Reason property”
Summary
Section titled “Summary”

The reason for checkout (optional).

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

ObjectCreate type

Section titled “ObjectCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to create an object.

Content property

Section titled “Content property”
Summary
Section titled “Summary”

The content variables defined by the object type schema. This is a freeform JSON object that must conform to the schema defined by the object type.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

The metadata of the object.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the object.

ObjectTypeId property

Section titled “ObjectTypeId property”
Summary
Section titled “Summary”

The ID of the object type definition.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The folder or root ID in which the object resides.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions to be set on the object.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the object in bytes.

ObjectDelete type

Section titled “ObjectDelete type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to delete an object.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

Permanent property

Section titled “Permanent property”
Summary
Section titled “Summary”

Whether to permanently delete the object.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

ObjectEntity type

Section titled “ObjectEntity type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an object entity response. Objects are containers for resources stored outside of Connect but made accessible through Connect.

Actions property

Section titled “Actions property”
Summary
Section titled “Summary”

The actions available for this object, as defined by the object type. Actions define how users can interact with the object and its external resources.

Capabilities property

Section titled “Capabilities property”
Summary
Section titled “Summary”

The actions that can be performed on the resource by the current user.

Checkout property

Section titled “Checkout property”
Summary
Section titled “Summary”

Checkout attached to the object.

Content property

Section titled “Content property”
Summary
Section titled “Summary”

The content variables defined by the object type schema. This is a freeform JSON object that can contain any structure.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this object.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the entity has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the object was deleted, if applicable.

Section titled “Links property”
Summary
Section titled “Summary”

The support file links.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

The metadata of the object.

ObjectType property

Section titled “ObjectType property”
Summary
Section titled “Summary”

The name/identifier of the object type.

ObjectTypeId property

Section titled “ObjectTypeId property”
Summary
Section titled “Summary”

The ID of the object type definition.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The unique identifier of the parent folder.

ParentTrn property

Section titled “ParentTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the parent folder.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type.

Path property

Section titled “Path property”
Summary
Section titled “Summary”

The path of the object.

PermissionsEvaluated property

Section titled “PermissionsEvaluated property”
Summary
Section titled “Summary”

Permissions evaluated for the actors on the resource. It shows the most permissible role applicable for the actor, considering both the direct and inherited permissions.

PermissionsInherited property

Section titled “PermissionsInherited property”
Summary
Section titled “Summary”

Permissions inherited from the entire parent hierarchy applicable for the actor.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the object.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the object in bytes.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The unique identifier of the space in which the object is stored.

SpaceTrn property

Section titled “SpaceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the space in which the object is stored.

Statistics property

Section titled “Statistics property”
Summary
Section titled “Summary”

The statistics of the object.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this object.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the object. Whole numbers only (e.g., “1”, “2”, “3”).

ObjectJobResponse type

Section titled “ObjectJobResponse type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a job response for object operations (move, rename, restore). Contains the job ID for tracking async operations and the resulting object.

InvalidResources property

Section titled “InvalidResources property”
Summary
Section titled “Summary”

List of invalid resources encountered during the operation.

JobId property

Section titled “JobId property”
Summary
Section titled “Summary”

The job ID for tracking the async operation. Extracted from the Location header in the response.

Resource property

Section titled “Resource property”
Summary
Section titled “Summary”

The object resource returned by the operation.

Section titled “ObjectLink type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to link support files to an object.

Section titled “Links property”
Summary
Section titled “Summary”

The support file links to create or update. Key is the link name, value is the support file details.

ObjectMove type

Section titled “ObjectMove type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to move an object to a new location.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The new name for the object (optional). If not specified, the object retains its current name.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

TargetParentId property

Section titled “TargetParentId property”
Summary
Section titled “Summary”

The target parent folder ID.

ObjectPermissionsLocal type

Section titled “ObjectPermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions explicitly assigned to an object.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors, their roles, and version restrictions.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

ObjectRename type

Section titled “ObjectRename type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to rename an object.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The new name for the object.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

ObjectRestore type

Section titled “ObjectRestore type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to restore a deleted object.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The new name for the restored object (optional). If not specified, the object retains its original name.

ObjectId property

Section titled “ObjectId property”
Summary
Section titled “Summary”

The object ID.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space ID.

TargetParentId property

Section titled “TargetParentId property”
Summary
Section titled “Summary”

The target parent folder ID (optional). If not specified, the object is restored to its original location.

ObjectStatistics type

Section titled “ObjectStatistics type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Statistics about support files linked to an object.

SupportFilesCount property

Section titled “SupportFilesCount property”
Summary
Section titled “Summary”

The total count of support files.

SupportFilesSize property

Section titled “SupportFilesSize property”
Summary
Section titled “Summary”

The total size of all support files in bytes.

SupportFilesUpdatedAt property

Section titled “SupportFilesUpdatedAt property”
Summary
Section titled “Summary”

The date and time when the support files were last updated.

ObjectSupportFileDetails type

Section titled “ObjectSupportFileDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents support file details for linking to an object.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the support file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The major version of the object to link the support file to.

ObjectType type

Section titled “ObjectType type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an Object Type definition. Object Types define the schema, actions, and display configuration for objects. They act as blueprints that specify what data fields an object can have, how users can interact with objects, and how objects appear in Connect UI.

Actions property

Section titled “Actions property”
Summary
Section titled “Summary”

Actions configuration defining how users can interact with objects of this type. Actions are objects where each key is an action type and the value is an array of action definitions. Stored as a JSON string. Examples: Connect:download, Connect:actionMenu, Connect:displayComponent

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

Creation timestamp (ISO 8601 format). This field is required and automatically set by the server.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/application that created this object type. This field is required and automatically set by the server. Format: trn:2:fileservice:{region}:{resourceType}:{uuid}

DisplayName property

Section titled “DisplayName property”
Summary
Section titled “Summary”

The human-readable display name for the object type. Between 1-255 characters.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the object type.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The internal name/identifier for the object type. This is used to reference the object type. Must be between 1-255 characters.

Schema property

Section titled “Schema property”
Summary
Section titled “Summary”

JSON Schema defining the structure and validation for object content. This should be a valid JSON Schema (draft 2020-12 or compatible). Stored as a JSON string. Example: “{"type": "object", "properties": {…}, "required": […]}”

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

Last update timestamp (ISO 8601 format). Optional - may not be present if the object type has never been updated. Note: Update operations are not currently supported by the API.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/application that last updated this object type. Optional - may not be present if the object type has never been updated. Format: trn:2:fileservice:{region}:{resourceType}:{uuid} Note: Update operations are not currently supported by the API.

ObjectTypeCreate type

Section titled “ObjectTypeCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Request to create a new object type definition. Object types define the schema, actions, and display configuration for objects.

Actions property

Section titled “Actions property”
Summary
Section titled “Summary”

Actions configuration for objects of this type as a JSON string. Defines how users can interact with objects (e.g., download, view, custom menu items).

DisplayName property

Section titled “DisplayName property”
Summary
Section titled “Summary”

The human-readable display name for the object type.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The internal unique name/identifier for the object type.

Schema property

Section titled “Schema property”
Summary
Section titled “Summary”

JSON Schema defining the structure for object content as a JSON string. This should be a valid JSON Schema (draft 2020-12 or compatible).

ObjectUpdate type

Section titled “ObjectUpdate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to update an object.

Content property

Section titled “Content property”
Summary
Section titled “Summary”

The content variables defined by the object type schema.

Section titled “Links property”
Summary
Section titled “Summary”

The support file links.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

The metadata of the object.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the resource.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The size of the object in bytes.

ObjectUpdateAcl type

Section titled “ObjectUpdateAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to update object ACL.

Add property

Section titled “Add property”
Summary
Section titled “Summary”

Add new roles to the existing permissions on the resource. If an actor already has a permission on the resource and is included in the request again, their existing permissions will be replaced with the new ones specified.

Remove property

Section titled “Remove property”
Summary
Section titled “Summary”

The actors to be removed from the permissions.

ObjectUpdatePermissionsLocal type

Section titled “ObjectUpdatePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents permissions update request for an object. Either ReplaceAcl or UpdateAcl can be set, but not both.

Inherits property

Section titled “Inherits property”
Summary
Section titled “Summary”

Specifies if permissions are inherited from the parent folder.

ReplaceAcl property

Section titled “ReplaceAcl property”
Summary
Section titled “Summary”

Replace the entire ACL with this list of entries. Mutually exclusive with UpdateAcl.

UpdateAcl property

Section titled “UpdateAcl property”
Summary
Section titled “Summary”

Update specific ACL entries (add or remove actors). Mutually exclusive with ReplaceAcl.

ObjectUpdateSupportFileDetails type

Section titled “ObjectUpdateSupportFileDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents support file details for updating links on an object.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the support file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The major version of the object to link the support file to.

Output type

Section titled “Output type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Contains the download URL of an export.

Url property

Section titled “Url property”
Summary
Section titled “Summary”

The URL to download the export from.

PackageUploadCreate type

Section titled “PackageUploadCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a package upload creation.

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

Time period when the file object gets automatically removed. Must be at least 1 hour after the current time. Should not exceed 20 years from the current time.

Fileset property

Section titled “Fileset property”
Summary
Section titled “Summary”

Whether the object consists of a set of multiple files that should be treated as a single file.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the file.

Multipart property

Section titled “Multipart property”
Summary
Section titled “Summary”

True if the client will split the upload into multiple parts.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the file.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The parent folder identifier to which the file has to be uploaded.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

True if the download url of the file shouldn’t expire.

SupportFileResources property

Section titled “SupportFileResources property”
Summary
Section titled “Summary”

The support file resources.

PackageUploadRequest type

Section titled “PackageUploadRequest type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an upload request.

MainFileStream property

Section titled “MainFileStream property”
Summary
Section titled “Summary”

The file stream.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space identifier.

SupportFiles property

Section titled “SupportFiles property”
Summary
Section titled “Summary”

The support files.

UploadId property

Section titled “UploadId property”
Summary
Section titled “Summary”

The upload identifier.

Url property

Section titled “Url property”
Summary
Section titled “Summary”

The upload URL.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

The upload URL’s validity duration. If not specified, defaults to 60 minutes (or 2 days for files larger than 10GB).

Page`1 type

Section titled “Page`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Defines a page in responses.

Generic Types
Section titled “Generic Types”
Name Description
T Type of the page content items

Items property

Section titled “Items property”
Summary
Section titled “Summary”

The items in the page.

NextPageToken property

Section titled “NextPageToken property”
Summary
Section titled “Summary”

Gets the link to the next page.

GetEnumerator() method

Section titled “GetEnumerator() method”
Summary
Section titled “Summary”

Returns an enumerator that iterates through the collection.

Returns
Section titled “Returns”

A an enumerator that can be used to iterate through the collection.

Parameters
Section titled “Parameters”

This method has no parameters.

System#Collections#IEnumerable#GetEnumerator() method

Section titled “System#Collections#IEnumerable#GetEnumerator() method”
Summary
Section titled “Summary”

Returns an enumerator that iterates through the collection.

Returns
Section titled “Returns”

A an enumerator that can be used to iterate through the collection.

Parameters
Section titled “Parameters”

This method has no parameters.

ParentType type

Section titled “ParentType type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The type of parent

File constants

Section titled “File constants”
Summary
Section titled “Summary”

Parent is a file

Folder constants

Section titled “Folder constants”
Summary
Section titled “Summary”

Parent is a folder

Object constants

Section titled “Object constants”
Summary
Section titled “Summary”

Parent is an object

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown parent type

PermissionsEvaluated type

Section titled “PermissionsEvaluated type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions evaluated for the actors on the resource. It shows the most permissible role applicable for the actor, considering both the direct and inherited permissions.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors, their roles and the source of the inherited permission (if any).

PermissionsInherited type

Section titled “PermissionsInherited type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions inherited from the entire parent hierarchy applicable for the actor.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors, their roles and the source of the inherited permission.

Provider type

Section titled “Provider type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The cloud provider

AWS constants

Section titled “AWS constants”
Summary
Section titled “Summary”

Use AWS as the cloud provider

Azure constants

Section titled “Azure constants”
Summary
Section titled “Summary”

Use Azure as the cloud provider

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown cloud provider

ResourceBase type

Section titled “ResourceBase type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a resource of type File/Folder

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the file was created.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the file.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the file.

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the resource.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the file was last updated.

ResourceConverter type

Section titled “ResourceConverter type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

Utility class for converting resources in the File Service.

#ctor(complete) constructor

Section titled “#ctor(complete) constructor”
Summary
Section titled “Summary”

Constructor for ResourceConverter.

Parameters
Section titled “Parameters”
Name Type Description
complete System.Boolean

CanConvert() method

Section titled “CanConvert() method”
Summary
Section titled “Summary”

Determines whether this converter can convert the specified object type

Parameters
Section titled “Parameters”

This method has no parameters.

ReadJson() method

Section titled “ReadJson() method”
Summary
Section titled “Summary”

Reads JSON and converts it to a ResourceBase object based on the “type” field in the JSON

Parameters
Section titled “Parameters”

This method has no parameters.

WriteJson() method

Section titled “WriteJson() method”
Summary
Section titled “Summary”

Writes JSON from the specified value.

Parameters
Section titled “Parameters”

This method has no parameters.

ResourceListConverter type

Section titled “ResourceListConverter type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

Summary
Section titled “Summary”

converts a JSON array of resources into a list of ResourceBase objects.

#ctor(complete) constructor

Section titled “#ctor(complete) constructor”
Summary
Section titled “Summary”

Constructor for ResourceListConverter.

Parameters
Section titled “Parameters”
Name Type Description
complete System.Boolean

CanConvert() method

Section titled “CanConvert() method”
Summary
Section titled “Summary”

Determines whether this converter can convert the specified object type

Parameters
Section titled “Parameters”

This method has no parameters.

ReadJson() method

Section titled “ReadJson() method”
Summary
Section titled “Summary”

Reads JSON and converts to List

Parameters
Section titled “Parameters”

This method has no parameters.

WriteJson() method

Section titled “WriteJson() method”
Summary
Section titled “Summary”

Writes JSON from the specified value.

Parameters
Section titled “Parameters”

This method has no parameters.

ResourceNotFoundException type

Section titled “ResourceNotFoundException type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Exception thrown when a resource is not found

#ctor() constructor

Section titled “#ctor() constructor”
Summary
Section titled “Summary”

Initializes a new instance of the ResourceNotFoundException class.

Parameters
Section titled “Parameters”

This constructor has no parameters.

ResourceStatus type

Section titled “ResourceStatus type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the status of a resource.

Active constants

Section titled “Active constants”
Summary
Section titled “Summary”

Active resources

All constants

Section titled “All constants”
Summary
Section titled “Summary”

Both active and deleted resources

Deleted constants

Section titled “Deleted constants”
Summary
Section titled “Summary”

Deleted resources

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown resource status

ResourceType type

Section titled “ResourceType type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The type of resource

Export constants

Section titled “Export constants”
Summary
Section titled “Summary”

Export

File constants

Section titled “File constants”
Summary
Section titled “Summary”

File

Folder constants

Section titled “Folder constants”
Summary
Section titled “Summary”

Folder

Job constants

Section titled “Job constants”
Summary
Section titled “Summary”

Job

Object constants

Section titled “Object constants”
Summary
Section titled “Summary”

Object

Space constants

Section titled “Space constants”
Summary
Section titled “Summary”

Space

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown

Upload constants

Section titled “Upload constants”
Summary
Section titled “Summary”

Upload

Response type

Section titled “Response type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Represents a response.

ContentLength property

Section titled “ContentLength property”
Summary
Section titled “Summary”

Returns the content length of the HTTP response.

IsError property

Section titled “IsError property”
Summary
Section titled “Summary”

Indicates whether the status code of the returned response is considered an error code.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Get the HTTP response headers.

ReasonPhrase property

Section titled “ReasonPhrase property”
Summary
Section titled “Summary”

Gets the HTTP reason phrase.

RequestId property

Section titled “RequestId property”
Summary
Section titled “Summary”

Gets the client request id that was sent to the server as tcp-request-id headers.

ResponseContent property

Section titled “ResponseContent property”
Summary
Section titled “Summary”

Gets or sets the response content body.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

Gets the HTTP status code.

Dispose() method

Section titled “Dispose() method”
Summary
Section titled “Summary”

Frees resources held by this Response instance.

Parameters
Section titled “Parameters”

This method has no parameters.

Dispose(disposing) method

Section titled “Dispose(disposing) method”
Summary
Section titled “Summary”

Frees resources held by this Response instance.

Parameters
Section titled “Parameters”
Name Type Description
disposing System.Boolean True if called from Dispose(), false if called from finalizer

FromValue``1(value,response) method

Section titled “FromValue``1(value,response) method”
Summary
Section titled “Summary”

Creates a new instance of Response`1 with the provided value and HTTP response.

Returns
Section titled “Returns”

A new instance of Response`1 with the provided value and HTTP response.

Parameters
Section titled “Parameters”
Name Type Description
value ``0 The value.
response TrimbleCloud.FileService.Response The HTTP response.
Generic Types
Section titled “Generic Types”
Name Description
T The type of the value.

ToString() method

Section titled “ToString() method”
Summary
Section titled “Summary”

Returns the string representation of this Response.

Returns
Section titled “Returns”

The string representation of this Response

Parameters
Section titled “Parameters”

This method has no parameters.

Response`1 type

Section titled “Response`1 type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Represents a response.

Generic Types
Section titled “Generic Types”
Name Description
T The type of returned value.

Data property

Section titled “Data property”
Summary
Section titled “Summary”

Gets the value returned by the service. Accessing this property will throw if HasData is false.

HasData property

Section titled “HasData property”
Summary
Section titled “Summary”

Gets a value indicating whether the current instance has a valid value of its underlying type.

GetResponse() method

Section titled “GetResponse() method”
Summary
Section titled “Summary”

Get HTTP raw response

Parameters
Section titled “Parameters”

This method has no parameters.

op_Implicit(response) method

Section titled “op_Implicit(response) method”
Summary
Section titled “Summary”

Returns the value of this Response`1 object.

Parameters
Section titled “Parameters”
Name Type Description
response TrimbleCloud.FileService.Response{`0})~`0 The Response`1 instance.

Result type

Section titled “Result type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The input file information.

Message property

Section titled “Message property”
Summary
Section titled “Summary”

The additional information about the upload job. If the upload failed for any reason, the message will contain the error message.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status of the upload operation.

RetentionPeriod type

Section titled “RetentionPeriod type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the retention period for soft deleted resources in a filespace.

NeverDelete constants

Section titled “NeverDelete constants”
Summary
Section titled “Summary”

Never delete resources

OneYear constants

Section titled “OneYear constants”
Summary
Section titled “Summary”

Delete resources after 1 year

SixMonths constants

Section titled “SixMonths constants”
Summary
Section titled “Summary”

Delete resources after 180 days

ThirtyDays constants

Section titled “ThirtyDays constants”
Summary
Section titled “Summary”

Delete resources after 30 days

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown retention period

Space type

Section titled “Space type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a filespace in File Service.

AccountId property

Section titled “AccountId property”
Summary
Section titled “Summary”

The unique identifier of the IAM account.

AllowAnonymousShares property

Section titled “AllowAnonymousShares property”
Summary
Section titled “Summary”

Flag to allow anonymous access to resources in this space. When enabled, resources with anonymous ACL permissions (AclCustomIdentity(“anonymous”) with LimitedViewer role) can be accessed without authentication.

Capabilities property

Section titled “Capabilities property”
Summary
Section titled “Summary”

The actions that can be performed on the resource by the current user.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this filespace.

Deleted property

Section titled “Deleted property”
Summary
Section titled “Summary”

True if the space has been deleted.

DeletedAt property

Section titled “DeletedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was deleted, if applicable.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the filespace.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the filespace.

PermissionsEvaluated property

Section titled “PermissionsEvaluated property”
Summary
Section titled “Summary”

Permissions evaluated for the actors on the resource. It shows the most permissible role applicable for the actor, considering both the direct and inherited permissions.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

Provider property

Section titled “Provider property”
Summary
Section titled “Summary”

The cloud provider of the space.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the filespace.

RootId property

Section titled “RootId property”
Summary
Section titled “Summary”

The unique identifier of the root folder.

RootTrn property

Section titled “RootTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the root folder.

SoftDeleteRetention property

Section titled “SoftDeleteRetention property”
Summary
Section titled “Summary”

Duration of soft deleted resources being retained before being permanently removed

SpaceMembershipBoundary property

Section titled “SpaceMembershipBoundary property”
Summary
Section titled “Summary”

The membership boundary configuration for the space. Defines group-based access controls and viewer permissions outside the boundary group.

Statistics property

Section titled “Statistics property”
Summary
Section titled “Summary”

The statistics of the space.

StorageMode property

Section titled “StorageMode property”
Summary
Section titled “Summary”

The storage mode of the space

StorageModeUpdatedAt property

Section titled “StorageModeUpdatedAt property”
Summary
Section titled “Summary”

The date and time when the storage mode was last updated.

StorageModeUpdatedBy property

Section titled “StorageModeUpdatedBy property”
Summary
Section titled “Summary”

The TRN of the user who last updated the storage mode

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the resource.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the filespace was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this filespace.

SpaceCreate type

Section titled “SpaceCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a filespace creation request.

AccountId property

Section titled “AccountId property”
Summary
Section titled “Summary”

The unique identifier of the IAM account.

AllowAnonymousShares property

Section titled “AllowAnonymousShares property”
Summary
Section titled “Summary”

Flag to allow anonymous access to resources in this space. When enabled, resources with anonymous ACL permissions (AclCustomIdentity(“anonymous”) with LimitedViewer role) can be accessed without authentication.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the filespace.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Permissions that are set directly for an actor on the resource itself.

Provider property

Section titled “Provider property”
Summary
Section titled “Summary”

The cloud provider where the filespace will be created. Supported values are ‘AWS’ and ‘Azure’. Default: ‘AWS’

SoftDeleteRetention property

Section titled “SoftDeleteRetention property”
Summary
Section titled “Summary”

Duration of soft deleted resources being retained before being permanently removed. Supported values are ‘ThirtyDays’, ‘SixMonths’, ‘OneYear’, ‘NeverDelete’. Default: ‘ThirtyDays’

SpaceMembershipBoundary property

Section titled “SpaceMembershipBoundary property”
Summary
Section titled “Summary”

The membership boundary configuration for the space. Defines group-based access controls and viewer permissions outside the boundary group.

SpaceListFilterCriteria type

Section titled “SpaceListFilterCriteria type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the criteria for filtering a list children of space.

ResourceType property

Section titled “ResourceType property”
Summary
Section titled “Summary”

Gets or sets the type of the Resource to filter by.

SinceTime property

Section titled “SinceTime property”
Summary
Section titled “Summary”

Gets or sets the time to filter the resources based on their last update time

Status property

Section titled “Status property”
Summary
Section titled “Summary”

Gets or sets the status of the space.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

Gets or sets the duration for which the space URL is valid.

SpaceMembershipBoundary type

Section titled “SpaceMembershipBoundary type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the membership boundary configuration for a space.

AllowLimitedViewerOutsideBoundaryGroup property

Section titled “AllowLimitedViewerOutsideBoundaryGroup property”
Summary
Section titled “Summary”

Indicates whether limited viewers outside the boundary group are allowed.

Group property

Section titled “Group property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the group that defines the membership boundary.

SpacePermissionsLocal type

Section titled “SpacePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the permissions explicitly assigned to a space.

Acl property

Section titled “Acl property”
Summary
Section titled “Summary”

The list of actors and their roles.

SpaceStatistics type

Section titled “SpaceStatistics type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents the statistics of a space.

ContentsUpdatedAt property

Section titled “ContentsUpdatedAt property”
Summary
Section titled “Summary”

The date and time when the contents of the space were last updated.

DeletedFilesCount property

Section titled “DeletedFilesCount property”
Summary
Section titled “Summary”

The count of all soft deleted files in the space.

DeletedFoldersCount property

Section titled “DeletedFoldersCount property”
Summary
Section titled “Summary”

The count of all soft deleted folders in the space.

DeletedSize property

Section titled “DeletedSize property”
Summary
Section titled “Summary”

The sum of sizes of all the soft deleted resources in the space in bytes.

DeletedSupportFilesSize property

Section titled “DeletedSupportFilesSize property”
Summary
Section titled “Summary”

The sum of sizes of all the soft deleted support files in the space in bytes.

FilesCount property

Section titled “FilesCount property”
Summary
Section titled “Summary”

The count of all active files in the space.

FoldersCount property

Section titled “FoldersCount property”
Summary
Section titled “Summary”

The count of all active folders in the space.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The sum of sizes of all the active resources in the space in bytes.

SupportFilesSize property

Section titled “SupportFilesSize property”
Summary
Section titled “Summary”

The sum of size of all the active support files in the space in bytes.

TotalStorageUsed property

Section titled “TotalStorageUsed property”
Summary
Section titled “Summary”

The total storage used by the space and its contents, including versions, in bytes.

SpaceUpdate type

Section titled “SpaceUpdate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a space update request.

AllowAnonymousShares property

Section titled “AllowAnonymousShares property”
Summary
Section titled “Summary”

Update flag to allow anonymous access to resources in this space. When enabled, resources with anonymous ACL permissions (AclCustomIdentity(“anonymous”) with LimitedViewer role) can be accessed without authentication.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

Update the name of the space.

PermissionsLocal property

Section titled “PermissionsLocal property”
Summary
Section titled “Summary”

Update the permissions on the space.

SoftDeleteRetention property

Section titled “SoftDeleteRetention property”
Summary
Section titled “Summary”

Update the duration of soft deleted resources being retained before being permanently removed. Supported values are ‘ThirtyDays’, ‘SixMonths’, ‘OneYear’, ‘NeverDelete’. Default: ‘ThirtyDays’

SpaceMembershipBoundary property

Section titled “SpaceMembershipBoundary property”
Summary
Section titled “Summary”

Update the membership boundary configuration for the space. Defines group-based access controls and viewer permissions outside the boundary group.

StorageMode property

Section titled “StorageMode property”
Summary
Section titled “Summary”

The storage mode of the space. Supported values are “active” (default - allows all operations) and “read-only” (restricts to read-only operations).

SpaceUpdateAcl type

Section titled “SpaceUpdateAcl type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a request to update space ACL.

Add property

Section titled “Add property”
Summary
Section titled “Summary”

Add new roles to the existing permissions on the resource. If an actor already has a permission on the resource and is included in the request again, their existing permissions will be replaced with the new ones specified.

Remove property

Section titled “Remove property”
Summary
Section titled “Summary”

The actors to be removed from the permissions.

SpaceUpdatePermissionsLocal type

Section titled “SpaceUpdatePermissionsLocal type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a space permissions update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

ReplaceAcl property

Section titled “ReplaceAcl property”
Summary
Section titled “Summary”

Completely replace the existing permissions on the resource. When this field is used, all previous permissions are overwritten by the new ones.

UpdateAcl property

Section titled “UpdateAcl property”
Summary
Section titled “Summary”

Add or remove roles to the existing permissions on the resource.

SupportFileDetails type

Section titled “SupportFileDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents support file details.

DownloadUrl property

Section titled “DownloadUrl property”
Summary
Section titled “Summary”

The download url of the support file.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the support file.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the support file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the support file.

Section titled “SupportFileLink type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents support file link.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the support file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The version of the support file.

SupportFileResource type

Section titled “SupportFileResource type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a support file resource for a package upload creation.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the support file.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the support file.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers can be set here.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

Set to false if the download url of the support file shouldn’t be expired. Whereas when true download url expiration takes place according to the configured value. Default: true

SupportFileKey property

Section titled “SupportFileKey property”
Summary
Section titled “Summary”

The key of the support file.

SupportFileResourceDetails type

Section titled “SupportFileResourceDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a support file resource details in package upload.

FileId property

Section titled “FileId property”
Summary
Section titled “Summary”

The support file ID.

FileTrn property

Section titled “FileTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the support file.

MD5 property

Section titled “MD5 property”
Summary
Section titled “Summary”

MD5 hash of the support file.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the support file.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the support file.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

True if the download url of the support file shouldn’t expire.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The support file size in bytes.

Status property

Section titled “Status property”
Summary
Section titled “Summary”

The status of the support file upload.

SupportFileKey property

Section titled “SupportFileKey property”
Summary
Section titled “Summary”

The key of the support file.

Upload property

Section titled “Upload property”
Summary
Section titled “Summary”

The upload URL and type of upload for the support file.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The support file version.

SupportFileResourceUploadItem type

Section titled “SupportFileResourceUploadItem type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a support file upload item.

SupportFileKey property

Section titled “SupportFileKey property”
Summary
Section titled “Summary”

The key of the support file.

SupportFileStream property

Section titled “SupportFileStream property”
Summary
Section titled “Summary”

The corresponding support file stream.

SupportFileUploadCreate type

Section titled “SupportFileUploadCreate type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents a support file creation request.

Section titled “AddToLinks property”
Summary
Section titled “Summary”

Whether the support file should be linked to the parent file

ExpiresAt property

Section titled “ExpiresAt property”
Summary
Section titled “Summary”

Time period when the file object gets automatically removed. Must be at least 1 hour after the current time. Should not exceed 20 years from the current time.

Metadata property

Section titled “Metadata property”
Summary
Section titled “Summary”

Additional information related to the file.

Multipart property

Section titled “Multipart property”
Summary
Section titled “Summary”

True if the client will split the upload into multiple parts.

Name property

Section titled “Name property”
Summary
Section titled “Summary”

The name of the file.

ParentId property

Section titled “ParentId property”
Summary
Section titled “Summary”

The parent folder identifier to which the file has to be uploaded.

ParentMajorVersion property

Section titled “ParentMajorVersion property”
Summary
Section titled “Summary”

Parent major version for support files.

ParentType property

Section titled “ParentType property”
Summary
Section titled “Summary”

The parent type. Defaults to File for support files linked to a file. Use Object when uploading support files for an object.

ResponseHeaders property

Section titled “ResponseHeaders property”
Summary
Section titled “Summary”

Download HTTP response headers.

RestrictedAccess property

Section titled “RestrictedAccess property”
Summary
Section titled “Summary”

True if the download url of the file shouldn’t expire.

SupportFileKey property

Section titled “SupportFileKey property”
Summary
Section titled “Summary”

The key of the support file

TransferFileConfiguration type

Section titled “TransferFileConfiguration type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Configuration for chunked file upload and download transfers.

ChunkSize property

Section titled “ChunkSize property”
Summary
Section titled “Summary”

The size of the chunks in bytes. Default is 15MB.

MaxConcurrentRequests property

Section titled “MaxConcurrentRequests property”
Summary
Section titled “Summary”

The number of concurrent upload or download tasks. Default is 8.

TrimbleServiceException type

Section titled “TrimbleServiceException type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService

Summary
Section titled “Summary”

Exception for Trimble service API errors

#ctor(message,response) constructor

Section titled “#ctor(message,response) constructor”
Summary
Section titled “Summary”

Constructor used by the SDK to create service exceptions with complete error information.

Parameters
Section titled “Parameters”
Name Type Description
message System.String Error message
response TrimbleCloud.FileService.Response Response object that led to the exception

#ctor() constructor

Section titled “#ctor() constructor”
Summary
Section titled “Summary”

Constructor used by the SDK to create service exceptions with complete error information.

Parameters
Section titled “Parameters”

This constructor has no parameters.

#ctor(message,response,innerException) constructor

Section titled “#ctor(message,response,innerException) constructor”
Summary
Section titled “Summary”

Constructor used by the SDK to create service exceptions with complete error information.

Parameters
Section titled “Parameters”
Name Type Description
message System.String Error message
response TrimbleCloud.FileService.Response Response object that led to the exception
innerException System.Exception Inner exception if any

#ctor(info,context) constructor

Section titled “#ctor(info,context) constructor”
Summary
Section titled “Summary”

Protected constructor for deserialization

Parameters
Section titled “Parameters”
Name Type Description
info System.Runtime.Serialization.SerializationInfo Serialization info
context System.Runtime.Serialization.StreamingContext Streaming context

_response constants

Section titled “_response constants”
Summary
Section titled “Summary”

Gets the response, if any, that led to the exception.

RequestId property

Section titled “RequestId property”
Summary
Section titled “Summary”

Gets the request ID for tracking and support purposes.

StatusCode property

Section titled “StatusCode property”
Summary
Section titled “Summary”

Gets the HTTP status code of the response. Returns 0 if response was not received.

GetObjectData() method

Section titled “GetObjectData() method”
Summary
Section titled “Summary”

Inherit from parent.

Parameters
Section titled “Parameters”

This method has no parameters.

GetRawResponse() method

Section titled “GetRawResponse() method”
Summary
Section titled “Summary”

Gets the response, if any, that led to the exception.

Returns
Section titled “Returns”

The response that caused this exception, or null if not available

Parameters
Section titled “Parameters”

This method has no parameters.

ToString() method

Section titled “ToString() method”
Summary
Section titled “Summary”

Returns a string representation of the exception

Returns
Section titled “Returns”

Formatted error message

Parameters
Section titled “Parameters”

This method has no parameters.

Upload type

Section titled “Upload type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Contains the upload URL and upload type of a file.

Type property

Section titled “Type property”
Summary
Section titled “Summary”

The type of the file upload URL.

Url property

Section titled “Url property”
Summary
Section titled “Summary”

The URL to upload the file to.

UploadDetails type

Section titled “UploadDetails type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an upload in File Service.

CreatedAt property

Section titled “CreatedAt property”
Summary
Section titled “Summary”

The date and time when the upload was created.

CreatedBy property

Section titled “CreatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that created this upload.

FileInputUploadDetails property

Section titled “FileInputUploadDetails property”
Summary
Section titled “Summary”

Describes the structure of a file.

Id property

Section titled “Id property”
Summary
Section titled “Summary”

The unique identifier of the upload.

MD5 property

Section titled “MD5 property”
Summary
Section titled “Summary”

MD5 hash of the file.

ResourceTrn property

Section titled “ResourceTrn property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the upload.

Result property

Section titled “Result property”
Summary
Section titled “Summary”

The input file information.

Size property

Section titled “Size property”
Summary
Section titled “Summary”

The file size in bytes.

SupportFileResources property

Section titled “SupportFileResources property”
Summary
Section titled “Summary”

The support file resources. Note: This field should be used only for package upload.

UpdatedAt property

Section titled “UpdatedAt property”
Summary
Section titled “Summary”

The date and time when the upload was last updated.

UpdatedBy property

Section titled “UpdatedBy property”
Summary
Section titled “Summary”

The TRN (Trimble Resource Name) of the user/device/application that last updated this upload.

Version property

Section titled “Version property”
Summary
Section titled “Summary”

The file version.

UploadRequest type

Section titled “UploadRequest type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

Represents an upload request.

SpaceId property

Section titled “SpaceId property”
Summary
Section titled “Summary”

The space identifier.

Stream property

Section titled “Stream property”
Summary
Section titled “Summary”

The file stream.

UploadId property

Section titled “UploadId property”
Summary
Section titled “Summary”

The upload identifier.

Url property

Section titled “Url property”
Summary
Section titled “Summary”

The upload URL.

UrlDuration property

Section titled “UrlDuration property”
Summary
Section titled “Summary”

The upload URL’s validity duration. If not specified, defaults to 60 minutes (or 2 days for files larger than 10GB).

UploadStatus type

Section titled “UploadStatus type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The status of the upload operation

Completed constants

Section titled “Completed constants”
Summary
Section titled “Summary”

The file upload is completed

Failed constants

Section titled “Failed constants”
Summary
Section titled “Summary”

The file upload is failed

Running constants

Section titled “Running constants”
Summary
Section titled “Summary”

The file is being uploaded

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown status

Uploadable constants

Section titled “Uploadable constants”
Summary
Section titled “Summary”

The file is uploadable

UploadType type

Section titled “UploadType type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Models

Summary
Section titled “Summary”

The type of the file upload URL

Multipart constants

Section titled “Multipart constants”
Summary
Section titled “Summary”

Multipart upload

Singlepart constants

Section titled “Singlepart constants”
Summary
Section titled “Summary”

Singlepart upload

Unknown constants

Section titled “Unknown constants”
Summary
Section titled “Summary”

Unknown type

Utility type

Section titled “Utility type”
Namespace
Section titled “Namespace”

TrimbleCloud.FileService.Utilities

ConvertUrlDuration(urlDuration) method

Section titled “ConvertUrlDuration(urlDuration) method”
Summary
Section titled “Summary”

Converts a TimeSpan to a string in the format “Xm” where X is the number of minutes in the TimeSpan

Returns
Section titled “Returns”

The string representation of the TimeSpan

Parameters
Section titled “Parameters”
Name Type Description
urlDuration System.Nullable{System.TimeSpan} The TimeSpan to convert to a string

ExtractExportId(input) method

Section titled “ExtractExportId(input) method”
Summary
Section titled “Summary”

Extracts a Guid representing the exportId from a string with the format “/spaces/{spaceId}/exports/{exportId}”.

Returns
Section titled “Returns”

The extracted exportId if the input is in the correct format and contains a valid Guid; otherwise, null.

Parameters
Section titled “Parameters”
Name Type Description
input System.String The input string from which the exportId should be extracted from.

ExtractJobId(input) method

Section titled “ExtractJobId(input) method”
Summary
Section titled “Summary”

Extracts a Guid representing the jobId from a string with the format “/jobs/{jobId}”.

Returns
Section titled “Returns”

The extracted Guid if the input is in the correct format and contains a valid Guid; otherwise, null.

Parameters
Section titled “Parameters”
Name Type Description
input System.String The input string from which to extract the jobId.

GetRetryPolicy(config) method

Section titled “GetRetryPolicy(config) method”
Summary
Section titled “Summary”

Gets retry policy for HTTP requests

Returns
Section titled “Returns”

The retry policy

Parameters
Section titled “Parameters”
Name Type Description
config TrimbleCloud.FileService.FileServiceClientConfig The configuration values

ToQueryString(parameters) method

Section titled “ToQueryString(parameters) method”
Summary
Section titled “Summary”

Converts a dictionary of parameters to a query string

Returns
Section titled “Returns”

The query string

Parameters
Section titled “Parameters”
Name Type Description
parameters System.Collections.Generic.IDictionary{System.String,System.String} The dictionary of parameters to convert to a query string