Revit API Docs

https://revapidocs.com/
Admin
Comprehensive API documentation for Autodesk Revit covering namespaces, classes, methods, and...
Tokens:146,189
Snippets:1,257
Trust Score:5.2
Update:1 day ago
Show doc for...
Tokens:
Raw
### ColorFillScheme.GetFormatOptions()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the format options for the color fill scheme.

```APIDOC
## ColorFillScheme.GetFormatOptions()

### Description
Gets the format options for the color fill scheme.

### Method
GetFormatOptions

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ElectricalSetting.GetCircuitNamingSchemeSettings()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the circuit naming scheme settings of the project.

```APIDOC
## ElectricalSetting.GetCircuitNamingSchemeSettings()

### Description
Gets the circuit naming scheme settings of the project.

### Method
GetCircuitNamingSchemeSettings

### Parameters
None

### Returns
The CircuitNamingSchemeSettings object.
```

--------------------------------

### ColorFillScheme.GetEntries()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the entries of the color fill scheme.

```APIDOC
## ColorFillScheme.GetEntries()

### Description
Gets the entries of the color fill scheme.

### Method
GetEntries

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### GenericZone.GetBoundaries()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the boundaries for the given GenericZone.

```APIDOC
## GenericZone.GetBoundaries()

### Description
Gets the boundaries for the given GenericZone.

### Method
GetBoundaries()

### Returns
The boundaries of the GenericZone.
```

--------------------------------

### ColorFillScheme.GetSupportedParameterIds()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the supported parameter IDs for the color fill scheme.

```APIDOC
## ColorFillScheme.GetSupportedParameterIds()

### Description
Gets the supported parameter IDs for the color fill scheme.

### Method
GetSupportedParameterIds

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### Surface.GetBoundingBoxUV()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the UV bounding box of the surface.

```APIDOC
## [GET] Surface.GetBoundingBoxUV()

### Description
Gets the UV bounding box of the surface.

### Method
GET

### Endpoint
Surface.GetBoundingBoxUV()

### Parameters
None

### Response
#### Success Response (200)
- **BoundingBoxUV** - The UV bounding box of the surface.

#### Response Example
```json
{
  "boundingBoxUV": {}
}
```
```

--------------------------------

### ColorFillScheme.ParameterDefinition

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the parameter definition used by the color fill scheme.

```APIDOC
## ColorFillScheme.ParameterDefinition

### Description
Gets the parameter definition used by the color fill scheme.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ElectricalSystem.Ways

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the circuit ways used in the electrical system.

```APIDOC
## ElectricalSystem.Ways

### Description
Gets the circuit ways used in the electrical system.

### Property
Ways

### Type
int

### Access
Read
```

--------------------------------

### CircuitNamingSchemeSettings.GetCircuitNamingSchemeSettings()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the circuit naming scheme settings object from a project document.

```APIDOC
## CircuitNamingSchemeSettings.GetCircuitNamingSchemeSettings()

### Description
Gets the circuit naming scheme settings object from a project document.

### Method
GetCircuitNamingSchemeSettings

### Parameters
None

### Returns
The CircuitNamingSchemeSettings object.
```

--------------------------------

### ColorFillLegend.GetColumnWidths()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the column widths of the color fill legend.

```APIDOC
## ColorFillLegend.GetColumnWidths()

### Description
Gets the column widths of the color fill legend.

### Method
GetColumnWidths

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### StructuralConnectionHandlerType.Create(Document, string, Guid, string, ElementId, IList<ConnectionInputPointInfo>)

Source: https://revapidocs.com/2021/WhatsNew.htm

Creates a new structural connection handler type that requires additional input points. This static method defines the type with a name, GUID, description, and input point requirements.

```APIDOC
## [METHOD] StructuralConnectionHandlerType.Create(Document, string, Guid, string, ElementId, IList<ConnectionInputPointInfo>)

### Description
Creates a new structural connection handler type that requires additional input points.

### Method
Create (static)

### Parameters
- **document** (Document) - Required - The document in which to create the type.
- **name** (string) - Required - The name of the type.
- **guid** (Guid) - Required - The unique identifier for the type.
- **description** (string) - Required - A description of the type.
- **typeId** (ElementId) - Required - The ID of the type.
- **inputPoints** (IList<ConnectionInputPointInfo>) - Required - Information about the required input points.

### Response
Returns a StructuralConnectionHandlerType object.
```

--------------------------------

### ColorFillScheme.Title

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the title of the color fill scheme.

```APIDOC
## ColorFillScheme.Title

### Description
Gets or sets the title of the color fill scheme.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ColorFillScheme.StorageType

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the storage type of the color fill scheme.

```APIDOC
## ColorFillScheme.StorageType

### Description
Gets the storage type of the color fill scheme.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ColorFillSchemeEntry.GetStringValue()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the string value of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.GetStringValue()

### Description
Gets the string value of the color fill scheme entry.

### Method
GetStringValue

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ColorFillSchemeEntry.Caption

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the caption of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.Caption

### Description
Gets or sets the caption of the color fill scheme entry.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### PathOfTravel.FindEndsOfShortestPaths

Source: https://revapidocs.com/2021/WhatsNew.htm

Static method that calculates the paths from each start point to its closest destination and returns the path end points.

```APIDOC
## Method: PathOfTravel.FindEndsOfShortestPaths

### Description
For a floor plan view, calculates the paths from each start point to its closest destination and returns the path end points. The calculation is done in a floor plan with one or more destinationPoints and one or more startPoints. The shortest path is calculated from each start point to its corresponding closest destination.

