Polygon

Add

POST/api/gateway/v2/polygon/add

Add a new Polygon to the Project

Request Body

application/json

Options for the Polygon to add

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Id (GUID) of the stored Project.

modelId?|

Gets or sets the model id to use for the new polygon.

materialId?|

Gets or sets the material id to use for the new polygon's main category link material.

parentPolygonId?|

Optional Id of the parent Polygon. The newly created Polygon will be added as a chained child of this Polygon.

polygonTypeId?|

Gets or sets the polygon type id to use for the new polygon's main category link material.

materialCode?|

Gets or sets the material code to use for the new polygon's main category link material.

width?|

Gets or sets the width to use for the new polygon.

height?|

Gets or sets the height to use for the new polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/add" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Add (Diff)

POST/api/gateway/v2/polygon/adddiff

Add a new Polygon to the Project

Request Body

application/json

Options for the Polygon to add

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Id (GUID) of the stored Project.

modelId?|

Gets or sets the model id to use for the new polygon.

materialId?|

Gets or sets the material id to use for the new polygon's main category link material.

parentPolygonId?|

Optional Id of the parent Polygon. The newly created Polygon will be added as a chained child of this Polygon.

polygonTypeId?|

Gets or sets the polygon type id to use for the new polygon's main category link material.

materialCode?|

Gets or sets the material code to use for the new polygon's main category link material.

width?|

Gets or sets the width to use for the new polygon.

height?|

Gets or sets the height to use for the new polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/adddiff" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Add with preset

POST/api/gateway/v2/polygon/addwithpreset

Add a new Polygon to the Project using a CategoryPreset

Request Body

application/json

Options for the Polygon to add

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Id (GUID) of the stored Project.

categoryPresetId?|

CategoryPreset.Id

categoryPresetExternalReference?|

CategoryPreset.ExternalReference

parentPolygonId?|

Optional Id of the parent Polygon. The newly created Polygon will be added as a chained child of this Polygon.

width?|

Sets the width to use for the new polygon.

height?|

Sets the height to use for the new polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/addwithpreset" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Add with preset (Diff)

POST/api/gateway/v2/polygon/addwithpresetdiff

Add a new Polygon to the Project using a CategoryPreset

Request Body

application/json

Options for the Polygon to add

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Id (GUID) of the stored Project.

categoryPresetId?|

CategoryPreset.Id

categoryPresetExternalReference?|

CategoryPreset.ExternalReference

parentPolygonId?|

Optional Id of the parent Polygon. The newly created Polygon will be added as a chained child of this Polygon.

width?|

Sets the width to use for the new polygon.

height?|

Sets the height to use for the new polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/addwithpresetdiff" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Apply preset

POST/api/gateway/v2/polygon/applypreset

Apply a CategoryPreset to a Polygon

Request Body

application/json

Options for the CategoryPreset to apply

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the preset to apply for a specified polygon.

polygonId*string

Gets or sets the polygon id.

categoryPresetId?|

CategoryPreset.Id

categoryPresetExternalReference?|

CategoryPreset.ExternalReference

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/applypreset" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Apply preset (Diff)

POST/api/gateway/v2/polygon/applypresetdiff

Apply a CategoryPreset to a Polygon

Request Body

application/json

Options for the CategoryPreset to apply

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the preset to apply for a specified polygon.

polygonId*string

Gets or sets the polygon id.

categoryPresetId?|

CategoryPreset.Id

categoryPresetExternalReference?|

CategoryPreset.ExternalReference

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/applypresetdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Cancel edit

POST/api/gateway/v2/polygon/canceledit

Cancel the Editing state of a polygon. This call reverts the snapshot created when the state was set to Editing.

Request Body

application/json

Options for which Polygon to cancel the edit for.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the edit should be cancelled.

polygonId*string

The Id of Polygon for which the edit should be cancelled.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/canceledit" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Cancel edit (Diff)

POST/api/gateway/v2/polygon/canceleditdiff

Cancel the Editing state of a polygon. This call reverts the snapshot created when the state was set to Editing.

Request Body

application/json

Options for which Polygon to cancel the edit for.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the edit should be cancelled.

polygonId*string

The Id of Polygon for which the edit should be cancelled.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/canceleditdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Complete

