Additional JSON/Python Commands Add-On for Archicad

This Add-On extends the JSON interface of Archicad by implementing new JSON commands.
These JSON commands are callable via Python, see examples below.

Download the Add-On or build it for your own platform and Archicad version.

• Download the Add-On for Archicad 26 for Windows platform
• Download the Add-On for Archicad 25 for Windows platform

Requires Archicad 25 or later.

Implemented Commands

• Publish
• GetProjectInfo
• TeamworkReceive
• GetArchicadLocation
• Quit
• ReloadLibraries
• MoveElements
• CreateColumns
• CreateSlabs
• CreateObjects
• GetHotlinks
• GetGDLParametersOfElements
• ChangeGDLParametersOfElements

Publish

Performs a publish operation on the currently opened project. Only the given publisher set will be published.

Parameters

• publisherSetName (required)
  • Type: string
  • The name of the publisher set.
• outputPath
  • Type: string
  • Full local or LAN path for publishing. Optional, by default the path set in the settings of the publiser set will be used.

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

publisherSetNames = acc.GetPublisherSetNames ()
for publisherSetName in publisherSetNames:
  parameters = { 'publisherSetName': publisherSetName }
  acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'Publish'), parameters)

GetProjectInfo

Retrieves the location of the currently running Archicad executable.

Parameters

Response

• isUntitled (required)
  • Type: string
  • True, if the project is not saved yet.
• isTeamwork (required)
  • Type: string
  • True, if the project is a Teamwork (BIMcloud) project.
• projectLocation
  • Type: string
  • The location of the project in the filesystem or a BIMcloud project reference.
• projectPath
  • Type: string
  • The path of the project. A filesystem path or a BIMcloud server relative path.
• projectName
  • Type: string
  • The name of the project.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

response = acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'GetProjectInfo'))
isTeamwork = response['isTeamwork']
if not response['isUntitled']:
  projectLocation = response['projectLocation']

TeamworkReceive

Performs a receive operation on the currently opened Teamwork (BIMcloud) project.

Parameters

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'TeamworkReceive'))

GetArchicadLocation

Retrieves the location of the currently running Archicad executable.

Parameters

Response

• archicadLocation (required)
  • Type: string
  • The location of the Archicad executable in the filesystem.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

response = acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'GetArchicadLocation'))
archicadLocation = response['archicadLocation']

Quit

Performs a quit operation on the currently running Archicad instance.

Parameters

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'TeamworkReceive'))

ReloadLibraries

Reloads the libraries of the current Archicad project.

Parameters

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'ReloadLibraries'))

MoveElements

Moves elements with a given movement vector.

Parameters

• elementsWithMoveVectors (required)
  • Type: array
  • Items:
    • Type: object
    • Fields:
      • elementId (required)
        • Type: Element identifier object (guid field)
      • moveVector (required)
        • Type: 3D vector object (x, y, z fields).

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

objects = acc.GetElementsByType ('Object')
elementsWithMoveVectors = [{'elementId': {'guid': str (object.elementId.guid)}, 'moveVector': {'x': 1.0, 'y': 1.0, 'z': 0.0}} for object in objects]

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'MoveElements'), {'elementsWithMoveVectors': elementsWithMoveVectors})

CreateColumns

Creates columns. The given coordinates will be origos of the columns.

Parameters

• coordinates (required)
  • Type: array of 3D coordinates with x,y,z values

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

storyHeight = 3.0
origosOfNewColumns = [{'x': x*2, 'y': y*2, 'z': z*storyHeight} for x in range(10) for y in range(10) for z in range(2)]

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'CreateColumns'), {'coordinates': origosOfNewColumns})

CreateSlabs

Creates polygonal slabs. The given coordinates will define the polygon of the edges.

Parameters

• slabs (required)
  • Type: object
  • Fields:
    • level (required)
      • Type: number
      • The elevation of the slab, the Z coordinate of the reference line.
    • polygonCoordinates (required)
      • Type: array of 2D coordinates with x,y values.
    • holes (optional)
      • polygonCoordinates (optional)
        • Type: array of 2D coordinates with x,y values.

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

origo = {'x': 0, 'y': 0, 'z': 0}
slabWidth = 6.0
slabHoleWidth = 2.0
storyHeight = 3.0

slabPolygonCoordinates = [
    {'x': +3.0, 'y': -3.0},
    {'x': +3.0, 'y': +3.0},
    {'x': -3.0, 'y': +3.0},
    {'x': -3.0, 'y': -3.0}
]
slabHolePolygonCoordinates = [
    {'x': +1.0, 'y': -1.0},
    {'x': +1.0, 'y': +1.0},
    {'x': -1.0, 'y': +1.0},
    {'x': -1.0, 'y': -1.0}
]

slabs = [{
    'level': i * storyHeight,
    'polygonCoordinates': slabPolygonCoordinates,
    'holes': [{'polygonCoordinates': slabHolePolygonCoordinates}]
} for i in range(3)]

acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'CreateSlabs'), {'slabs': slabs})

CreateObjects

Creates library part based objects. The given coordinate will be the origo of the object.

Parameters

• objects (required)
  • Type: object
  • Fields:
    • name (required)
      • Type: string
      • The name of the library part.
    • coordinate (required)
      • Type: 3D coordinates with x,y,z values.
    • dimensions (required)
      • Type: Size coordinates with x,y,z values.

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

treeParameters = [{'name': 'Tree Model Detailed 26',
                    'coordinate': {'x': 0, 'y': 0, 'z': 0},
                    'dimensions': {'x': 2, 'y': 2, 'z': 10}}]
acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'CreateObjects'), {'objects': treeParameters})

GetHotlinks

Get the file system locations (path) of the hotlink modules. The hotlinks can have tree hierarchy in the project.

Response

• hotlinks (required)
  • Type: array
  • List of hotlinks with locations and the children in the tree hierarchy.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

print (acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'GetHotlinks')))

GetGDLParametersOfElements

Get all the GDL parameters (name, type, value) of the given elements.

Parameters

• elements (required)
  • Type: array
  • Items:
    • Type: object
    • Fields:
      • elementId (required)
        • Type: Element identifier object (guid field)

Response

• gdlParametersOfElements (required)
  • Type: array of GDL parameters dictionary.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

elements = [ { 'elementId' : { 'guid' : str (e.elementId.guid) } } for e in acc.GetElementsByType ('Object') ]

print (acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'GetGDLParametersOfElements', { 'elements' : elements })))

ChangeGDLParametersOfElements

Changes the given GDL parameters of the given elements.

Parameters

• elementsWithGDLParameters (required)
  • Type: array
  • Items:
    • Type: object
    • Fields:
      • elementId (required)
        • Type: Element identifier object (guid field)
      • gdlParameters (required)
        • Type: The dictionary of GDL parameters with the new values.

Response

• errorMessage
  • Type: string
  • The error message upon error. If the command executed successfully, then there is no response.

Python Example

from archicad import ACConnection

conn = ACConnection.connect ()

acc = conn.commands
act = conn.types

elementsWithGDLParameters = [ { 'elementId' : { 'guid' : str (e.elementId.guid) }, 'gdlParameters' : { 'gs_cont_pen' : 95 } } for e in acc.GetElementsByType ('Object') ]

print (acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'ChangeGDLParametersOfElements', { 'elementsWithGDLParameters' : elementsWithGDLParameters })))