AVACloud API 1.27.0
AslvConversion
| Improve this Doc View SourceAslvConversion_ConvertToAva
Converts Aslv files to Dangl.AVA projects
Request
POST /conversion/aslv/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
aslvFile | file | The input file |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
AslvConversion_ConvertToGaeb
Converts Aslv files to GAEB files
Request
POST /conversion/aslv/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
aslvFile | file | The input file |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AslvConversion_ConvertToExcel
Converts Aslv files to Excel
Request
POST /conversion/aslv/excel[?WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
aslvFile | file | The input file |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AslvConversion_ConvertToOenorm
Converts Aslv files to Oenorm files
Request
POST /conversion/aslv/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
aslvFile | file | The input file |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AvaConversion
| Improve this Doc View SourceAvaConversion_ConvertToAva
Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
Request
POST /conversion/ava/ava[?TryAutoGenerateItemNumbersAndSchema&RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
AvaConversion_ConvertToGaeb
Converts Dangl.AVA projects to GAEB
Request
POST /conversion/ava/gaeb[?TryAutoGenerateItemNumbersAndSchema&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AvaConversion_ConvertToExcel
Converts Dangl.AVA projects to Excel
Request
POST /conversion/ava/excel[?TryAutoGenerateItemNumbersAndSchema&WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AvaConversion_ConvertToReb
Converts Dangl.AVA projects to REB
Request
POST /conversion/ava/reb[?TryAutoGenerateItemNumbersAndSchema]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AvaConversion_ConvertToOenorm
Converts Dangl.AVA projects to Oenorm
Request
POST /conversion/ava/oenorm[?TryAutoGenerateItemNumbersAndSchema&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
AvaConversion_ConvertToSia
Converts Dangl.AVA projects to SIA 451
Request
POST /conversion/ava/sia[?TryAutoGenerateItemNumbersAndSchema]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*avaProject | The Dangl.AVA project |
||
TryAutoGenerateItemNumbersAndSchema | boolean | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
DanglIdentity
| Improve this Doc View SourceDanglIdentity_LoginWithCookie
Request
POST /identity/login[?redirectUrl]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*model | |||
redirectUrl | string |
Responses
Status Code | Description | Samples |
---|---|---|
204 | ||
401 |
DanglIdentity_SignOutWithSignInManager
Request
DELETE /identity/login
Responses
Status Code | Description | Samples |
---|---|---|
204 |
DanglIdentity_LoginAndReturnToken
Request
POST /identity/token-login
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*model |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 | ||
401 |
DanglIdentity_RefreshToken
Request
POST /identity/token-refresh
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*model |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 | ||
401 |
DanglIdentity_Register
Request
POST /identity/register
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*registerModel |
Responses
Status Code | Description | Samples |
---|---|---|
204 | ||
400 |
DanglIdentity_RequestPasswordReset
Request
POST /identity/password-forgotten
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*forgotPasswordModel |
Responses
Status Code | Description | Samples |
---|---|---|
204 |
ExcelConversion
| Improve this Doc View SourceExcelConversion_ConvertToAva
Converts Excel files to Dangl.AVA projects.
Request
POST /conversion/excel/ava[?ReadNewElements&RebuildItemNumberSchema&RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
excelFile | file | The input file |
|
ReadNewElements | boolean | Defaults to false |
|
RebuildItemNumberSchema | boolean | When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false. |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
ExcelConversion_ConvertToGaeb
Converts Excel files to GAEB files.
Request
POST /conversion/excel/gaeb[?ReadNewElements&RebuildItemNumberSchema&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
excelFile | file | The input file |
|
ReadNewElements | boolean | Defaults to false |
|
RebuildItemNumberSchema | boolean | When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false. |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
ExcelConversion_ConvertToExcel
Converts Excel files to Excel files. Used, for example, when elements were added in excel to generate or modify a project. The Excel file can then be shared containing the full project with all formattings, formulas and styles applied.
Request
POST /conversion/excel/excel[?ReadNewElements&RebuildItemNumberSchema&WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
excelFile | file | The input file |
|
ReadNewElements | boolean | Defaults to false |
|
RebuildItemNumberSchema | boolean | When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false. |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
ExcelConversion_ConvertToOenorm
Converts Excel files to Oenorm files.
Request
POST /conversion/excel/oenorm[?ReadNewElements&RebuildItemNumberSchema&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
excelFile | file | The input file |
|
ReadNewElements | boolean | Defaults to false |
|
RebuildItemNumberSchema | boolean | When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false. |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
GaebConversion
| Improve this Doc View SourceGaebConversion_ConvertToAva
Converts GAEB files to Dangl.AVA projects
Request
POST /conversion/gaeb/ava[?SupportSkippedItemNumberLevelsInPositions&RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
gaebFile | file | The input file |
|
SupportSkippedItemNumberLevelsInPositions | boolean | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true. |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
GaebConversion_ConvertToGaeb
Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
Request
POST /conversion/gaeb/gaeb[?SupportSkippedItemNumberLevelsInPositions&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
gaebFile | file | The input file |
|
SupportSkippedItemNumberLevelsInPositions | boolean | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true. |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
GaebConversion_ConvertToExcel
Converts GAEB files to Excel
Request
POST /conversion/gaeb/excel[?SupportSkippedItemNumberLevelsInPositions&WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
gaebFile | file | The input file |
|
SupportSkippedItemNumberLevelsInPositions | boolean | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true. |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
GaebConversion_ConvertToOenorm
Converts GAEB files to Oenorm files
Request
POST /conversion/gaeb/oenorm[?SupportSkippedItemNumberLevelsInPositions&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
gaebFile | file | The input file |
|
SupportSkippedItemNumberLevelsInPositions | boolean | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true. |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
OenormConversion
| Improve this Doc View SourceOenormConversion_ConvertToAva
Converts ÖNorm files to Dangl.AVA projects
Request
POST /conversion/oenorm/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
oenormFile | file | The input file |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
OenormConversion_ConvertToGaeb
Converts ÖNorm files to GAEB files.
Request
POST /conversion/oenorm/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
oenormFile | file | The input file |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
OenormConversion_ConvertToExcel
Converts ÖNorm files to Excel
Request
POST /conversion/oenorm/excel[?WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
oenormFile | file | The input file |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
OenormConversion_ConvertToOenorm
Converts ÖNorm files to Oenorm files.
Request
POST /conversion/oenorm/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
oenormFile | file | The input file |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
RebConversion
| Improve this Doc View SourceRebConversion_ConvertToAva
Converts REB files to Dangl.AVA projects
Request
POST /conversion/reb/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
rebFile | file | The input file |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
RebConversion_ConvertToGaeb
Converts REB files to GAEB files
Request
POST /conversion/reb/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
rebFile | file | The input file |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
RebConversion_ConvertToExcel
Converts REB files to Excel
Request
POST /conversion/reb/excel[?WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
rebFile | file | The input file |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
RebConversion_ConvertToOenorm
Converts REB files to Oenorm
Request
POST /conversion/reb/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
rebFile | file | The input file |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
SiaConversion
| Improve this Doc View SourceSiaConversion_ConvertToAva
Converts SIA 451 files to Dangl.AVA projects
Request
POST /conversion/sia/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
siaFile | file | The input file |
|
RemovePlainTextLongTexts | boolean | If set to true, plain text long texts will be removed from the output to reduce response sizes |
|
RemoveHtmlLongTexts | boolean | If set to true, html long texts will be removed from the output to reduce response sizes |
Responses
Status Code | Description | Samples |
---|---|---|
200 | ||
400 |
SiaConversion_ConvertToGaeb
Converts SIA 451 files to GAEB files
Request
POST /conversion/sia/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
siaFile | file | The input file |
|
DestinationGaebType | string | Defaults to GAEB XML V3.2 |
|
TargetExchangePhaseTransform | string | Defaults to none, meaning no transformation will be done |
|
EnforceStrictOfferPhaseLongTextOutput | boolean | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export. |
|
ExportQuantityDetermination | boolean | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
SiaConversion_ConvertToExcel
Converts SIA 451 files to Excel
Request
POST /conversion/sia/excel[?WritePrices&WriteLongTexts&ConversionCulture]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
siaFile | file | The input file |
|
WritePrices | boolean | Defaults to true |
|
WriteLongTexts | boolean | Defaults to true |
|
ConversionCulture | string | The culture that should be used for the conversion process, to have localized Excel files |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
SiaConversion_ConvertToOenorm
Converts SIA 451 files to Oenorm files
Request
POST /conversion/sia/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
siaFile | file | The input file |
|
DestinationOenormType | string | Defaults to Lv2015 |
|
TryRepairProjectStructure | boolean | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target |
|
SkipTryEnforceSchemaCompliantXmlOutput | boolean | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option. |
|
RemoveUnprintableCharactersFromTexts | boolean | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. |
Responses
Status Code | Description | Samples |
---|---|---|
400 | ||
200 |
Status
| Improve this Doc View SourceStatus_GetStatus
Reports the health status of the AVACloud API
Request
GET /status
Responses
Status Code | Description | Samples |
---|---|---|
200 |