Tapir Additional JSON Commands

https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon
Admin
Tapir Additional JSON Commands is an Archicad add-on that registers new JSON-based commands for...
Tokens:200,721
Snippets:1,097
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### GetModelViewOptions

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets all model view options.

```APIDOC
## GetModelViewOptions

### Description
Gets all model view options.

### Output Parameters
- **modelViewOptions** (array of objects) - List of model view options.
  - **name** (string) - Required - The name of the model view option.
```

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

### CreateWindows

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Window elements in host walls based on the given parameters.

```APIDOC
## CreateWindows

### Description
Creates Window elements in host walls based on the given parameters.

### Method
POST

### Endpoint
/CreateWindows

### Parameters
#### Request Body
- **windowsData** (array) - Required - List of window data objects.
  - **ownerWallId** (object) - Required - The identifier of the host wall. Contains guid (string, uuid).
  - **centerOffset** (number) - Required - Offset from the center of the wall.
  - **sillHeight** (number) - Optional - Height of the sill.
  - **width** (number) - Optional - Width of the window.
  - **height** (number) - Optional - Height of the window.
  - **reflected** (boolean) - Optional - Whether the window is reflected.
  - **refSide** (boolean) - Optional - Reference side.
  - **oSide** (boolean) - Optional - Other side.
  - **favoriteName** (string) - Optional - Name of an existing Window favorite (as returned by `GetFavoritesByType`). Applied to the Window tool defaults before the create.

### Response
#### Success Response (200)
- **elements** (array) - List of element identifiers or errors. Each item is an ElementIdOrError object with either elementId (ElementId) or error (Error).
  - **elementId** (object) - Contains guid (string, uuid).
  - **error** (object) - Contains code (integer) and message (string).
```

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

### GetDetailsOfElements

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets the details of the given elements (geometry parameters etc). Use the optional fields parameter to return only the fields you need and skip the computation of the others (for example floorPlanPolygons).

```APIDOC
## GetDetailsOfElements

### Description
Gets the details of the given elements (geometry parameters etc). Use the optional fields parameter to return only the fields you need and skip the computation of the others (for example floorPlanPolygons).

### Method
POST

### Endpoint
GetDetailsOfElements

### Parameters
#### Request Body
- **elements** (Elements) - Required - A list of elements.
- **fields** (array of ElementDetailsField) - Optional - Optional filter for the fields to return for each element. When omitted, every field is returned. Fields not listed are not computed at all, so listing only what you need skips in particular the floorPlanPolygons extraction, which regenerates each element's 2D drawing primitives and can dominate the execution time of batch reads.

### Request Example
{
  "elements": [
    {
      "elementId": {
        "guid": "string"
      }
    }
  ],
  "fields": [
    "string"
  ]
}

### Response
#### Success Response (200)
- **detailsOfElements** (array of DetailsOfElement) - The details of the elements. When the optional fields filter is given in the input, only the requested fields are present; the required list below applies to unfiltered requests.
  - **type** (ElementType) - Required - The type of an element.
  - **id** (string) - Required - The identifier of the element.
  - **floorIndex** (number) - Required - The floor index of the element.
  - **layerIndex** (number) - Required - The layer index of the element.
  - **drawIndex** (number) - Required - The draw index of the element.
  - **hotlinkId** (ElementId) - Required - The identifier of the hotlink.
  - **details** (TypeSpecificDetails) - Required - The type-specific details of the element.

#### Response Example
{
  "detailsOfElements": [
    {
      "type": "string",
      "id": "string",
      "floorIndex": 0,
      "layerIndex": 0,
      "drawIndex": 0,
      "hotlinkId": {
        "guid": "string"
      },
      "details": {}
    }
  ]
}
```

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

### DeleteElements

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Deletes elements. Returns an execution result for each input element: an element that could not be deleted (for example because its layer is locked) gets a failed execution result instead of being skipped silently.

