VolumeAccess

VolumeAccess` contains the means for accessing a certain Volume such as protocol, connectionOptions, credentials, …​

Many VolumeAccesses can exist for each Volume. It can give access to only part of the volume by means of the subFolderFromRoot property.

Property Reference

Field Name Required Type Description Format

activeStatus

String

Enum: Active, Archived,

availableAllProductions

Boolean

connectionOptions

Object

created

Date

The time when this resource was created

date-time

createdBy

String

The request or process that created this resource

credentials

Object

handle

String

id

Long

The id of this resource

int64

label

String

lastUpdated

Date

The time when this resource was last updated

date-time

modifiedBy

String

The request or process responsible for the last update of this resource

objectType

String

The data model type or class name of this resource

permissions

Set of string

Enum:

productionRoles

Set of Role

protocol

String

The protocol by which a client can access the volume

subFolderFromRoot

String

tag

Set of string

version

Long

The version of this resource, used for Optimistic Locking

int64

volume

Volume

volumeId

Long

int64

protocol

The protocol by which a client can access the Volume.

Supported values:

  • AsperaConnect

  • Archiware

  • DCR

  • Flow

  • Local

  • File