How-to: action

OData function and action recipes, taken from the CRMWorx build (§4, §11). See the CLI reference for every flag.

Call an unbound function

crm --json action function RetrieveCurrentOrganization --params '{"AccessType":"Default"}'

--params is a JSON dict encoded inline per OData v4; returns the function result under data.

Invoke an unbound action from a body file

crm --json action invoke AddAppComponents --body-file /tmp/cwx_addcomponents.json

Use --body-file (or --body) for the JSON payload; AddAppComponents binds typed entity references to a model-driven app.

Invoke a bound action

crm --json action invoke <ActionName> --bind-set workflows --bind-id <workflow-guid> --body '{}'

--bind-set + --bind-id bind the action to a record; pass both together (override the namespace with --cast only for custom actions). <ActionName> is the action's schema/logical name (e.g. as listed in the entity's metadata).