POST/api/gateway/v2/polygon/complete

Set the state of a Polygon to Complete.

Request Body

application/json

Options for which Polygon to complete.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the state should be set to Completed.

polygonId*string

The Id of Polygon for which the state should be set to Completed.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/complete" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Complete (Diff)

POST/api/gateway/v2/polygon/completediff

Set the state of a Polygon to Complete.

Request Body

application/json

Options for which Polygon to complete.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the state should be set to Completed.

polygonId*string

The Id of Polygon for which the state should be set to Completed.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/completediff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Copy

POST/api/gateway/v2/polygon/copy

Copy a Polygon

Request Body

application/json

Options for which Polygon to copy, with optional dimensions and description.

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed for copying a polygon within the same Project.

polygonId*string

Gets or sets the id of the polygon that must be copied.

width?|

Gets or sets the width of the copied polygon.

height?|

Gets or sets the height of the copied polygon.

description?|

Gets or sets the description of the copied polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/copy" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Copy (Diff)

POST/api/gateway/v2/polygon/copydiff

Copy a Polygon

Request Body

application/json

Options for which Polygon to copy, with optional dimensions and description.

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed for copying a polygon within the same Project.

polygonId*string

Gets or sets the id of the polygon that must be copied.

width?|

Gets or sets the width of the copied polygon.

height?|

Gets or sets the height of the copied polygon.

description?|

Gets or sets the description of the copied polygon.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/copydiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Edit

POST/api/gateway/v2/polygon/edit

Set the state of a Polygon to Editing. This call creates a snapshot of the Project. When the Edit is cancelled or a Project/Get is called, the Project is reverted to this snapshot.

Request Body

application/json

Options for which Polygon to edit.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the state should be set to Editing.

polygonId*string

The Id of Polygon for which the state should be set to Editing.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/edit" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Edit (Diff)

POST/api/gateway/v2/polygon/editdiff

Set the state of a Polygon to Editing. This call creates a snapshot of the Project. When the Edit is cancelled or a Project/Get is called, the Project is reverted to this snapshot.

Request Body

application/json

Options for which Polygon to edit.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for which Polygon the state should be set to Editing.

polygonId*string

The Id of Polygon for which the state should be set to Editing.

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/editdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Get category summary

GET/api/gateway/v2/polygon/getcategorysummary

Retrieves the category summary for the specified polygon

`application/json`

curl -X GET "https://example.com/api/gateway/v2/polygon/getcategorysummary?polygonId=string"

{  "categoryId": 0,  "code": "string",  "description": "string",  "groups": [    {      "code": "string",      "description": "string",      "displayOrder": 0,      "items": [        {          "code": "string",          "displayLabel": "string",          "displayOrder": 0,          "imageUrl": "string",          "price": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "value": "string"        }      ],      "price": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      }    }  ]}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Get texts

GET/api/gateway/v2/polygon/gettexts

Get a list of PolygonTexts for the given Polygon.Id

Query Parameters

polygonId*string

The id of the Polygon to retrieve the PolygonTexts for.

`application/json`

curl -X GET "https://example.com/api/gateway/v2/polygon/gettexts?polygonId=string"

{  "polygonId": "string",  "texts": [    {      "code": "string",      "content": "string"    }  ]}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Move the provide list of Polygons to the target project. The Polygons will be removed from their original Project(s). When the PreserveSourcePolygons parameter is set to true, the new Polygons in the target Project will have new ID's assigned.

Request Body

application/json

Options for which Polygons to move.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the request to move a polygon to the provided target project.

targetProjectId*string

The Id of the Project to which the Polygon should be moved.

polygonIds*array<>

The Polygon.Id's which should be moved. The Polygons will be removed from their original Project(s).

preserveSourcePolygons?|

When set to true, the source Polygon(s) will not be deleted from their Project(s)

validateSourcePolygonsState?|

When set to true, the state of the source Polygon(s) has to be Completed. When any of the Polygons is incomplete, the request will fail.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/move" \  -H "Content-Type: application/json" \  -d '{    "targetProjectId": "string",    "polygonIds": [      "string"    ]  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Remove

POST/api/gateway/v2/polygon/remove

Remove a Polygon from the Project

Request Body

application/json

Options for the Polygon to remove

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the request to remove a polygon from the project it belongs to.

