Volume

Volume is a logical concept and only contains a label and handle.

It represents a storage location, for example, a NAS at your local premises.

Property Reference

Field Name Required Type Description Format

account

✘

Account

activeStatus

✘

String

Enum: Active, Archived,

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

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

settings

✘

Object

tag

✘

Set of string

version

✔

Long

The version of this resource, used for Optimistic Locking

int64

volumeAccesses

✘

List of VolumeAccess

activeStatus

  • Active if the Volume has not been archived

  • Archived if the Volume was archived. An Archived Volume should be ignored.

Archived in this context has nothing to do with archiving material. It is more closely related to deleting database objects.

volumeAccesses

A list of VolumeAccesses. Each VolumeAccess represents a different way of accessing the Volume, or a part of the Volume.