← All types
Ob Object

Folder

A tenant-scoped, named storage location: a name bound to exactly one transport plus a root path/prefix within it, so files, workflow nodes and scripts can choose where bytes live without knowing how they get there. The binding is flattened here to a kind discriminator plus the at-most-one matching reference ID.

Fields

id

FolderID!Non-null

TypeID of this folder (e.g. "fld_01K…"); stable file handles reference it.

TypeID of the owning tenant (e.g. "ten_01K…"); folders are tenant-scoped.

name

String!Non-null

Human-facing folder name. Unique per tenant.

Optional free-text note about the folder's purpose (max 1000 characters); null when unset.

Discriminator for the folder's binding; tells you which of storageBackendId / controllerId is populated.

Possible values (3)
CONTROL_CLOUD

The bytes live in ControlApp's own cloud file store, which the platform operates on the tenant's behalf. Control must configure a storage account; storageCapabilities and testFolder report read-only prerequisites. The store mints its own storage keys, so this is the one kind whose rootPath carries no meaning and is ignored.

STORAGE_BACKEND

The bytes live under a path inside one of the tenant's own StorageBackend rows, so the tenant supplies the account and credentials. storageBackendId names the backend and rootPath is a relative prefix within it, never starting with a slash.

CONTROLLER

The bytes live on the filesystem of an edge controller and are reached over file RPC rather than any cloud API, so the folder is only usable while that controller is online. controllerId names it and rootPath is an absolute path on that machine.

TypeID of the bound storage backend (e.g. "sbk_01K…"). Non-null only when kind is STORAGE_BACKEND; null otherwise.

TypeID of the bound edge controller (e.g. "ctl_01K…"). Non-null only when kind is CONTROLLER; null otherwise. The controller always belongs to this tenant.

Location within the bound transport. For cloud bindings (CONTROL_CLOUD, STORAGE_BACKEND) this is a key prefix — possibly empty, never leading "/". For CONTROLLER it is an absolute filesystem path starting with "/". Never contains a ".." segment.

True for the single folder per tenant that receives files stored without an explicit folder selection. Exactly one folder per tenant carries this flag.

ISO-8601 timestamp of when the folder was created.

ISO-8601 timestamp of the folder's last modification; equals createdAt until first update.

Referenced by (3)
Exact type SDL
"""
A tenant-scoped, named storage location: a name bound to exactly one transport plus a root path/prefix within it, so files, workflow nodes and scripts can choose *where* bytes live without knowing *how* they get there. The binding is flattened here to a kind discriminator plus the at-most-one matching reference ID.
"""
type Folder @iac_resource(name: "folder") @iac_ops(create: "createFolder", read: "folder", update: "updateFolder", delete: "deleteFolder") {
  """
  TypeID of this folder (e.g. "fld_01K…"); stable file handles reference it.
  """
  id: FolderID! @iac_identity(assignedBy: SERVER) @iac_computed
  """
  TypeID of the owning tenant (e.g. "ten_01K…"); folders are tenant-scoped.
  """
  tenantId: TenantID! @iac_computed
  """Human-facing folder name. Unique per tenant."""
  name: String!
  """
  Optional free-text note about the folder's purpose (max 1000 characters); null when unset.
  """
  description: String
  """
  Discriminator for the folder's binding; tells you which of storageBackendId / controllerId is populated.
  """
  kind: FolderBindingKind!
  """
  TypeID of the bound storage backend (e.g. "sbk_01K…"). Non-null only when kind is STORAGE_BACKEND; null otherwise.
  """
  storageBackendId: StorageBackendID @iac_ref(resource: "storage_backend")
  """
  TypeID of the bound edge controller (e.g. "ctl_01K…"). Non-null only when kind is CONTROLLER; null otherwise. The controller always belongs to this tenant.
  """
  controllerId: ControllerID @iac_ref(resource: "controller")
  """
  Location within the bound transport. For cloud bindings (CONTROL_CLOUD, STORAGE_BACKEND) this is a key prefix — possibly empty, never leading "/". For CONTROLLER it is an absolute filesystem path starting with "/". Never contains a ".." segment.
  """
  rootPath: String!
  """
  True for the single folder per tenant that receives files stored without an explicit folder selection. Exactly one folder per tenant carries this flag.
  """
  isDefault: Boolean!
  """ISO-8601 timestamp of when the folder was created."""
  createdAt: String! @iac_computed
  """
  ISO-8601 timestamp of the folder's last modification; equals createdAt until first update.
  """
  updatedAt: String! @iac_computed
}