polygonId*string

Id of the Polygon to remove from this Project

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/remove" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Remove (Diff)

POST/api/gateway/v2/polygon/removediff

Remove a Polygon from the Project

Request Body

application/json

Options for the Polygon to remove

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the request to remove a polygon from the project it belongs to.

polygonId*string

Id of the Polygon to remove from this Project

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/removediff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Remove material

POST/api/gateway/v2/polygon/removematerial

Remove one of the Materials of a Polygon

Request Body

application/json

Options for which CategoryLink the Material should be removed.

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to remove a material from a polygon.

polygonId?string

Gets or sets the polygon id.

categoryLinkId?integer

Gets or sets the category link id to remove the material for.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/removematerial" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Remove material (Diff)

POST/api/gateway/v2/polygon/removematerialdiff

Remove one of the Materials of a Polygon

Request Body

application/json

Options for which CategoryLink the Material should be removed.

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to remove a material from a polygon.

polygonId?string

Gets or sets the polygon id.

categoryLinkId?integer

Gets or sets the category link id to remove the material for.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/removematerialdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set attributes

POST/api/gateway/v2/polygon/setattributes

Replaces the polygon attributes with the specified string key-value pairs.

Request Body

application/json

Options to set the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to set the attributes for the specified polygon.

polygonId*string

Gets or sets the polygon id.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setattributes" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set attributes (Diff)

POST/api/gateway/v2/polygon/setattributesdiff

Replaces the polygon attributes with the specified string key-value pairs.

Request Body

application/json

Options to set the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to set the attributes for the specified polygon.

polygonId*string

Gets or sets the polygon id.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setattributesdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Add attributes

POST/api/gateway/v2/polygon/addattributes

Adds polygon attributes with the specified string key-value pairs. Updates if the attribute already exists.

Request Body

application/json

Options to add the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to add the attributes for the specified polygon. Updates the attribute if it already exists.

polygonId*string

Id (GUID) of the stored Polygon.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/addattributes" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Add attributes (Diff)

POST/api/gateway/v2/polygon/addattributesdiff

Adds polygon attributes with the specified string key-value pairs. Updates if the attribute already exists.

Request Body

application/json

Options to add the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to add the attributes for the specified polygon. Updates the attribute if it already exists.

polygonId*string

Id (GUID) of the stored Polygon.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/addattributesdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Delete attributes

POST/api/gateway/v2/polygon/deleteattributes

Deletes polygon attributes with the specified string key-value pairs.

Request Body

application/json

Options to delete the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to delete the attributes for the specified polygon.

polygonId*string

Id (GUID) of the stored Polygon.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/deleteattributes" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Delete attributes (Diff)

POST/api/gateway/v2/polygon/deleteattributesdiff

Deletes polygon attributes with the specified string key-value pairs.

Request Body

application/json

Options to delete the Polygon attributes.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information to delete the attributes for the specified polygon.

polygonId*string

Id (GUID) of the stored Polygon.

attributes*

The desired attributes for the stored Polygon. Stored as string key-value pairs.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/deleteattributesdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "attributes": {      "property1": "string",      "property2": "string"    }  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set description

POST/api/gateway/v2/polygon/setdescription

Sets the description of a polygon

Request Body

application/json

Options for the desciprion to set for this Polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the description to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

description?|

Gets or sets the description. Max length can vary per WT instance. The description will be printed when the product goes into production. Different workshops can handle different max lengths for descriptions. The default max length is 255.

triggerCalculate?boolean

Gets or sets a value indicating whether to trigger recalculation of the polygon after setting the description.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setdescription" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set description (Diff)

POST/api/gateway/v2/polygon/setdescriptiondiff

Sets the description of a polygon

Request Body

application/json

Options for the desciprion to set for this Polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the description to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

description?|

triggerCalculate?boolean

Gets or sets a value indicating whether to trigger recalculation of the polygon after setting the description.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setdescriptiondiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set PolygonType

POST/api/gateway/v2/polygon/setpolygontype

Sets the type of a polygon

Request Body

application/json

Options for the type to set for this Polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the type to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

polygonTypeId*integer

Gets or sets the polygon type id.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpolygontype" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "polygonTypeId": 0  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set PolygonType