```APIDOC
## DeleteElements

### Description
Deletes elements. Returns an execution result for each input element: an element that could not be deleted (for example because its layer is locked) gets a failed execution result instead of being skipped silently.

### Method
POST

### Endpoint
DeleteElements

### Parameters
#### Request Body
- **elements** (array) - Required - A list of elements.
  - **elementId** (object) - Required - The identifier of the element.
    - **guid** (string, uuid) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

### Response
#### Success Response (200)
- **executionResults** (array) - A list of execution results.
  - **success** (boolean) - Indicates success.
  - **error** (object) - Details of an error (only for failed execution).
    - **code** (integer) - The code of the error.
    - **message** (string) - The error message.
```

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

### CreateOpenings1.4.0

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Opening elements in the given host elements.

```APIDOC
## CreateOpenings1.4.0

### Description
Creates Opening elements in the given host elements.

### Method
POST

### Endpoint
CreateOpenings1.4.0

### Parameters
#### Request Body
- **openingsData** (array) - Required - List of opening data objects.
  - **ownerElementId** (ElementId) - Required - The identifier of the host element.
    - **guid** (Guid string) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **basePoint** (Coordinate3D) - Required - 3D coordinate.
    - **x** (number) - Required - X value of the coordinate.
    - **y** (number) - Required - Y value of the coordinate.
    - **z** (number) - Required - Z value of the coordinate.
  - **width** (number) - Optional - Width of the opening.
  - **height** (number) - Optional - Height of the opening.

### Request Example
{
  "openingsData": [
    {
      "ownerElementId": {
        "guid": "string"
      },
      "basePoint": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "width": 0,
      "height": 0
    }
  ]
}

### Response
#### Success Response (200)
- **elements** (ElementIdsOrErrors) - Required - A list of element identifiers or errors.
  - **ElementIdOrError** - An element identifier or an error.
    - **elementId** (ElementId) - The identifier of an element.
      - **guid** (Guid string) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
    - **error** (Error) - The details of an error.
      - **code** (integer) - The code of the error.
      - **message** (string) - The error message.

#### Response Example
{
  "elements": [
    {
      "elementId": {
        "guid": "string"
      }
    }
  ]
}
```

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

### OpenProject

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Opens the given project. This operation accepts a project file path and returns an execution result indicating success or failure.

```APIDOC
## OpenProject

### Description
Opens the given project.

### Method
POST

### Endpoint
OpenProject

### Parameters
#### Request Body
- **projectFilePath** (string) - Required - The target project file to open.

### Response
#### Success Response (200)
- **ExecutionResult** (object) - The result of the execution. One of:
  - **SuccessfulExecutionResult** (object) - The result of a successful execution.
    - **success** (boolean) - Required - Enum: [1]
  - **FailedExecutionResult** (object) - The result of a failed execution.
    - **success** (boolean) - Required - Enum: [1]
    - **error** (object) - The details of an error.
      - **code** (integer) - Required - The code of the error.
      - **message** (string) - Required - The error message.

#### Response Example
{
  "success": true
}
```

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

### GetView2DTransformations

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Get zoom and rotation of 2D views.

```APIDOC
## GetView2DTransformations

### Description
Get zoom and rotation of 2D views.

### Method
POST

### Endpoint
GetView2DTransformations

### Parameters
#### Request Body
- **navigatorItemIds** (array) - Required - A list of navigator item identifiers.
  - **navigatorItemId** (object) - Required - The identifier of a navigator item.
    - **guid** (string, uuid) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
- **databases** (array) - Required - A list of Archicad databases.
  - **databaseId** (object) - Required - The identifier of a database.
    - **guid** (string, uuid) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
```

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

### CreateLayout

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Layouts and their backing master layouts.