### Method
`List<XYZ> PathOfTravel.FindEndsOfShortestPaths(View view, List<XYZ> destinationPoints, List<XYZ> startPoints)`

### Parameters
- **view** (View) - Required - The floor plan view.
- **destinationPoints** (List<XYZ>) - Required - The destination points.
- **startPoints** (List<XYZ>) - Required - The start points.

### Returns
List<XYZ> - The path end points.

```

--------------------------------

### ImportInstance.Create(Document, View, ExternalResourceReference, STLImportOptions, [out] LinkLoadResult)

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates an import instance from an STL external resource.

```APIDOC
## Method: ImportInstance.Create(Document, View, ExternalResourceReference, STLImportOptions, [out] LinkLoadResult)

### Description
Creates an import instance from an STL external resource.

### Method
`ImportInstance.Create(Document, View, ExternalResourceReference, STLImportOptions, [out] LinkLoadResult)`

### Parameters
- **Document** (Document) - Required - The document.
- **View** (View) - Required - The view.
- **ExternalResourceReference** (ExternalResourceReference) - Required - The external resource reference.
- **STLImportOptions** (STLImportOptions) - Required - The import options.
- **[out] LinkLoadResult** (LinkLoadResult) - Required - The link load result.
```

--------------------------------

### PathOfTravel.PathStart

Source: https://revapidocs.com/2020/WhatsNew.htm

Gets the start point of the path of travel.

```APIDOC
## PathOfTravel.PathStart

### Description
Gets the start point of the path of travel.

### Property
PathStart

### Returns
- **XYZ** - The start point.
```

--------------------------------

### ImportInstance.Create(Document, View, ExternalResourceReference, OBJImportOptions, [out] LinkLoadResult)

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates an import instance from an OBJ external resource.

```APIDOC
## Method: ImportInstance.Create(Document, View, ExternalResourceReference, OBJImportOptions, [out] LinkLoadResult)

### Description
Creates an import instance from an OBJ external resource.

### Method
`ImportInstance.Create(Document, View, ExternalResourceReference, OBJImportOptions, [out] LinkLoadResult)`

### Parameters
- **Document** (Document) - Required - The document.
- **View** (View) - Required - The view.
- **ExternalResourceReference** (ExternalResourceReference) - Required - The external resource reference.
- **OBJImportOptions** (OBJImportOptions) - Required - The import options.
- **[out] LinkLoadResult** (LinkLoadResult) - Required - The link load result.
```

--------------------------------

### GetMatchingParameters()

Source: https://revapidocs.com/2027/WhatsNew.htm

Gets the parameters used by a specific numbering schema in matching elements so they would get the same number.

```APIDOC
## GetMatchingParameters()

### Description
Gets the parameters used by a specific numbering schema in matching elements so they would get the same number.

### Method
GetMatchingParameters()

### Parameters
- **schema** (NumberingSchema) - Required - The numbering schema.

### Returns
The set of matching parameters.
```

--------------------------------

### BasePoint.Clipped

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the clipped state of the survey point BasePoint based on the active ProjectLocation of its Document. For the project base point, the get method always returns false, and the set method throws an exception.

```APIDOC
## BasePoint.Clipped

### Description
Gets or sets the clipped state of the survey point BasePoint based on the active ProjectLocation of its Document. For the project base point, the get method always returns false, and the set method throws an exception.

### Property
`bool BasePoint.Clipped`
```

--------------------------------

### Document.Import(String, OBJImportOptions, View)

Source: https://revapidocs.com/2023/WhatsNew.htm

Imports an OBJ file into the document.

```APIDOC
## Method: Document.Import(String, OBJImportOptions, View)

### Description
Imports an OBJ file into the document.

### Method
`Document.Import(String, OBJImportOptions, View)`

### Parameters
- **String** (string) - Required - The path to the OBJ file.
- **OBJImportOptions** (OBJImportOptions) - Required - The import options.
- **View** (View) - Required - The view into which to import.
```

--------------------------------

### ColorFillSchemeEntry.IsInUse

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets whether the color fill scheme entry is in use.

```APIDOC
## ColorFillSchemeEntry.IsInUse

### Description
Gets whether the color fill scheme entry is in use.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### Document.Import(String, STLImportOptions, View)

Source: https://revapidocs.com/2023/WhatsNew.htm

Imports an STL file into the document.

```APIDOC
## Method: Document.Import(String, STLImportOptions, View)

### Description
Imports an STL file into the document.

### Method
`Document.Import(String, STLImportOptions, View)`

### Parameters
- **String** (string) - Required - The path to the STL file.
- **STLImportOptions** (STLImportOptions) - Required - The import options.
- **View** (View) - Required - The view into which to import.
```

--------------------------------

### RevisionNumberingSequence.GetAllRevisionNumberingSequences()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets all revision numbering sequences.

```APIDOC
## RevisionNumberingSequence.GetAllRevisionNumberingSequences()

### Description
Gets all revision numbering sequences.

### Method
GetAllRevisionNumberingSequences

### Parameters
None

### Returns
IList<RevisionNumberingSequence>
```

--------------------------------

### Document.Import(String, AXMImportOptions, View)

Source: https://revapidocs.com/2023/WhatsNew.htm

Imports an AXM file into the document.