POST/api/gateway/v2/polygon/setpolygontypediff

Sets the type of a polygon

Request Body

application/json

Options for the type to set for this Polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the type to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

polygonTypeId*integer

Gets or sets the polygon type id.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpolygontypediff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "polygonTypeId": 0  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set dimensions

POST/api/gateway/v2/polygon/setdimensions

Set the width/height of a Polygon

Request Body

application/json

Options for the dimensions which should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimensions to set.

polygonId?string

Gets or sets the polygon id.

width?|

Gets or sets the width.

height?|

Gets or sets the height.

isGrossDimension?boolean

Sets the values to be targeted at GrossWidth and GrossHeight instead

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setdimensions" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set dimensions (Diff)

POST/api/gateway/v2/polygon/setdimensionsdiff

Set the width/height of a Polygon

Request Body

application/json

Options for the dimensions which should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimensions to set.

polygonId?string

Gets or sets the polygon id.

width?|

Gets or sets the width.

height?|

Gets or sets the height.

isGrossDimension?boolean

Sets the values to be targeted at GrossWidth and GrossHeight instead

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setdimensionsdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set measurement type

POST/api/gateway/v2/polygon/setmeasurementtypesetting

Set the measurementtype of a Polygon

Request Body

application/json

Options for the dimensions which should be set.

TypeScript Definitions

Use the request body type in TypeScript.

COntains the measurementtype to apply and the id of the specified polygon.

polygonId?string

Gets or sets the id of the polygon.

measurementTypeSettingId?integer

Gets or sets the id of that polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmeasurementtypesetting" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set measurement type (Diff)

POST/api/gateway/v2/polygon/setmeasurementtypesettingdiff

Set the measurementtype of a Polygon

Request Body

application/json

Options for the dimensions which should be set.

TypeScript Definitions

Use the request body type in TypeScript.

COntains the measurementtype to apply and the id of the specified polygon.

polygonId?string

Gets or sets the id of the polygon.

measurementTypeSettingId?integer

Gets or sets the id of that polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmeasurementtypesettingdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set width

POST/api/gateway/v2/polygon/setwidth

Set the width of a Polygon

Request Body

application/json

Options for which width should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimension to set.

polygonId?string

Gets or sets the polygon id.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setwidth" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set width (Diff)

POST/api/gateway/v2/polygon/setwidthdiff

Set the width of a Polygon

Request Body

application/json

Options for which width should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimension to set.

polygonId?string

Gets or sets the polygon id.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setwidthdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set height

POST/api/gateway/v2/polygon/setheight

Set the height of a Polygon

Request Body

application/json

Options for which height should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimension to set.

polygonId?string

Gets or sets the polygon id.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setheight" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set height (Diff)

POST/api/gateway/v2/polygon/setheightdiff

Set the height of a Polygon

Request Body

application/json

Options for which height should be set.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information for the polygon's dimension to set.

polygonId?string

Gets or sets the polygon id.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setheightdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set material

POST/api/gateway/v2/polygon/setmaterial

Set one of the Materials of a Polygon

Request Body

application/json

Options for which Material to set, for which CategoryLink

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to associated a material with a polygon using the materials id.

polygonId?string

Gets or sets the id of the polygon.

categoryLinkId?integer

Gets or sets the id of that polygon's category link.

materialId?integer

Gets or sets the material id to associate with the polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmaterial" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set material (Diff)

POST/api/gateway/v2/polygon/setmaterialdiff

Set one of the Materials of a Polygon

Request Body

application/json

Options for which Material to set, for which CategoryLink

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to associated a material with a polygon using the materials id.

polygonId?string

Gets or sets the id of the polygon.

categoryLinkId?integer

Gets or sets the id of that polygon's category link.

materialId?integer

Gets or sets the material id to associate with the polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmaterialdiff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Apply the main Material to the CategoryLink

POST/api/gateway/v2/polygon/applymainmaterialtocategorylink

Set the main Materials of the CategoryLink

Request Body

application/json

Options for which CategoryLink is used

TypeScript Definitions

Use the request body type in TypeScript.

Applies the Main Material to the CategoryLink

polygonId*string

The id of the polygon

categoryLinkId*integer

the id of the CategoryLink

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/applymainmaterialtocategorylink" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "categoryLinkId": 0  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Apply the main Material to the CategoryLink (Diff)