```APIDOC
## CreateLayout

### Description
Creates Layouts and their backing master layouts.

### Input Parameters
- **layoutsData** (array) - Required - A list of objects, each containing:
  - **masterLayoutName** (string) - Optional - Minimum length 1.
  - **masterNavigatorItemId** (NavigatorItemId) - Optional - Contains `guid` (string, UUID format).
  - **layoutName** (string) - Required - Minimum length 1.
  - **parentNavigatorItemId** (NavigatorItemId) - Optional - Contains `guid` (string, UUID format).
  - **layoutParameters** (object) - Optional - Contains:
    - **horizontalSize** (number)
    - **verticalSize** (number)
    - **leftMargin** (number)
    - **topMargin** (number)
    - **rightMargin** (number)
    - **bottomMargin** (number)
    - **customLayoutNumber** (string)
    - **customLayoutNumbering** (boolean)
    - **doNotIncludeInNumbering** (boolean)
    - **displayMasterLayoutBelow** (boolean)

### Output Parameters
- **databases** (DatabaseIdsOrErrors) - A list of Archicad database identifiers or errors. Each item can be either a `DatabaseIdArrayItem` (with `databaseId` containing `guid`) or an `ErrorItem` (with `error` containing `code` and `message`).
```

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

### GetViewSettings

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets the view settings of navigator items.

```APIDOC
## GetViewSettings

### Description
Gets the view settings of navigator items.

### Input Parameters
- **navigatorItemIds** (NavigatorItemIds) - Required - A list of navigator item identifiers.
  - **navigatorItemId** (NavigatorItemId) - Required - The identifier of a navigator item.
    - **guid** (Guid) - Required - A Globally Unique Identifier (UUID).

### Output Parameters
- **viewSettings** (array of ViewSettingsOrError) - List of view settings or errors.
  - **ViewSettings** - The settings of a navigator view.
    - **modelViewOptions** (string) - The name of the model view options. If empty, the view has custom model view options.
    - **layerCombination** (string) - The layer combination.
```

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

### CreateKeynoteItems

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates keynote items in the given parent folders (or in the root folder). Available from Archicad 28.

```APIDOC
## CreateKeynoteItems

### Description
Creates keynote items in the given parent folders (or in the root folder). Available from Archicad 28.

### Input Parameters
- **itemsData** (array of objects) - Required - Array of data to create keynote items.
  - **parentFolderId** (KeynoteFolderId) - The identifier of a keynote folder.
    - **guid** (string, uuid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **key** (string, minLength:1) - The key of the keynote item.
  - **title** (string) - The title of the keynote item.
  - **description** (string) - The description of the keynote item.
  - **reference** (string) - The reference of the keynote item.

### Output Parameters
- **keynoteItemIdsOrErrors** (array of KeynoteItemIdOrError) - A list of keynote item identifiers or errors.
  - **KeynoteItemIdArrayItem** - A keynote item identifier.
    - **keynoteItemId** (KeynoteItemId) - The identifier of a keynote item.
      - **guid** (string, uuid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **ErrorItem** - An error item.
    - **error** (Error) - The details of an error.
      - **code** (integer) - The code of the error.
      - **message** (string) - The error message.
```

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

### CreateKeynoteFolders

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates keynote folders under the given parent folders (or under the root folder). Available from Archicad 28.

```APIDOC
## CreateKeynoteFolders

### Description
Creates keynote folders under the given parent folders (or under the root folder). Available from Archicad 28.

### Input Parameters
- **foldersData** (array of objects) - Required - Array of data to create keynote folders.
  - **parentFolderId** (KeynoteFolderId) - The identifier of a keynote folder.
    - **guid** (string, uuid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **key** (string, minLength:1) - The key of the keynote folder.
  - **title** (string) - The title of the keynote folder.

### Output Parameters
- **keynoteFolderIdsOrErrors** (array of KeynoteFolderIdOrError) - A list of keynote folder identifiers or errors.
  - **KeynoteFolderIdArrayItem** - A keynote folder identifier.
    - **keynoteFolderId** (KeynoteFolderId) - The identifier of a keynote folder.
      - **guid** (string, uuid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **ErrorItem** - An error item.
    - **error** (Error) - The details of an error.
      - **code** (integer) - The code of the error.
      - **message** (string) - The error message.
```

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