```APIDOC
## Method: Document.Import(String, AXMImportOptions, View)

### Description
Imports an AXM file into the document.

### Method
`Document.Import(String, AXMImportOptions, View)`

### Parameters
- **String** (string) - Required - The path to the AXM file.
- **AXMImportOptions** (AXMImportOptions) - Required - The import options.
- **View** (View) - Required - The view into which to import.
```

--------------------------------

### Category.GetBuiltInCategory(ForgeTypeId)

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the BuiltInCategory for a ForgeTypeId.

```APIDOC
## Category.GetBuiltInCategory(ForgeTypeId)

### Description
Gets the BuiltInCategory for a ForgeTypeId.

### Method
`Category.GetBuiltInCategory(ForgeTypeId)`
```

--------------------------------

### ImageTypeOptions constructors and properties

Source: https://revapidocs.com/2021/WhatsNew.htm

New constructors and a property allow creating or converting an ImageType to a link or import.

```APIDOC
## ImageTypeOptions constructors and properties

### Description
New constructors and a property allow creating or converting an ImageType to a link or import.

### Constructors
- **ImageTypeOptions(String, Boolean, ImageTypeSource)** - Creates an ImageTypeOptions with a source type.
- **ImageTypeOptions(ExternalReference, ImageTypeSource)** - Creates an ImageTypeOptions with an external reference and source type.

### Properties
- **ImageTypeOptions.SourceType** - Indicates the source type (link or import).
```

--------------------------------

### CircuitNamingScheme.GetCombinedParameters()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the list of combined parameters associated with the circuit naming scheme.

```APIDOC
## CircuitNamingScheme.GetCombinedParameters()

### Description
Gets the list of combined parameters associated with the circuit naming scheme.

### Method
GetCombinedParameters

### Parameters
None

### Returns
The list of combined parameters.
```

--------------------------------

### RevisionNumberingSequence.GetAlphanumericRevisionSettings()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the alphanumeric revision settings for the sequence.

```APIDOC
## RevisionNumberingSequence.GetAlphanumericRevisionSettings()

### Description
Gets the alphanumeric revision settings for the sequence.

### Method
GetAlphanumericRevisionSettings

### Parameters
None

### Returns
AlphanumericRevisionSettings
```

--------------------------------

### RevisionNumberingSequence.GetNumericRevisionSettings()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the numeric revision settings for the sequence.

```APIDOC
## RevisionNumberingSequence.GetNumericRevisionSettings()

### Description
Gets the numeric revision settings for the sequence.

### Method
GetNumericRevisionSettings

### Parameters
None

### Returns
NumericRevisionSettings
```

--------------------------------

### CircuitNamingScheme.Create()

Source: https://revapidocs.com/2021/WhatsNew.htm

Creates a new circuit naming scheme.

```APIDOC
## CircuitNamingScheme.Create()

### Description
Creates a new circuit naming scheme.

### Method
Create

### Parameters
None

### Returns
A new CircuitNamingScheme object.
```

--------------------------------

### RevisionNumberingSequence.GetSequenceName()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the name of the revision numbering sequence.

```APIDOC
## RevisionNumberingSequence.GetSequenceName()

### Description
Gets the name of the revision numbering sequence.

### Method
GetSequenceName

### Parameters
None

### Returns
string
```

--------------------------------

### Category.GetBuiltInCategoryTypeId(BuiltInCategory)

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the ForgeTypeId for a built-in category.

```APIDOC
## Category.GetBuiltInCategoryTypeId(BuiltInCategory)

### Description
Gets the ForgeTypeId for a built-in category.

### Method
`Category.GetBuiltInCategoryTypeId(BuiltInCategory)`
```

--------------------------------

### PathOfTravel.FindStartsOfLongestPathsFromRooms

Source: https://revapidocs.com/2021/WhatsNew.htm

Static method that calculates paths from points inside rooms to the closest destinations and returns the start points of the longest path(s).

```APIDOC
## Method: PathOfTravel.FindStartsOfLongestPathsFromRooms

### Description
For a floor plan view, calculates paths from points inside rooms to the closest destinations. Returns the start points of the longest path(s). If multiple paths have the same longest length, returns multiple start points. The entire plan is divided into small tiles, and the distance to the closest destination point is calculated for each tile center point. Only tile center points that are located in rooms in the view are taken into account.

### Method
`List<XYZ> PathOfTravel.FindStartsOfLongestPathsFromRooms(View view, List<XYZ> destinationPoints)`

### Parameters
- **view** (View) - Required - The floor plan view.
- **destinationPoints** (List<XYZ>) - Required - The destination points.

### Returns
List<XYZ> - The start points of the longest path(s).

```

--------------------------------

### Document.Link(String, STLImportOptions, View)

Source: https://revapidocs.com/2023/WhatsNew.htm

Links an STL file into the document.

```APIDOC
## Method: Document.Link(String, STLImportOptions, View)

### Description
Links an STL file into the document.

### Method
`Document.Link(String, STLImportOptions, View)`

### Parameters
- **String** (string) - Required - The path to the STL file.
- **STLImportOptions** (STLImportOptions) - Required - The link options.
- **View** (View) - Required - The view.
```

--------------------------------

### DimensionType.Suffix

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the suffix for the dimension type.

```APIDOC
## DimensionType.Suffix

### Description
Gets or sets the suffix for the dimension type.

### Property
`DimensionType.Suffix`
```

--------------------------------

### DimensionType.Prefix

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the prefix for the dimension type.

