capabilities.work

Define a Shared Parameter in a Collection

A 5-step recipe with Autodesk. We can help you get access.

Recipe · 5 steps

Define a Shared Parameter in a Collection

Create a parameter collection, group, and parameter definition.

  1. List the available spec types. A parameter's spec is an id, not a friendly name like "length", so it has to be resolved before a definition can be created.
  2. Create the collection that scopes this set of parameters. Collections are the unit products subscribe to, so one per standard rather than one per project.
  3. Create a group within the collection. Groups are how a large standard stays navigable once it holds hundreds of parameters.
  4. Define the parameter against the resolved spec and group, bound to the categories and disciplines it applies to. Instance parameters vary per placed element; type parameters vary per family type.
  5. Read the parameter back to confirm the definition and capture its GUID, which is the identifier that follows the parameter into every model that consumes the collection.
What you'll need to have ready
  • accountId: The Autodesk account id (the hub id without the "b." prefix).
  • collectionName: Name of the parameter collection to create.
  • collectionDescription: What standard this collection represents.
  • groupName: Name of the group organizing the parameters.
  • groupDescription: What the group covers.
  • parameterName: Name of the parameter being defined.
  • parameterDescription: What the parameter records.
  • specId: The spec (data type) id the parameter uses, taken from the resolved spec list (e.g. a length, area, or text spec).
  • categories: Revit category ids the parameter binds to.
  • disciplines: Discipline ids the parameter is classified under.
For your developer

Arazzo workflow autodesk:define-shared-parameter, 5 operations: getSpecs → createCollection → createGroup → createParameter → getParameter. Specs on APIs.io.