POST/api/gateway/v2/polygon/applymainmaterialtocategorylinkdiff

Set the main Materials of the CategoryLink

Request Body

application/json

Options for which CategoryLink is used

TypeScript Definitions

Use the request body type in TypeScript.

Applies the Main Material to the CategoryLink

polygonId*string

The id of the polygon

categoryLinkId*integer

the id of the CategoryLink

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/applymainmaterialtocategorylinkdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "categoryLinkId": 0  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set material by code

POST/api/gateway/v2/polygon/setmaterialbycode

Set one of the Materials of a Polygon

Request Body

application/json

Options for which Material (using a Material.Code) to set, for which CategoryLink

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to associated a material with a polygon using the materials code.

polygonId?string

Gets or sets the id of the polygon.

categoryLinkId?integer

Gets or sets the id of that polygon's category link.

materialCode?|

Gets or sets the material code to associate with the polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmaterialbycode" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set material by code (Diff)

POST/api/gateway/v2/polygon/setmaterialbycodediff

Set one of the Materials of a Polygon

Request Body

application/json

Options for which Material (using a Material.Code) to set, for which CategoryLink

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information that is needed to associated a material with a polygon using the materials code.

polygonId?string

Gets or sets the id of the polygon.

categoryLinkId?integer

Gets or sets the id of that polygon's category link.

materialCode?|

Gets or sets the material code to associate with the polygon's category link.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmaterialbycodediff" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set model

POST/api/gateway/v2/polygon/setmodel

Set the model of a Polygon

Request Body

application/json

Options for which model to set, for which polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the model to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

modelId*string

Gets or sets the model id.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmodel" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "modelId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set model (Diff)

POST/api/gateway/v2/polygon/setmodeldiff

Set the model of a Polygon

Request Body

application/json

Options for which model to set, for which polygon

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the model to set for a specified polygon.

polygonId*string

Gets or sets the polygon id.

modelId*string

Gets or sets the model id.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setmodeldiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "modelId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set property value

POST/api/gateway/v2/polygon/setpropertyvalue

Set the value of a property for a Polygon

Request Body

application/json

Options for which Property value to set for which Polygon.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the property value to set for a polygon's category link and material configuration. A property means, a property of the product. Like the quantity of the product, or whether a curtain is placed at the left or right side of a window. A CategoryLinkMaterial is an element that is a relation between a CategoryLink and its associated material.

categoryLinkMaterialPropertyId*integer

Gets or sets the id of the category link material property.

polygonId*string

Gets or sets the id of the polygon.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpropertyvalue" \  -H "Content-Type: application/json" \  -d '{    "categoryLinkMaterialPropertyId": 0,    "polygonId": "string"  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set property value (Diff)

POST/api/gateway/v2/polygon/setpropertyvaluediff

Set the value of a property for a Polygon

Request Body

application/json

Options for which Property value to set for which Polygon.

TypeScript Definitions

Use the request body type in TypeScript.

categoryLinkMaterialPropertyId*integer

Gets or sets the id of the category link material property.

polygonId*string

Gets or sets the id of the polygon.

value?|

Gets or sets the value.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpropertyvaluediff" \  -H "Content-Type: application/json" \  -d '{    "categoryLinkMaterialPropertyId": 0,    "polygonId": "string"  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set property values

POST/api/gateway/v2/polygon/setpropertyvalues

Set multiple property values for a Polygon

Request Body

application/json

Options for which Property values to set for which Polygon.

TypeScript Definitions

Use the request body type in TypeScript.

polygonId*string

Gets or sets the id of the polygon.

propertyValues*

Key value pairs for the property values to set on the polygon. The key is a CategoryLinkMaterialPropertyId and the value the selected value for the property

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpropertyvalues" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "propertyValues": {      "property1": "string",      "property2": "string"    }  }'

