Skip to content

plan

Manage plans (connected planning)

Authentication scope: fabric

List plans in a workspace

Terminal window
fabio plan list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--no-recursive bool No Only list plans directly in the root folder (default lists nested folders too)
--root-folder-id string No Filter plans to a specific root folder ID (defaults to the workspace root)

Examples

Terminal window
fabio plan list --workspace $WS
Terminal window
fabio plan list --workspace $WS --no-recursive --root-folder-id $FOLDER_ID

Read-only · Returns list

Show details of a plan

Terminal window
fabio plan show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Plan ID

Examples

Terminal window
fabio plan show --workspace $WS --id $PLAN_ID

Read-only · Returns object

Create a new plan

Terminal window
fabio plan create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Display name
--description string No Optional description (max 256 characters)
--sensitivity-label string No Sensitivity label ID to apply on creation
--folder-id string No Folder ID to create the plan in (defaults to the workspace root)

Examples

Terminal window
fabio plan create --workspace $WS --name "Retail FP&A Plan" --description "Q3 forecast"

Mutates state · Returns object

Update plan properties

Terminal window
fabio plan update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Plan ID
--name string No New display name
--description string No New description (max 256 characters)

Examples

Terminal window
fabio plan update --workspace $WS --id $PLAN_ID --name "Renamed Plan"

Mutates state · Returns object

Delete a plan

Terminal window
fabio plan delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Plan ID

Examples

Terminal window
fabio plan delete --workspace $WS --id $PLAN_ID

Mutates state · Destructive · Returns void

Get the definition of a plan

Terminal window
fabio plan get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Plan ID
--format string No Definition format (defaults to the server’s canonical format, PlanV1)
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Examples

Terminal window
fabio plan get-definition --workspace $WS --id $PLAN_ID --decode

Read-only · Long-running operation · Returns object

Update the definition of a plan

Terminal window
fabio plan update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Plan ID
--file string No Path to definition file (a single raw part, or a full envelope JSON)
--content string No Inline definition content

Examples

Terminal window
fabio plan update-definition --workspace $WS --id $PLAN_ID --file connectedPlanning/infobridge.json

Mutates state · Destructive · Long-running operation · Returns void