```APIDOC
## DimensionType.Prefix

### Description
Gets or sets the prefix for the dimension type.

### Property
`DimensionType.Prefix`
```

--------------------------------

### Autodesk.Revit.DB.Structure.PointLoad.Create()

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a new hosted point load within the project.

```APIDOC
## Method: Autodesk.Revit.DB.Structure.PointLoad.Create()

### Description
Creates a new hosted point load within the project.
```

--------------------------------

### Dimension.HasLeader

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets whether the dimension has a leader.

```APIDOC
## Dimension.HasLeader

### Description
Gets or sets whether the dimension has a leader.

### Property
`Dimension.HasLeader`
```

--------------------------------

### Document.Link(String, OBJImportOptions, View)

Source: https://revapidocs.com/2023/WhatsNew.htm

Links an OBJ file into the document.

```APIDOC
## Method: Document.Link(String, OBJImportOptions, View)

### Description
Links an OBJ file into the document.

### Method
`Document.Link(String, OBJImportOptions, View)`

### Parameters
- **String** (string) - Required - The path to the OBJ file.
- **OBJImportOptions** (OBJImportOptions) - Required - The link options.
- **View** (View) - Required - The view.
```

--------------------------------

### ElectricalEquipment.GetCircuitNamingSchemeType()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the enumerated type of the circuit naming scheme used with electrical equipment.

```APIDOC
## ElectricalEquipment.GetCircuitNamingSchemeType()

### Description
Gets the enumerated type of the circuit naming scheme used with electrical equipment.

### Method
GetCircuitNamingSchemeType

### Parameters
None

### Returns
The circuit naming scheme type.
```

--------------------------------

### OBJExportOptions Properties and Methods

Source: https://revapidocs.com/2023/WhatsNew.htm

Options available for OBJ export.

```APIDOC
## Properties and Methods: OBJExportOptions

### Description
Options available for OBJ export.

### Properties
- **TargetUnit** - The target unit for export.
- **SurfaceTolerance** - The surface tolerance.
- **NormalTolerance** - The normal tolerance.
- **MaxEdgeLength** - The maximum edge length.
- **GridAspectRatio** - The grid aspect ratio.

### Methods
- **SetTessellationSettings()** - Sets the tessellation settings.
```

--------------------------------

### Dimension.TextPosition

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the text position of a dimension.

```APIDOC
## Dimension.TextPosition

### Description
Gets or sets the text position of a dimension.

### Property
`Dimension.TextPosition`
```

--------------------------------

### SketchEditScope.StartWithNewSketch()

Source: https://revapidocs.com/2023/WhatsNew.htm

Starts a sketch edit mode for an element which, at this moment, doesn't have a sketch. Some surface Revit elements (like some Walls or some Analytical Elements) do not have a valid sketch all the time so in order to edit them, we have to create a valid sketch first.

```APIDOC
## SketchEditScope.StartWithNewSketch()

### Description
Starts a sketch edit mode for an element which, at this moment, doesn't have a sketch. Some surface Revit elements (like some Walls or some Analytical Elements) do not have a valid sketch all the time so in order to edit them, we have to create a valid sketch first.

### Method
StartWithNewSketch()
```

--------------------------------

### Autodesk.Revit.DB.Structure.LineLoad.Create(Document, ElementId, XYZ, XYZ, LineLoadType)

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a new hosted line load within the project.

```APIDOC
## Method: Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Description
Creates a new hosted line load within the project.

### Parameters
- `aDoc` (Document) - The document.
- `hostElemId` (ElementId) - The host element id.
- `forceVector1` (XYZ) - The force vector.
- `momentVector1` (XYZ) - The moment vector.
- `symbol` (LineLoadType) - The line load type.
```

--------------------------------

### ZoneEquipment.GetAssociatedZoneEquipment()

Source: https://revapidocs.com/2021/WhatsNew.htm

Returns the set of zone equipment associated with the specified analytical space or spaces.

```APIDOC
## ZoneEquipment.GetAssociatedZoneEquipment()

### Description
Returns the set of zone equipment associated with the specified analytical space or spaces.

### Method
GetAssociatedZoneEquipment()

### Parameters
- Analytical space or spaces - Required - The analytical space(s) to query.

### Returns
Set of ZoneEquipment elements.
```

--------------------------------

### PathOfTravel.GetWaypoints()

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the waypoints associated with a PathOfTravel element.

```APIDOC
## Method: PathOfTravel.GetWaypoints()

### Description
Gets the waypoints associated with a particular PathOfTravel element.

### Method
`PathOfTravel.GetWaypoints()`

### Returns
IList<XYZ> - The waypoints.

```

--------------------------------

### Autodesk.Revit.DB.Structure.AreaLoad.Create()

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a new hosted area load within the project.

```APIDOC
## Method: Autodesk.Revit.DB.Structure.AreaLoad.Create()

### Description
Creates a new hosted area load within the project.
```

--------------------------------

### ElectricalEquipment.MaxNumberOfCircuits

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the maximum number of circuits for switchboard.

```APIDOC
## ElectricalEquipment.MaxNumberOfCircuits

### Description
Gets the maximum number of circuits for switchboard.

### Property
MaxNumberOfCircuits

### Type
int

### Access
Read
```

--------------------------------

### ElectricalLoadClassification.Abbreviation

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the abbreviation of the load classification name.

```APIDOC
## ElectricalLoadClassification.Abbreviation

### Description
Gets the abbreviation of the load classification name.

### Property
Abbreviation

### Type
string

### Access
Read
```

