Autodesk · Schema

ParameterDefinition

Fortune 10003D ModelingArchitectureBIMCADConstructionDesignDigital TwinsEngineeringManufacturingMedia and EntertainmentSustainability

Properties

Name	Type	Description
id	string
name	string
description	string
specId	string	The spec type (data type) of the parameter.
groupId	string
isReadOnly	boolean
isShared	boolean
isInstance	boolean	Whether the parameter is instance-level or type-level.
categories	array
disciplines	array
guid	string	Globally unique parameter identifier.
createdAt	string
updatedAt	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ParameterDefinition",
  "title": "ParameterDefinition",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "specId": {
      "type": "string",
      "description": "The spec type (data type) of the parameter."
    },
    "groupId": {
      "type": "string"
    },
    "isReadOnly": {
      "type": "boolean"
    },
    "isShared": {
      "type": "boolean"
    },
    "isInstance": {
      "type": "boolean",
      "description": "Whether the parameter is instance-level or type-level."
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "disciplines": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "guid": {
      "type": "string",
      "description": "Globally unique parameter identifier."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}