### GetUserGSID

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Get the current registered User-GSID and OrganizationsID.

```APIDOC
## GetUserGSID

### Description
Get the current registered User-GSID and OrganizationsID. Requires Archicad 27 or later.

### Method
ExecuteAddOnCommand

### Endpoint
TapirCommand.GetUserGSID

### Parameters
None

### Response
#### Success Response
- **userId** (string) - Required - The stable GSID User ID of the logged-in user.
- **organizationIds** (array of string) - Required - The list of organization IDs the user belongs to. Empty if not part of any organization or if the information cannot be retrieved.

#### Response Example
{
  "userId": "user123",
  "organizationIds": ["org1", "org2"]
}
```

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

### GetSuspendGroupsMode

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets the current state of the Suspend Groups mode.

```APIDOC
## GetSuspendGroupsMode

### Description
Gets the current state of the Suspend Groups mode.

### Output Parameters
- **suspendGroups** (boolean) - True if the Suspend Groups mode is currently on.
```

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

### CreateViewMapFolder

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates a new folder in the View Map.

```APIDOC
## CreateViewMapFolder

### Description
Creates a new folder in the View Map.

### Input Parameters
- **folderName** (string) - Required - Name of the new folder to create in the View Map.
- **parentNavigatorItemId** (NavigatorItemId) - Required - The identifier of a navigator item.
  - **guid** (Guid string) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

### Output Parameters
- **navigatorItems** (array of NavigatorItemIdOrError) - Required - A list of navigator item IDs or errors.
  - **navigatorItemId** (NavigatorItemId) - Optional - The identifier of a navigator item.
    - **guid** (Guid string) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **error** (Error) - Optional - The details of an error.
    - **code** (integer) - Required - The code of the error.
    - **message** (string) - Required - The error message.
```

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

### CreateDoors

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Door elements in host walls based on the given parameters.

```APIDOC
## CreateDoors

### Description
Creates Door elements in host walls based on the given parameters.

### Method
POST

### Endpoint
/CreateDoors

### Parameters
#### Request Body
- **doorsData** (array) - Required - List of door data objects.
  - **ownerWallId** (object) - Required - The identifier of the host wall. Contains guid (string, uuid).
  - **centerOffset** (number) - Required - Offset from the center of the wall.
  - **sillHeight** (number) - Optional - Height of the sill.
  - **width** (number) - Optional - Width of the door.
  - **height** (number) - Optional - Height of the door.
  - **reflected** (boolean) - Optional - Whether the door is reflected.
  - **refSide** (boolean) - Optional - Reference side.
  - **oSide** (boolean) - Optional - Other side.
  - **favoriteName** (string) - Optional - Name of an existing Door favorite (as returned by `GetFavoritesByType`). Applied to the Door tool defaults before the create.

### Response
#### Success Response (200)
- **elements** (array) - List of element identifiers or errors. Each item is an ElementIdOrError object with either elementId (ElementId) or error (Error).
  - **elementId** (object) - Contains guid (string, uuid).
  - **error** (object) - Contains code (integer) and message (string).
```

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

### GetElementsOfGroups

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets the elements directly contained by each given group.

```APIDOC
## GetElementsOfGroups

### Description
Gets the elements directly contained by each given group.

### Input Parameters
- **groups** (array of GroupIdArrayItem) - Required - The groups to get the elements of.
  - **groupId** (GroupId) - The identifier of a group.
    - **guid** (Guid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

### Output Parameters
- **elementsOfGroups** (array of ElementsWrapperOrError) - The elements directly contained by each given group, or an error.
  - **ElementsWrapper** - A list of elements wrapped in an object.
    - **elements** (array of ElementIdArrayItem) - A list of elements.
      - **elementId** (ElementId) - The identifier of an element.
        - **guid** (Guid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **ErrorItem** - An error.
    - **error** (Error) - The details of an error.
      - **code** (integer) - The code of the error.
      - **message** (string) - The error message.
```

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