--------------------------------

### SlabShapeEditor.CreateCreasesFromFoldingLines()

Source: https://revapidocs.com/2023/WhatsNew.htm

Allows users to pick edges on a floor and convert them from folding lines to split lines.

```APIDOC
## SlabShapeEditor.CreateCreasesFromFoldingLines()

### Description
Allows users to pick edges on a floor and convert them from folding lines to split lines.

### Method
CreateCreasesFromFoldingLines()

### Endpoint
SlabShapeEditor.CreateCreasesFromFoldingLines()
```

--------------------------------

### Autodesk.Revit.DB.Structure.LineLoad.Create(Document, ElementId, int, XYZ, XYZ, LineLoadType)

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a new hosted line load within the project.

```APIDOC
## Method: Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, int curveIndex, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Description
Creates a new hosted line load within the project.

### Parameters
- `aDoc` (Document) - The document.
- `hostElemId` (ElementId) - The host element id.
- `curveIndex` (int) - The curve index.
- `forceVector1` (XYZ) - The force vector.
- `momentVector1` (XYZ) - The moment vector.
- `symbol` (LineLoadType) - The line load type.
```

--------------------------------

### PathOfTravel.FindShortestPaths

Source: https://revapidocs.com/2021/WhatsNew.htm

Static method that calculates paths from each start point to its closest destination and returns the path as an array of XYZ points.

```APIDOC
## Method: PathOfTravel.FindShortestPaths

### Description
For a floor plan view, calculates paths from each start point to its closest destinations. Returns the path, represented by an array of XYZ points. The calculation is done in a floor plan with one or more destinationPoints and one or more startPoints. The shortest path is calculated from each start point to its closest destination point.

### Method
`List<List<XYZ>> PathOfTravel.FindShortestPaths(View view, List<XYZ> destinationPoints, List<XYZ> startPoints)`

### Parameters
- **view** (View) - Required - The floor plan view.
- **destinationPoints** (List<XYZ>) - Required - The destination points.
- **startPoints** (List<XYZ>) - Required - The start points.

### Returns
List<List<XYZ>> - The paths, each represented by an array of XYZ points.

```

--------------------------------

### NumericRevisionSettings.GetMinimumDigits()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the minimum number of digits for a revision number.

```APIDOC
## NumericRevisionSettings.GetMinimumDigits()

### Description
Gets the minimum number of digits for a revision number.

### Method
GetMinimumDigits

### Parameters
None

### Returns
int
```

--------------------------------

### Dimension.LeaderEndPosition

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the leader end position of a dimension.

```APIDOC
## Dimension.LeaderEndPosition

### Description
Gets or sets the leader end position of a dimension.

### Property
`Dimension.LeaderEndPosition`
```

--------------------------------

### ColorFillLegend.Origin

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the origin of the color fill legend.

```APIDOC
## ColorFillLegend.Origin

### Description
Gets or sets the origin of the color fill legend.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ElectricalEquipment.IsSwitchboard()

Source: https://revapidocs.com/2021/WhatsNew.htm

Verifies that the electrical equipment is a switchboard.

```APIDOC
## ElectricalEquipment.IsSwitchboard()

### Description
Verifies that the electrical equipment is a switchboard.

### Method
IsSwitchboard

### Parameters
None

### Returns
True if the electrical equipment is a switchboard, false otherwise.
```

--------------------------------

### ColorFillScheme.SetFormatOptions()

Source: https://revapidocs.com/2022/WhatsNew.htm

Sets the format options for the color fill scheme.

```APIDOC
## ColorFillScheme.SetFormatOptions()

### Description
Sets the format options for the color fill scheme.

### Method
SetFormatOptions

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ColorFillLegend.Height

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the height of the color fill legend.

```APIDOC
## ColorFillLegend.Height

### Description
Gets or sets the height of the color fill legend.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### BasePoint.GetProjectBasePoint and BasePoint.GetSurveyPoint

Source: https://revapidocs.com/2021/WhatsNew.htm

Two new static methods provide access to the base and survey point.

```APIDOC
## Methods: BasePoint.GetProjectBasePoint and BasePoint.GetSurveyPoint

### Description
Two new static methods provide access to the base and survey point.

### Methods
- `static BasePoint.GetProjectBasePoint()` - Returns the project base point.
- `static BasePoint.GetSurveyPoint()` - Returns the survey point.
```

--------------------------------

### ElectricalEquipment.IsValidDistributionSystem()

Source: https://revapidocs.com/2021/WhatsNew.htm

Verifies that the distribution system can be assigned to the electrical equipment.

```APIDOC
## ElectricalEquipment.IsValidDistributionSystem()

### Description
Verifies that the distribution system can be assigned to the electrical equipment.

### Method
IsValidDistributionSystem

### Parameters
- **distributionSystem** (DistributionSystem) - Required - The distribution system to verify.

### Returns
True if the distribution system is valid, false otherwise.
```

--------------------------------

### ColorFillScheme.AddEntry()

Source: https://revapidocs.com/2022/WhatsNew.htm

Adds a new entry to the color fill scheme.

```APIDOC
## ColorFillScheme.AddEntry()

### Description
Adds a new entry to the color fill scheme.

### Method
AddEntry

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### Application.GetSystemsAnalysisWorkflows()

Source: https://revapidocs.com/2021/WhatsNew.htm

Reads the path information for systems analysis workflows.

