Section ID:
DOC-API-MODEL-schema-opsbitjge1#overview
FolderInfo
FolderInfo contains metadata about a folder
Meaning and usage
Section ID: DOC-API-MODEL-schema-opsbitjge1#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-opsbitjge1#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-opsbitjge1#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-folderidSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-folderidfolderId | string | Optional | Unique folder ID. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-nameSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-namename | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-pathSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-pathpath | string | Optional | Full path (e.g., "/documents/work"). |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-parentpathSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-parentpathparentPath | string | Optional | Parent folder path. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-createdatSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-createdatcreatedAt | string | Optional | RFC3339 timestamp. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-modifiedatSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-modifiedatmodifiedAt | string | Optional | RFC3339 timestamp. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-metadataSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-metadatametadata | Map from string to string | Optional | Custom metadata. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-filecountSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-filecountfileCount | string (int64) | Optional | Number of files (direct children). Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-subfoldercountSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-subfoldercountsubfolderCount | string (int64) | Optional | Number of subfolders. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-opsbitjge1#field-totalsizebytesSection ID: DOC-API-MODEL-schema-opsbitjge1#response-field-totalsizebytestotalSizeBytes | string (int64) | Optional | Total size of all files in folder (recursive). Pattern: ^-?\d+$. |
name
Name of the folder within its parent folder.
Folder name
Where used
Section ID: DOC-API-MODEL-schema-opsbitjge1#where-used
| Reference | Relationship |
|---|---|
| Create a new folder | POST /api/v1/storage/create-folder |
| Get storage state | POST /api/v1/storage/get-state |
| List files and folders in a directory | POST /api/v1/storage/list-files |
Models containing this value
| Model | Relationship |
|---|---|
| StorageManagerState | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-opsbitjge1