{  "applicationId": 0,  "id": "string",  "entityId": 0,  "attributes": {    "property1": "string",    "property2": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "customer": {    "id": "string",    "entityId": 0,    "debtorCode": "string"  },  "customerId": 0,  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryLicensee": {    "id": 0,    "code": "string"  },  "licensee": {    "id": 0,    "code": "string"  },  "deliveryRef": "string",  "description": "string",  "executionAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "externalReference": "string",  "isEditable": true,  "lastModifiedAt": "2019-08-24T14:15:22Z",  "lastOpenedAt": "2019-08-24T14:15:22Z",  "messages": [    {      "context": "None",      "contextReference": "string",      "kind": "Information",      "scope": "None",      "text": "string",      "origin": "Default"    }  ],  "polygons": [    {      "id": "string",      "entityId": 0,      "lineNumber": 0,      "lineNumberSuffix": "string",      "attributes": {        "property1": "string",        "property2": "string"      },      "categoryDescription": "string",      "categoryFavoriteDescription": "string",      "categoryFavoriteId": 0,      "categoryLinks": [        {          "id": 0,          "categoryLinkMaterial": {            "materialCode": "string",            "supplierCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "calcQuantity": 0,            "calcQuantityNet": 0,            "saleUnit": "string",            "supplierId": 0,            "supplierSbnKey": 0,            "price": {              "discountAmount": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "materialId": 0,                      "supplierCode": "string",                      "description": "string",                      "purchasePrice": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      },                      "quantity": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "unit": "string",                      "unitPrice": 0.1,                      "unitPriceBeforePromotion": 0.1,                      "totalPriceExclVat": 0.1,                      "unitPriceExclVat": 0.1,                      "vatAmount": 0.1,                      "vatPercentage": 0.1                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "priceDiscount": 0.1,                  "reference": "string",                  "validUntil": "2019-08-24T14:15:22Z",                  "priceDiscountExclVat": 0.1,                  "attributes": {                    "property1": "string",                    "property2": "string"                  }                }              ],              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "totalPurchasePrice": 0.1            },            "properties": [              {                "id": 0,                "controlType": "Text",                "customControlCode": "string",                "dataType": 0,                "valueDataType": "None",                "defaultControlType": "Text",                "description": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "hasDynamicDescription": true,                "interfaceKey": "string",                "isModified": true,                "isModifiedByApp": true,                "isReadonly": true,                "isRequired": true,                "isVisible": true,                "isAvailableBeforeCalculation": true,                "listValues": [                  {                    "description": "string",                    "imageUrl": "string",                    "interfaceKey": "string",                    "skills": "string",                    "remarks": "string",                    "value": "string",                    "isDisabled": true,                    "priceDifference": 0,                    "price": 0,                    "categoryLinkPropertyId": 0,                    "contentBlockId": "string"                  }                ],                "propertyId": 0,                "remarks": "string",                "value": "string",                "validation": {                  "min": null,                  "max": null,                  "precision": 0,                  "step": null,                  "isValid": true                },                "imageUrl": "string",                "explanation": "string"              }            ],            "messages": [              {                "context": "None",                "contextReference": "string",                "kind": "Information",                "scope": "None",                "text": "string",                "origin": "Default"              }            ],            "redistributionInfo": "string"          },          "categoryMaterialOptionFilter": 0,          "categoryMaterialOptionInterfaceKeys": [            "string"          ],          "childCategoryDescription": "string",          "childCategoryId": 0,          "description": "string",          "imageUrl": "string",          "interfaceKey": "string",          "isEnabled": true,          "isMainCategory": true,          "parentCategoryId": 0,          "quantityDescription": "string",          "remarks": "string",          "requiredLevel": "None",          "options": [            "None"          ]        }      ],      "appliedExtras": [        {          "id": "string",          "materialId": 0,          "materialCategoryId": 0,          "categoryExtraId": 0,          "quantity": 0.1,          "description": "string",          "priceElement": {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        }      ],      "categoryPresetId": 0,      "categoryPresetExternalReference": "string",      "chainedChildren": [        {          "id": "string",          "entityId": 0,          "lineNumber": 0,          "lineNumberSuffix": "string",          "attributes": {            "property1": "string",            "property2": "string"          },          "categoryDescription": "string",          "categoryFavoriteDescription": "string",          "categoryFavoriteId": 0,          "categoryLinks": [            {              "id": 0,              "categoryLinkMaterial": {                "materialCode": "string",                "supplierCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "calcQuantity": 0,                "calcQuantityNet": 0,                "saleUnit": "string",                "supplierId": 0,                "supplierSbnKey": 0,                "price": {                  "discountAmount": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "materialId": 0,                          "supplierCode": "string",                          "description": "string",                          "purchasePrice": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          },                          "quantity": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "unit": "string",                          "unitPrice": 0.1,                          "unitPriceBeforePromotion": 0.1,                          "totalPriceExclVat": 0.1,                          "unitPriceExclVat": 0.1,                          "vatAmount": 0.1,                          "vatPercentage": 0.1                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "priceDiscount": 0.1,                      "reference": "string",                      "validUntil": "2019-08-24T14:15:22Z",                      "priceDiscountExclVat": 0.1,                      "attributes": {                        "property1": "string",                        "property2": "string"                      }                    }                  ],                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "totalPurchasePrice": 0.1                },                "properties": [                  {                    "id": 0,                    "controlType": "Text",                    "customControlCode": "string",                    "dataType": 0,                    "valueDataType": "None",                    "defaultControlType": "Text",                    "description": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "hasDynamicDescription": true,                    "interfaceKey": "string",                    "isModified": true,                    "isModifiedByApp": true,                    "isReadonly": true,                    "isRequired": true,                    "isVisible": true,                    "isAvailableBeforeCalculation": true,                    "listValues": [                      {                        "description": "string",                        "imageUrl": "string",                        "interfaceKey": "string",                        "skills": "string",                        "remarks": "string",                        "value": "string",                        "isDisabled": true,                        "priceDifference": 0,                        "price": 0,                        "categoryLinkPropertyId": 0,                        "contentBlockId": "string"                      }                    ],                    "propertyId": 0,                    "remarks": "string",                    "value": "string",                    "validation": {                      "min": null,                      "max": null,                      "precision": 0,                      "step": null,                      "isValid": true                    },                    "imageUrl": "string",                    "explanation": "string"                  }                ],                "messages": [                  {                    "context": "None",                    "contextReference": "string",                    "kind": "Information",                    "scope": "None",                    "text": "string",                    "origin": "Default"                  }                ],                "redistributionInfo": "string"              },              "categoryMaterialOptionFilter": 0,              "categoryMaterialOptionInterfaceKeys": [                "string"              ],              "childCategoryDescription": "string",              "childCategoryId": 0,              "description": "string",              "imageUrl": "string",              "interfaceKey": "string",              "isEnabled": true,              "isMainCategory": true,              "parentCategoryId": 0,              "quantityDescription": "string",              "remarks": "string",              "requiredLevel": "None",              "options": [                "None"              ]            }          ],          "appliedExtras": [            {              "id": "string",              "materialId": 0,              "materialCategoryId": 0,              "categoryExtraId": 0,              "quantity": 0.1,              "description": "string",              "priceElement": {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            }          ],          "categoryPresetId": 0,          "categoryPresetExternalReference": "string",          "chainedChildren": [],          "currentStatus": {            "remarks": "string",            "statusDateTime": "2019-08-24T14:15:22Z",            "statusDescription": "string",            "statusValue": 0          },          "description": "string",          "dimensionsInfo": {            "maxHeight": 0,            "maxWidth": 0,            "minHeight": 0,            "minWidth": 0          },          "documentations": [            {              "description": "string",              "documentationKind": "General",              "documentationUrl": "string",              "mediaType": "None"            }          ],          "grossHeight": 0,          "grossWidth": 0,          "height": 0,          "heightCorrection": 0,          "isDescriptionEnabled": true,          "isDeleted": true,          "isHeightEnabled": true,          "isReadonly": true,          "isWidthEnabled": true,          "leadTime": 0.1,          "modelCode": "string",          "modelDescription": "string",          "modelId": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "polygonTypeId": 0,          "prices": {            "discountAmount": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "materialId": 0,                    "supplierCode": "string",                    "description": "string",                    "purchasePrice": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    },                    "quantity": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "unit": "string",                    "unitPrice": 0.1,                    "unitPriceBeforePromotion": 0.1,                    "totalPriceExclVat": 0.1,                    "unitPriceExclVat": 0.1,                    "vatAmount": 0.1,                    "vatPercentage": 0.1                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "priceDiscount": 0.1,                "reference": "string",                "validUntil": "2019-08-24T14:15:22Z",                "priceDiscountExclVat": 0.1,                "attributes": {                  "property1": "string",                  "property2": "string"                }              }            ],            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "totalPurchasePrice": 0.1          },          "productCategoryId": 0,          "productCategoryInterfaceKey": "string",          "productCode": "string",          "state": "New",          "visuals": [            {              "name": "string",              "url": "string",              "remarks": "string"            }          ],          "width": 0,          "widthCorrection": 0,          "widthMeasurementTypeSettingId": 0,          "heightMeasurementTypeSettingId": 0        }      ],      "currentStatus": {        "remarks": "string",        "statusDateTime": "2019-08-24T14:15:22Z",        "statusDescription": "string",        "statusValue": 0      },      "description": "string",      "dimensionsInfo": {        "maxHeight": 0,        "maxWidth": 0,        "minHeight": 0,        "minWidth": 0      },      "documentations": [        {          "description": "string",          "documentationKind": "General",          "documentationUrl": "string",          "mediaType": "None"        }      ],      "grossHeight": 0,      "grossWidth": 0,      "height": 0,      "heightCorrection": 0,      "isDescriptionEnabled": true,      "isDeleted": true,      "isHeightEnabled": true,      "isReadonly": true,      "isWidthEnabled": true,      "leadTime": 0.1,      "modelCode": "string",      "modelDescription": "string",      "modelId": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "polygonTypeId": 0,      "prices": {        "discountAmount": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "materialId": 0,                "supplierCode": "string",                "description": "string",                "purchasePrice": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                },                "quantity": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "unit": "string",                "unitPrice": 0.1,                "unitPriceBeforePromotion": 0.1,                "totalPriceExclVat": 0.1,                "unitPriceExclVat": 0.1,                "vatAmount": 0.1,                "vatPercentage": 0.1              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "priceDiscount": 0.1,            "reference": "string",            "validUntil": "2019-08-24T14:15:22Z",            "priceDiscountExclVat": 0.1,            "attributes": {              "property1": "string",              "property2": "string"            }          }        ],        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "totalPurchasePrice": 0.1      },      "productCategoryId": 0,      "productCategoryInterfaceKey": "string",      "productCode": "string",      "state": "New",      "visuals": [        {          "name": "string",          "url": "string",          "remarks": "string"        }      ],      "width": 0,      "widthCorrection": 0,      "widthMeasurementTypeSettingId": 0,      "heightMeasurementTypeSettingId": 0    }  ],  "projectPrices": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "price": {    "discountAmount": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "materialId": 0,            "supplierCode": "string",            "description": "string",            "purchasePrice": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            },            "quantity": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "unit": "string",            "unitPrice": 0.1,            "unitPriceBeforePromotion": 0.1,            "totalPriceExclVat": 0.1,            "unitPriceExclVat": 0.1,            "vatAmount": 0.1,            "vatPercentage": 0.1          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "priceDiscount": 0.1,        "reference": "string",        "validUntil": "2019-08-24T14:15:22Z",        "priceDiscountExclVat": 0.1,        "attributes": {          "property1": "string",          "property2": "string"        }      }    ],    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "totalPurchasePrice": 0.1  },  "projectNumber": "string",  "projectStatus": "Entered",  "projectSets": [    {      "id": "string",      "entityId": 0,      "setId": 0,      "description": "string",      "remarks": "string",      "imageUrl": "string",      "polygonIds": [        "string"      ]    }  ],  "projectType": {    "id": 0,    "code": "string"  },  "reference": "string",  "remarks": "string",  "salesman": {    "id": 0,    "name": "string",    "username": "string"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Set property values (Diff)

POST/api/gateway/v2/polygon/setpropertyvaluesdiff

Set multiple property values for a Polygon

Request Body

application/json

Options for which Property value to set for which Polygon.

TypeScript Definitions

Use the request body type in TypeScript.

polygonId*string

Gets or sets the id of the polygon.

propertyValues*

Key value pairs for the property values to set on the polygon. The key is a CategoryLinkMaterialPropertyId and the value the selected value for the property

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/polygon/setpropertyvaluesdiff" \  -H "Content-Type: application/json" \  -d '{    "polygonId": "string",    "propertyValues": {      "property1": "string",      "property2": "string"    }  }'

[  {    "from": "string",    "op": "string",    "path": "string",    "value": null  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`