```APIDOC
## [GET] Application.GetSystemsAnalysisWorkflows()

### Description
Reads the path information for systems analysis workflows.

### Method
GET

### Endpoint
Application.GetSystemsAnalysisWorkflows()

### Parameters
None documented.

### Request Example
No request body documented.

### Response
#### Success Response
Returns the path information for systems analysis workflows.

#### Response Example
No response body documented.
```

--------------------------------

### SymbolGeometryId.SymbolId

Source: https://revapidocs.com/2023/WhatsNew.htm

Gets the id of the symbol that is containing the geometry that is shared.

```APIDOC
## Property: SymbolGeometryId.SymbolId

### Description
Gets the id of the symbol that is containing the geometry that is shared.

### Property
`SymbolGeometryId.SymbolId`

### Returns
The id of the symbol containing the shared geometry.
```

--------------------------------

### GenericZone.LevelOffset

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the offset distance from this zone to the associated level.

```APIDOC
## [PROPERTY] GenericZone.LevelOffset

### Description
Gets or sets the offset distance from this zone to the associated level.

### Property
GenericZone.LevelOffset

### Type
- Not specified in source.
```

--------------------------------

### ViewSystemsAnalysisReport.Create()

Source: https://revapidocs.com/2021/WhatsNew.htm

Creates a new view instance of the systems analysis report. This is the first step in running a systems analysis against a Revit project.

```APIDOC
## [CREATE] ViewSystemsAnalysisReport.Create()

### Description
Creates a new view instance of the systems analysis report. This is the first step in running a systems analysis against a Revit project.

### Method
CREATE

### Endpoint
ViewSystemsAnalysisReport.Create()

### Parameters
None documented.

### Request Example
No request body documented.

### Response
#### Success Response
Returns a new ViewSystemsAnalysisReport instance.

#### Response Example
No response body documented.
```

--------------------------------

### RevisionNumberingSequence.NumberType

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the number type of the revision numbering sequence.

```APIDOC
## RevisionNumberingSequence.NumberType

### Description
Gets or sets the number type of the revision numbering sequence.

### Property
NumberType

### Type
RevisionNumberType
```

--------------------------------

### GenericZone.Create()

Source: https://revapidocs.com/2021/WhatsNew.htm

Creates a GenericZone element using the specified domain data, level, and curves representing the intersection/outline of related spaces.

```APIDOC
## GenericZone.Create(Document doc, String name, GenericZoneDomainData domainData, ElementId levelId, IList<CurveLoop> curves)

### Description
Creates a GenericZone element with the specified domain data, level, and curves.

### Parameters
- doc (Document) - Required - The document.
- name (String) - Required - The name of the zone.
- domainData (GenericZoneDomainData) - Required - The domain-specific data.
- levelId (ElementId) - Required - The level ID.
- curves (IList<CurveLoop>) - Required - The curves representing the zone outline.

### Returns
The created GenericZone element.
```

--------------------------------

### ZoneEquipment.MoveSpaceToEquipment()

Source: https://revapidocs.com/2021/WhatsNew.htm

Moves a set of spaces from the original zone equipment to the targeted zone equipment. Either zone equipment ID may be InvalidElementId to copy or remove associations.

```APIDOC
## ZoneEquipment.MoveSpaceToEquipment()

### Description
Moves a set of spaces from the original zone equipment to the targeted zone equipment.

### Method
MoveSpaceToEquipment()

### Parameters
- Original zone equipment ID (ElementId) - Required - The source zone equipment; if InvalidElementId, the association is copied to the target.
- Target zone equipment ID (ElementId) - Required - The destination zone equipment; if InvalidElementId, the original association is removed.
- Spaces (set of spaces) - Required - The spaces to move.
```

--------------------------------

### SpotDimension.LeaderHasElbow

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets whether the spot dimension leader has an elbow.

```APIDOC
## SpotDimension.LeaderHasElbow

### Description
Gets or sets whether the spot dimension leader has an elbow.

### Property
`SpotDimension.LeaderHasElbow`
```

--------------------------------

### SpotDimension.LeaderElbowPosition

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the leader elbow position of a spot dimension.

```APIDOC
## SpotDimension.LeaderElbowPosition

### Description
Gets or sets the leader elbow position of a spot dimension.

### Property
`SpotDimension.LeaderElbowPosition`
```

--------------------------------

### Document.Link(String, ImportOptions3DM, View)

Source: https://revapidocs.com/2022/WhatsNew.htm

Links a 3DM file into the document. This method is part of the Import API additions for 2022.

```APIDOC
## [LINK] Document.Link(String, ImportOptions3DM, View)

### Description
Links a 3DM file into the document.

### Method
Link

### Parameters
- **filePath** (String) - Required - The path to the 3DM file.
- **options** (ImportOptions3DM) - Required - Import options for the 3DM file.
- **view** (View) - Required - The view to link into.

### Response
No return value.
```

--------------------------------

### ColorFillLegend.ColorFillCategoryId

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the category ID for the color fill legend.

```APIDOC
## ColorFillLegend.ColorFillCategoryId

### Description
Gets or sets the category ID for the color fill legend.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### ViewSystemsAnalysisReport.GetLatestSystemsAnalysisReport()

Source: https://revapidocs.com/2021/WhatsNew.htm

Returns the latest systems analysis report in the project. The peak heating/cooling loads of all EnergyAnalysisSpace elements should be consistent with this latest report.

```APIDOC
## [GET] ViewSystemsAnalysisReport.GetLatestSystemsAnalysisReport()