### CreateSections

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Section elements on the floor plan.

```APIDOC
## CreateSections

### Description
Creates Section elements on the floor plan.

### Input Parameters
- **sectionsData** (array of objects) - Required
  - **startCoordinate** (Coordinate2D) - Required - 2D coordinate.
    - **x** (number) - Required - X value of the coordinate.
    - **y** (number) - Required - Y value of the coordinate.
  - **endCoordinate** (Coordinate2D) - Required - 2D coordinate.
    - **x** (number) - Required - X value of the coordinate.
    - **y** (number) - Required - Y value of the coordinate.
  - **depth** (number) - Optional
  - **name** (string) - Optional
  - **floorIndex** (integer) - Optional

### Output Parameters
- **elements** (array of objects) - Required - A list of element identifiers or errors.
  - **one of:**
    - **elementId** (ElementId) - Required - The identifier of an element.
      - **guid** (string, uuid) - Required - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
    - **error** (Error) - Required - The details of an error.
      - **code** (integer) - Required - The code of the error.
      - **message** (string) - Required - The error message.
```

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

### GetGroupsOfElements

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Gets the identifier of the group that directly contains each given element.

```APIDOC
## GetGroupsOfElements

### Description
Gets the identifier of the group that directly contains each given element.

### Input Parameters
- **elements** (array of ElementIdArrayItem) - Required - The elements to get the groups of.
  - **elementId** (ElementId) - The identifier of an element.
    - **guid** (Guid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

### Output Parameters
- **groupGuids** (array of GroupIdOrError) - The identifier of the group that directly contains each given element, or an error for elements that are not part of any group.
  - **GroupIdArrayItem** - A wrapper containing the group identifier.
    - **groupId** (GroupId) - The identifier of a group.
      - **guid** (Guid) - A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
  - **ErrorItem** - An error.
    - **error** (Error) - The details of an error.
      - **code** (integer) - The code of the error.
      - **message** (string) - The error message.
```

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

### CreateLayoutSubset

Source: https://enzyme-apd.github.io/tapir-archicad-automation/archicad-addon

Creates Layout Book subsets with specified properties and returns the created navigator item identifiers or errors.

```APIDOC
## CreateLayoutSubset

### Description
Creates Layout Book subsets.

### Input Parameters
- **subsetsData** (array) - Required - List of subset data objects.
  - **name** (string) - Required - Name of the subset (minLength: 1).
  - **parentNavigatorItemId** (object) - Required - Identifier of the parent navigator item.
    - **guid** (string) - Required - UUID of the navigator item.
  - **ownPrefix** (string) - Optional - Custom prefix for the subset.
  - **customNumber** (string) - Optional - Custom number for the subset.
  - **numberingStyle** (string) - Optional - Enum: Array[8].
  - **startAt** (integer) - Optional - Starting number.
  - **continueNumbering** (boolean) - Optional - Whether to continue numbering.
  - **useUpperPrefix** (boolean) - Optional - Whether to use upper prefix.
  - **includeToIDSequence** (boolean) - Optional - Whether to include in ID sequence.
  - **customNumbering** (boolean) - Optional - Whether to use custom numbering.
  - **addOwnPrefix** (boolean) - Optional - Whether to add own prefix.

### Output Parameters
- **navigatorItems** (array) - Required - List of navigator item identifiers or errors.
  - **navigatorItemId** (object) - Optional - Identifier of the created navigator item.
    - **guid** (string) - Required - UUID of the navigator item.
  - **error** (object) - Optional - Error details.
    - **code** (integer) - Required - Error code.
    - **message** (string) - Required - Error message.
```
Tokens:
Raw