space fields
orc space fields lists, creates, updates, and archives the field definitions attached to Space items. orc space items fields reads and writes field values on each document, sheet, file, and folder.
Authentication and a selected Workspace are required. Creating, updating, and archiving field definitions requires workspace:settings. Writing values requires files:write for files and folders, or doc:update for documents and sheets.
Usage
orc space fields list --workspace YOUR_WORKSPACE_ID --format jsonList the field definitions in a Workspace.
Subcommands
list
Without --project-id, returns Workspace fields only. With it, also returns that project's fields, Workspace fields first and each scope ordered by position. Includes read-only system fields, which are never stored.
orc space fields list [options]Unique options
--project-id
value
Type: string. Optional.
orc space fields list --project-id <value>create
Creates a field from a type, slug, title, and the type's config. A slug cannot repeat within the same Workspace and project scope.
orc space fields create [options]Unique options
--config
(required) Body field: config; (JSON object, e.g. '{"custom_id":"x"}')
Type: string. Optional.
orc space fields create --config <value>--is-required
Body field: is_required
Type: string. Optional.
orc space fields create --is-required <value>--position
Body field: position
Type: number. Optional.
orc space fields create --position <value>--project-id
Body field: project_id; (use "null" or "reset" to clear)
Type: string. Optional.
orc space fields create --project-id <value>--slug
(required) Body field: slug; max 128 chars
Type: string. Optional.
orc space fields create --slug <value>--title
(required) Body field: title; max 256 chars
Type: string. Optional.
orc space fields create --title <value>--type
(required) Body field: type; enum: text|long_text|number|checkbox|select|multi_select|date|member|url|timecode|time_range|segment_list|object
Type: string. Optional.
orc space fields create --type <value>update
Updates a field definition. The type, slug, and scope cannot change. config is validated against the stored type, and existing values are kept.
orc space fields update <id> [options]Unique options
--config
Body field: config; (JSON object, e.g. '{"custom_id":"x"}')
Type: string. Optional.
orc space fields update <id> --config <value>--is-required
Body field: is_required
Type: string. Optional.
orc space fields update <id> --is-required <value>--position
Body field: position
Type: number. Optional.
orc space fields update <id> --position <value>--title
Body field: title; max 256 chars
Type: string. Optional.
orc space fields update <id> --title <value>archive
Archives a field definition. Archived definitions are no longer used, and their values are kept.
orc space fields archive <id> [options]space items fields get
Returns the effective fields and values for an item, including Workspace fields and the nearest explicit project in the folder chain. An unset value is null.
orc space items fields get <kind> <id> [options]space items fields set
Sets a field value on an item. The value is validated against the field's type and config; an invalid value returns 400 without writing. null deletes the stored value, including on required fields.
orc space items fields set <kind> <id> <field-id> [options]Unique options
--source
Body field: source; enum: user|ai|system
Type: string. Optional.
orc space items fields set <kind> <id> <field-id> --source <value>Global Options
The following global options can be used with orc space fields:
For details and examples, see global options.