### Description
Returns the latest systems analysis report in the project. The peak heating/cooling loads of all EnergyAnalysisSpace elements should be consistent with this latest report.

### Method
GET

### Endpoint
ViewSystemsAnalysisReport.GetLatestSystemsAnalysisReport()

### Parameters
None documented.

### Request Example
No request body documented.

### Response
#### Success Response
Returns the latest ViewSystemsAnalysisReport instance.

#### Response Example
No response body documented.
```

--------------------------------

### ColorFillSchemeEntry.GetDoubleValue()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the double value of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.GetDoubleValue()

### Description
Gets the double value of the color fill scheme entry.

### Method
GetDoubleValue

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### FilledRegion.Create()

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a filled region on a sketch plane in a 3d family.

```APIDOC
## FilledRegion.Create()

### Description
Creates a filled region on a sketch plane in a 3d family.

### Method
Create()
```

--------------------------------

### ColorFillSchemeEntry.GetIntegerValue()

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the integer value of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.GetIntegerValue()

### Description
Gets the integer value of the color fill scheme entry.

### Method
GetIntegerValue

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### Zone.CreateAreaBasedLoad()

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates a new instance of an area based load and adds it to the document.

```APIDOC
## Zone.CreateAreaBasedLoad()

### Description
Creates a new instance of an area based load and adds it to the document.

### Method
CreateAreaBasedLoad

### Endpoint
Autodesk.Revit.DB.Mechanical.Zone.CreateAreaBasedLoad()
```

--------------------------------

### ImageType methods and properties

Source: https://revapidocs.com/2021/WhatsNew.htm

New methods and properties on ImageType provide information about how the image is created and its load status.

```APIDOC
## ImageType methods and properties

### Description
New methods and properties on ImageType provide information about how the image is created and its load status.

### Properties
- **ImageType.Source** - Indicates how the image is created (as a link, import, or internally-generated image).
- **ImageType.Status** - Indicates whether the image is loaded or unloaded (if applicable).

### Methods
- **ImageType.Unload()** - Unloads a linked image.
```

--------------------------------

### ColorFillSchemeEntry.StorageType

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets the storage type of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.StorageType

### Description
Gets the storage type of the color fill scheme entry.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### PanelScheduleView.SwitchPhases()

Source: https://revapidocs.com/2021/WhatsNew.htm

Switches the circuit phases at the slot.

```APIDOC
## PanelScheduleView.SwitchPhases()

### Description
Switches the circuit phases at the slot.

### Method
SwitchPhases

### Parameters
- **slot** (int) - Required - The slot index.

### Returns
Void.
```

--------------------------------

### ColorOptions.GetColorOptions()

Source: https://revapidocs.com/2021/WhatsNew.htm

Static method to access the color settings for the current Revit session. Returns a ColorOptions object with properties for various UI colors.

```APIDOC
## Method: Autodesk.Revit.DB.ColorOptions.GetColorOptions()

### Description
Provides access to color settings which affect the colors applied to specific views for the current session of Revit.

### Method
`static ColorOptions GetColorOptions()`

### Returns
`Autodesk.Revit.DB.ColorOptions` - The color options for the current session.

### Properties of ColorOptions
- `BackgroundColor` - The background color applied to views.
- `SelectionColor` - The color used to highlight selected elements.
- `SelectionSemitransparent` - Indicates whether or not selections will be shown in a semi-transparent manner.
- `PreselectionColor` - The color used to highlight candidates for selection before they are selected.
- `AlertColor` - The color used to highlight elements when a special alert is required.
- `CalculatingColor` - The color used to render elements when some aspect of their properties is currently being recalculated.
- `EditingColor` - The color used to render elements when editing.
```

--------------------------------

### ColorFillSchemeEntry.Color

Source: https://revapidocs.com/2022/WhatsNew.htm

Gets or sets the color of the color fill scheme entry.

```APIDOC
## ColorFillSchemeEntry.Color

### Description
Gets or sets the color of the color fill scheme entry.

### Method
Property

### Parameters
No parameters documented.

### Response
No response documented.
```

--------------------------------

### PointCloudType.GetReCapProject()

Source: https://revapidocs.com/2022/WhatsNew.htm

Provides a direct entry point to get access to an object from the ReCap SDK (ReCapWrapper.RCProject) from Revit. This object represents the point cloud from the RC file path stored in PointCloudType. The ReCap assembly ReCapWrapper.dll will need to be included into code using this method.

```APIDOC
## PointCloudType.GetReCapProject()

### Description
Provides a direct entry point to get access to an object from the ReCap SDK (ReCapWrapper.RCProject) from Revit. This object represents the point cloud from the RC file path stored in PointCloudType. The ReCap assembly ReCapWrapper.dll will need to be included into code using this method.

### Method
Method call

### Endpoint
PointCloudType.GetReCapProject()

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response details provided.

```

--------------------------------

### ElectricalLoadAreaData.CreateElectricalLoadAreas()

Source: https://revapidocs.com/2023/WhatsNew.htm

Creates electrical load areas on all the empty plan circuits of the given level.

```APIDOC
## ElectricalLoadAreaData.CreateElectricalLoadAreas()

### Description
Creates electrical load areas on all the empty plan circuits of the given level.

### Method
CreateElectricalLoadAreas()

### Parameters
- **level** (Level) - Required - The level on which to create electrical load areas.

### Returns
- **IList<ElectricalLoadArea>** - The created electrical load areas.

