Mutations
createExchange
Creates an exchange on the specified source and target files to enable data sharing between project stakeholders.
Template for Query:
mutation CreateExchange($input: CreateExchangeInput!){
createExchange(input: $input) {
#CreateExchange Fields
}
}
Template for Query Variables:
{
"input" : "<SOME-CREATEEXCHANGE-INPUT-TYPE-SCALAR-VALUE>"
}
Arguments
| input* CreateExchangeInput non-null | The input for creating an exchange. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| CreateExchangeResult | Represents the result of creating an exchange. |
Examples
Example 1
Create 3D View Exchange using Publish workflow.
Mutation:
mutation CreateExchange(
$viewName: String
$sourceFileId: String!
$targetExchangeName: String!
$targetFolderId: String!
) {
createExchange(
input: {
viewName: $viewName
source: { fileId: $sourceFileId }
target: { name: $targetExchangeName, folderId: $targetFolderId }
}
) {
exchange {
id
name
elements {
results {
id
name
}
}
}
}
}
Show More
Mutation Variables:
{
"viewName": "FourWalls_3D",
"sourceFileId": "aXRlbX5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJRfnVybjphZHNrLndpcHByb2Q6ZG0ubGluZWFnZTpCVGJ3enVuSlFRU0wwTVBsbFhNVDZB",
"targetExchangeName": "3D View Category Door Exchange",
"targetFolderId": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJR"
}
Response:
{
"data": {
"createExchange": {
"exchange": {
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjY0MDJjMzFkLTg4Y2QtM2NjYy05MjY4LTE1ZmUyMmY0ODMwYg",
"name": "3D View Category Door Exchange",
"elements": {
"results": [
{
"id": "6CD2C9602D7D8878069B4F2A52431C4F82F942D3",
"name": "Level 1"
},
{
"id": "E700279D3C18E48406E9369085BF3A3D639C3575",
"name": "New Construction"
},
{
"id": "627E20C02DB930726F6BCADAB32FEE60037D0271",
"name": "Level 2"
}
]
}
}
}
}
}
Show More
Example 2
Create an exchange by providing AECDM filters for extracting more granular data.
Mutation:
mutation CreateExchange(
$filter: String
$sourceFileId: String!
$targetExchangeName: String!
$targetFolderId: String!
) {
createExchange(
input: {
filter: $filter
source: { fileId: $sourceFileId }
target: { name: $targetExchangeName, folderId: $targetFolderId }
}
) {
exchange {
id
name
elements {
results {
id
name
}
}
}
}
}
Show More
Mutation Variables:
{
"filter": "(category=='Windows')",
"sourceFileId": "aXRlbX5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJRfnVybjphZHNrLndpcHByb2Q6ZG0ubGluZWFnZTpCVGJ3enVuSlFRU0wwTVBsbFhNVDZB",
"targetExchangeName": "AEC Filter based Exchange - Category Windows",
"targetFolderId": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJR"
}
Response:
{
"data": {
"createExchange": {
"exchange": {
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjU1NGEzMGMzLTkxYWMtMzIwNC04NzVmLWM0MDc3ZjJkZDI1YQ",
"name": "AEC Filter based Exchange - Category Windows",
"elements": {
"results": [
{
"id": "YWVjZX53TGhzYkpOSmVndGM5QlVsaFB6a2xwX0wyQ35CVGJ3enVuSlFRU0wwTVBsbFhNVDZBXzU3YmEy",
"name": "36\" x 48\""
}
]
}
}
}
}
}
Show More
Example 3
Create an exchange by providing IFC filters for extracting more granular data.
Mutation:
mutation CreateExchange(
$filter: String
$sourceFileId: String!
$targetExchangeName: String!
$targetFolderId: String!
) {
createExchange(
input: {
filter: $filter
source: { fileId: $sourceFileId }
target: { name: $targetExchangeName, folderId: $targetFolderId }
}
) {
exchange {
id
name
elements {
results {
id
name
}
}
}
}
}
Show More
Mutation Variables:
{
"filter": "ifcClass=in=(IfcDoor)",
"sourceFileId": "aXRlbX5iLjVjMDdjODRjLWJiZDktNDc2ZS04NzEyLTU0N2Y3NGM1Yjc2Yn5iLjg0ZmJiNTg3LTJmYWUtNDlkNy1iYmZhLTVjYmJkNWIxNjgyOH51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLmFlNzlOOFJIUTJtWnYyOHo3cF9vekF-dXJuOmFkc2sud2lwc3RnOmRtLmxpbmVhZ2U6RG5ySVZRNVNUd2FINk5XZXNDVS1Pdw",
"targetExchangeName": "IFC Filter based Exchange - IFC Class- IfcDoor",
"targetFolderId": "Zm9sZH5iLjVjMDdjODRjLWJiZDktNDc2ZS04NzEyLTU0N2Y3NGM1Yjc2Yn5iLjg0ZmJiNTg3LTJmYWUtNDlkNy1iYmZhLTVjYmJkNWIxNjgyOH51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLmFlNzlOOFJIUTJtWnYyOHo3cF9vekE"
}
Response:
{
"data": {
"createExchange": {
"exchange": {
"id": "ZXhjfkJ3WlJiS01jYU9lUDhuOTZSZWtpYVFfTDJDfmEwZTBmYzUyLWMzZjgtMzg3OS05YmMwLTRmMTY3NDNhOTE5ZA",
"name": "IFC Filter based Exchange - IFC Class- IfcDoor",
"elements": {
"results": [
{
"id": "66C096214CF868C87897CAAE800045B5CC9B0FA6",
"name": "Single-Flush:36\" x 84\":359363"
},
{
"id": "16F8B0BE54FA26AD8F2FE96CF062A70DB02657D1",
"name": "Frame/Mullion"
},
{
"id": "B9DA087FECCF4CE128318B08AA19D9D8256BF986",
"name": "Panel"
},
{
"id": "0700F206A1D9E0CFB8D785262788D8B59A3476CC",
"name": "Level 1"
},
{
"id": "D52633CBACB7AD1EC88CE72F542F1BA2DD9442EE",
"name": ""
},
{
"id": "BB2C97B77EA8F78CB36F9511EA36ED5E2CE6A486",
"name": "Default"
}
]
}
}
}
}
}
Show More