Table of Contents

Namespace Autodesk.ModelDerivative.Models

Classes

AllProperties
AllProperties400Error
AllProperties401Error
AllProperties403Error
AllProperties404Error
AllProperties406Error
AllProperties409Error
AllProperties413Error
AllProperties429Error
AllProperties500Error
AllProperties_data
AllProperties_data_collection
AllProperties_data_collection_properties
Formats

Returns an up-to-date list of supported translations, which you can use to identify which types of derivatives are supported for each source file type

Formats400Error
Formats401Error
Formats403Error
Formats404Error
Formats500Error
Job
Job400Error
Job401Error
Job403Error
Job404Error
Job406Error
Job409Error
Job429Error
Job500Error
JobPayload
JobPayloadFormat

Output description object, depends of the type

JobPayloadFormat_advanced
JobPayload_input

Group of inputs

JobPayload_misc
JobPayload_misc_workflowAttribute

A user-defined JSON object, which you can use to set some custom workflow information. It needs to be less than 1KB and will be ignored if misc.workflow parameter is not set.

JobPayload_output

Group of outputs

JobPayload_output_destination
Job_acceptedJobs

list of the requested outputs

Job_acceptedJobs_output

identical to the request body. For more information please see the request body structure above.

Manifest
Manifest400Error
Manifest401Error
Manifest403Error
Manifest404Error
Manifest500Error
Manifest_derivatives
Manifest_derivatives_children
Manifest_derivatives_children_children
Manifest_derivatives_children_children_camera
ModelViews
ModelViews400Error
ModelViews401Error
ModelViews403Error
ModelViews404Error
ModelViews500Error
ModelViews_data

Envelope that contains the return data.

ModelViews_data_metadata

An array of flat JSON objects representing metadata.

ObjectTree
ObjectTree400Error
ObjectTree401Error
ObjectTree403Error
ObjectTree404Error
ObjectTree406Error
ObjectTree409Error
ObjectTree413Error
ObjectTree429Error
ObjectTree500Error
ObjectTreeNode
ObjectTree_data
References400Error
References401Error
References403Error
References404Error
References500Error
Signedcookies400Error
Signedcookies401Error
Signedcookies403Error
Signedcookies404Error
Signedcookies500Error
SpecificProperties
SpecificProperties400Error
SpecificProperties404Error
SpecificProperties429Error
SpecificProperties500Error
SpecificPropertiesPayload
SpecificPropertiesPayload_pagination
SpecificProperties_data
SpecificProperties_data_collection
SpecificProperties_pagination
Thumbnail400Error
Thumbnail401Error
Thumbnail403Error
Thumbnail404Error
Thumbnail500Error
WithDerivativeUrn400Error
WithDerivativeUrn401Error
WithDerivativeUrn403Error
WithDerivativeUrn404Error
WithDerivativeUrn500Error

Enums

JobPayloadFormat_advanced_Twodviews

The format that 2D views must be rendered to. Available options are:- legacy - (Default) Render to a model derivative specific file format.- pdf - Render to the PDF file format. This option applies only to Revit 2022 files and newer.

JobPayloadFormat_advanced_buildingStoreys

Specifies how storeys are translated. Available options are:- hide - (default) storeys are extracted but not visible by default.- show - storeys are extracted and are visible by default.- skip - storeys are not translated.Note These options are applicable only when conversionMethod is set to modern or v3.

JobPayloadFormat_advanced_conversionMethod

Specifies what IFC loader to use during translation. Available options are:- legacy - Use the Navisworks IFC loader.- modern - Use the Revit IFC loader (recommended over the legacy option).- v3 - Use the newer Revit IFC loader (recommended over the older modern option)If both switchLoader and conversionMethod are specified, Model Derivative uses the conversionMethod parameter. If conversionMethod is not specified, Model Derivative uses the switchLoader parameter.

JobPayloadFormat_advanced_extractorVersion

Specifies what version of the Revit translator/extractor to use. Possible values:next - Makes the translation job use the newest available version of the translator/extractor. This option is meant to be used by beta testers who wish to test a pre-release version of the translator. If no pre-release version is available, this option makes the translation job use the current official release version.previous - Makes the translation job use the previous official release version of the translator/extractor. This option is meant to be used as a workaround in case of regressions caused by a new official release of the translator/extractor.If this attribute is not specified, the system uses the current official release version.

JobPayloadFormat_advanced_hierarchy

Specifies how the hierarchy of items are determined.Classic: (Default) Uses hardcoded rules to set the hierarchy of items.SystemPath: Uses a linked XML or MDB2 properties file to set hierarchy of items. You can use this option to make the organization of items consistent with SmartPlant 3D.Notes:1. The functioning of the SystemPath depends on the default setting of the property SP3D_SystemPath or System Path.2. The pathing delimiter must be .3. If you want to customize further, import the VUE file to Navisworks. After that, use POST job on the resulting Navisworks (nwc/nwd) file.

JobPayloadFormat_advanced_materialMode

Specifies the materials to apply to the generated SVF derivatives. Available options are:- auto - (Default) Use the current setting of the default view of the input file.- basic - Use basic materials.- autodesk - Use Autodesk materials.

JobPayloadFormat_advanced_openingElements

An option to be specified when the input file type is IFC.Specifies how openings are translated. Available options are:- hide - (default) openings are translated but are not visible by default.- show - openings are translated and are visible by default.- skip - openings are not translated.Note These options are applicable only when conversionMethod is set to modern or v3.

JobPayloadFormat_advanced_spaces

Specifies how spaces are translated. Available options are:- hide - (default) spaces are translated but are not visible by default.- show - spaces are translated and are visible by default.- skip - spaces are not translated.Note These options are applicable only when conversionMethod is set to modern or v3.

JobPayloadFormat_views

Required options for SVF type. Possible values are 2d and 3d.

ModelViews_data_metadata_role

Type of model viewPossible values: 2d, 3d

SpecificPropertiesPayload_payload