```

--------------------------------

### Document.Import(String, ImportOptions3DM, View)

Source: https://revapidocs.com/2022/WhatsNew.htm

Imports a 3DM file into the document. This method is part of the Import API additions for 2022.

```APIDOC
## [IMPORT] Document.Import(String, ImportOptions3DM, View)

### Description
Imports a 3DM file into the document.

### Method
Import

### Parameters
- **filePath** (String) - Required - The path to the 3DM file.
- **options** (ImportOptions3DM) - Required - Import options for the 3DM file.
- **view** (View) - Required - The view to import into.

### Response
No return value.
```

--------------------------------

### GBXMLExportOptions.ExportAnalyticalSystems

Source: https://revapidocs.com/2021/WhatsNew.htm

Property that should be set to true to export analytical system related items when exporting to gbXML.

```APIDOC
## [SET] GBXMLExportOptions.ExportAnalyticalSystems

### Description
Property that should be set to true to export analytical system related items when exporting to gbXML.

### Method
SET

### Endpoint
GBXMLExportOptions.ExportAnalyticalSystems

### Parameters
#### Property Value
- **value** (bool) - Required - Set to true to export analytical system related items.

### Request Example
No request body documented.

### Response
#### Success Response
No return value documented.

#### Response Example
No response body documented.
```

--------------------------------

### ViewSchedule.IsHeaderFrozen

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets or sets whether the header is frozen on a given schedule.

```APIDOC
## Property: ViewSchedule.IsHeaderFrozen

### Description
Gets or sets whether the header is frozen on a given schedule.

### Property
`ViewSchedule.IsHeaderFrozen`

### Type
Boolean

### Access
Read/Write

```

--------------------------------

### ElectricalSystem.LoadClassificationAbbreviations

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the load classification abbreviations used in the electrical system.

```APIDOC
## ElectricalSystem.LoadClassificationAbbreviations

### Description
Gets the load classification abbreviations used in the electrical system.

### Property
LoadClassificationAbbreviations

### Type
IList<string>

### Access
Read
```

--------------------------------

### ProjectBrowserOptions

Source: https://revapidocs.com/2023/WhatsNew.htm

New class providing access to settings that control Revit's Project Browser appearance and functionality. These settings are stored in the Revit.ini file.

```APIDOC
## Class: ProjectBrowserOptions

### Description
Provides access to settings that control Revit's Project Browser appearance and functionality. These settings are stored in the Revit.ini file. All documents in Revit instances which use this Revit.ini will follow these settings.

### Property
- `ShowViewPlacementOnSheetStatusIcons` - Shows the icons indicating view placement on sheet status. If true, the icons indicating view placement on sheet status will be shown at every view or schedule node in the Project Browser. If false, the icons indicating view placement on sheet status will not be shown.
```

--------------------------------

### ElectricalSystem.PhaseLabel

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the circuit phase label used in the electrical system.

```APIDOC
## ElectricalSystem.PhaseLabel

### Description
Gets the circuit phase label used in the electrical system.

### Property
PhaseLabel

### Type
string

### Access
Read
```

--------------------------------

### StructuralConnectionHandler.Create(Document, IList<ElementId>, ElementId, IList<XYZ>)

Source: https://revapidocs.com/2021/WhatsNew.htm

Creates a structural connection that requires additional input points. This method allows specifying the document, element IDs, a type ID, and the input point locations.

```APIDOC
## [METHOD] StructuralConnectionHandler.Create(Document, IList<ElementId>, ElementId, IList<XYZ>)

### Description
Creates a structural connection that requires additional input points.

### Method
Create

### Parameters
- **document** (Document) - Required - The document in which to create the connection.
- **elementIds** (IList<ElementId>) - Required - The element IDs to connect.
- **typeId** (ElementId) - Required - The ID of the connection type.
- **inputPoints** (IList<XYZ>) - Required - The additional input point locations.

### Response
Returns a StructuralConnectionHandler object representing the created connection.
```

--------------------------------

### ViewSystemsAnalysisReport.RequestSystemsAnalysis()

Source: https://revapidocs.com/2021/WhatsNew.htm

Requests the systems analysis from a view instance. The analysis runs in the background, and when completed, the related views are automatically updated.

```APIDOC
## [REQUEST] ViewSystemsAnalysisReport.RequestSystemsAnalysis()

### Description
Requests the systems analysis from a view instance. The analysis runs in the background, and when completed, the related views are automatically updated.

### Method
REQUEST

### Endpoint
ViewSystemsAnalysisReport.RequestSystemsAnalysis()

### Parameters
None documented.

### Request Example
No request body documented.

### Response
#### Success Response
Initiates the background analysis. Use RequestSystemsAnalysis.IsAnalysisCompleted to check completion.

#### Response Example
No response body documented.
```

--------------------------------

### ElectricalSystem.SlotIndex

Source: https://revapidocs.com/2021/WhatsNew.htm

Gets the slot index where the electrical system is located in its panel.

```APIDOC
## ElectricalSystem.SlotIndex

### Description
Gets the slot index where the electrical system is located in its panel.

### Property
SlotIndex

### Type
int

### Access
Read
```

--------------------------------

### TLS setting: correct inclusive assignment

Source: https://revapidocs.com/2021/WhatsNew.htm

Specify the protocol/version inclusively using bitwise OR to preserve Revit's native TLS configuration.

```csharp
System.Net.ServicePointManager.SecurityProtocol |= System.Net.SecurityProtocolType.Tls12;
```
Tokens:
Raw