Namespace Autodesk.ModelDerivative.Model
Classes
Describes a query for retrieving objects whose names start with a specified text.
Describes a query for retrieving objects where a specified numeric property falls within a specified range.
Describes a query for retrieving objects where a specified property contains one or more words in a specified string.
Represents the successful response of a Delete Manifest operation.
Represents the successful response of a Fetch Derivative Download operation.
Describes a query for retrieving objects where a specified attribute exactly matches a specified value.
Describes a query for retrieving objects where a specified numeric property is greater than or equal to a specified value.
Represents the successful response of a Create Translation Job operation.
List of the requested outputs.
Represents the request body of a Create Translation Job operation.
Contains advanced configuration settings for translation jobs producing DWG outputs.
Contains advanced configuration settings for translation jobs producing IFC outputs.
Contains advanced configuration settings for translation jobs producing IGES outputs.
Contains advanced configuration settings for translation jobs producing OBJ outputs.
JobPayloadFormatAdvancedOBJAdvanced
Advanced options for OBJ output type.
Contains advanced configuration settings for translation jobs producing STEP outputs.
Contains advanced configuration settings for translation jobs producing STL outputs.
JobPayloadFormatAdvancedSTLAdvanced
Advanced options for stl
type.
JobPayloadFormatAdvancedThumbnail
Contains advanced configuration settings for translation jobs producing thumbnail outputs.
Describes the options for translation jobs producing DWG outputs.
Describes the options for translation jobs producing IFC outputs.
Describes the options for translation jobs producing IGES outputs.
Describes the options for translation jobs producing OBJ outputs.
Describes the options for translation jobs producing STEP outputs.
Describes the options for translation jobs producing STL outputs.
Describes the options for translation jobs producing SVF outputs.
Describes the options for translation jobs producing SVF2 outputs.
JobPayloadFormatSVF2AdvancedDGN
Contains advanced configuration settings for translation jobs processing DGN inputs.
JobPayloadFormatSVF2AdvancedDWG
Contains advanced configuration settings for translation jobs processing DWG inputs.
JobPayloadFormatSVF2AdvancedIFC
Contains advanced configuration settings for translation jobs processing IFC inputs.
JobPayloadFormatSVF2AdvancedNWD
Contains advanced configuration settings for translation jobs processing NWD inputs.
JobPayloadFormatSVF2AdvancedRVT
Contains advanced configuration settings for translation jobs processing Revit inputs.
JobPayloadFormatSVF2AdvancedVUE
Contains advanced configuration settings for translation jobs processing VUE inputs.
JobPayloadFormatSVFAdvancedDGN
Contains advanced configuration settings for translation jobs processing DGN inputs.
JobPayloadFormatSVFAdvancedDWG
Contains advanced configuration settings for translation jobs processing DWG inputs.
JobPayloadFormatSVFAdvancedIFC
Contains advanced configuration settings for translation jobs processing IFC inputs.
JobPayloadFormatSVFAdvancedNWD
Contains advanced configuration settings for translation jobs processing NWD inputs.
JobPayloadFormatSVFAdvancedRVT
Contains advanced configuration settings for translation jobs processing Revit inputs.
JobPayloadFormatSVFAdvancedVUE
Contains advanced configuration settings for translation jobs processing VUE inputs.
Describes the options for translation jobs producing thumbnail outputs.
Describes the attributes of the source design.
Contains webhook configuration settings for notifying external systems about translation job events.
Describes the attributes of the requested derivatives.
Specifies where to store generated derivatives.
Describes a query for retrieving objects where a specified numeric property is less than or equal to a specified value.
Represents the successful response of a Fetch Manifest operation.
Represents a derivative generated for the source design.
Represents a resource generated for a derivative.
Describes a query for retrieving objects having the specified Object IDs or External IDs.
An array of objects where each object represents a message logged to the manifest during translation. For example, error messages and warning messages.
Represents the successful response of a List Model Views operation.
Container for the data returned by the List Model Views operation.
An array of flat JSON objects representing metadata.
Represents the successful response of a Fetch Object Tree operation.
Container for the data returned by the Fetch Specific Properties operation.
ObjectTreeDataObjects
Represents a successful response to a Fetch All Properties operation.
Container for the data returned by the Fetch All Properties operation.
PropertiesDataCollection
Represents the successful response of a Fetch Specific Properties operation.
Container for the attributes that define how the response paginated.
Represents the request body of a Fetch Specific Properties operation.
SpecificPropertiesPayloadPagination
Specifies how to split the response into multiple pages, and return the response one page at a time.
Represents the successful response of a Specify References operation.
Represents the successful response of a Specify References operation.
SpecifyReferencesPayloadReferences
SpecifyReferencesPayloadReferences
Represents the successful response of a List Supported Formats operation.
Interfaces
Contains the configuration settings for each output type a translation job must produce. The available options depend on the desired output type. They are listed under the See Also section.
Contains advanced configuration settings for translation jobs producing svf2
outputs. The options you can specify depend on the input type. The See Also section provides links to these options.
Contains advanced configuration settings for translation jobs producing svf
outputs. The options you can specify depend on the input type. The See Also section provides links to these options.
ISpecificPropertiesPayloadQuery
Specifies what objects to query. The See Also section contains the links to the different ways to specify the objects.
Enums
Specifies the application protocol to use when the output type is STEP. Possible values are:
203
- Configuration controlled design.214
- (Default) Core data for automotive mechanical design processes.242
- Managed model based 3D engineering.
Specifies how storeys are translated. Applicable only when the source design is of type IFC. Possible values are:
hide
- (Default) Storeys are translated but not visible by default.show
- Storeys are translated and are visible by default.skip
- Storeys are not translated.
Note: These options are applicable only when conversionMethod
is set to modern
or v3
.
Specifies what IFC loader to use during translation. Applicable only when the source design is of type IFC. Possible values are:
legacy
- Use IFC loader version 1, which is based on the Navisworks IFC loader.modern
- Use IFC loader version 2, which is based on the Revit IFC loader.v3
- Use IFC loader version 3, which is based on the Revit IFC loader.v4
- (Recommended) Use IFC loader version 4, which is a native solution specifically designed for Autodesk Platform Services (APS). It does not depend on Navisworks or Revit.
Specifies the structure of the derivative, when the specified output is STL. Possible values are:
single
(Default) Create one STL file for all the input files (assembly file).multiple
: Create a separate STL file for each object
Specifies what version of the Revit translator/extractor to use. Applicable only when the source design is of type RVT. Possible values are:
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, the system uses 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.
Specifies the format of the file to create, when the specified output is STL. Possible values are:
ascii
- Create derivative as an ASCII STL file.binary
- (Default) Create derivative as a binary STL file.
Height of thumbnails. Possible values are: 100
, 200
, 400
.If height
is omitted, but width
is specified, height
defaults to width
. If both width
and height
are omitted, the server will return a thumbnail closest to 200
, if such a thumbnail is available
Specifies how the hierarchy of items are determined. Applicable only when the source design is of type VUE.
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:
- The functioning of the SystemPath depends on the default setting of the property SP3D_SystemPath or System Path.
- The pathing delimiter must be .
- If you want to customize further, import the VUE file to Navisworks. After that, use POST job on the resulting Navisworks (nwc/nwd) file.
The first element of the array contains the name of the attribute to match (objectid
or externalId
). Use the MatchIdType
enum to pick the value for the first element. Subsequent elements contain the values to match.
For example, if you specify an array as: "$in":["objectid",1,2]
, the request will only return the properties of the objects with objectid
= 1
and 2
. If you specify an array as "$in":["externalId","doc_982afc8a","doc_afd75233" ]
the request will only return the properties of the objects with externalId
= doc_982afc8a
and doc_afd75233
.
Specifies the materials to apply to the generated SVF derivatives. Applicable only when the source design is of type RVT. Possible values are:
auto
- (Default) Use the current setting of the default view of the input file.basic
- Use basic materials.autodesk
- Use Autodesk materials.
The format that 2D views must be rendered to. Possible values are:
legacy
- (Default) Render to a model derivative specific file format.pdf
- Render to the PDF file format. When the source design is of type Revit, applies only to Revit 2022 files and newer. If the source design is of type DWG, only properties with semantic values are extracted.
Specifies how openings are translated. Applicable only when the source design is of type IFC. Possible values 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
.
The requested output types. Possible values include svf
, svf2
, thumbnail
, stl
, step
, iges
, obj
, ifc
or dwg
. For a list of supported types, call the GET formats endpoint.
Specifies the format for numeric values in the response body. Possible values:
text
- (Default) Returns all properties requested infields
without applying any special formatting.unit
- Applies a filter and returns only the properties that contain numerical values. Additionally, it formats property values as##<VALUE_OF_PROPERTY><UNIT_OF_VALUE<>PRECISION><SYSTEM_UNIT>
. For example##94.172{mm}[3]{m}
, where94.172
is the value of the property,{mm}
is the unit of the value,[3]
is the precision, and{m}
is the metric base unit for the measurement.
Specifies where the referenced files are stored. Possible values are:
- `US` - Data center for the US region.
- `EMEA` - Data center for the European Union, Middle East, and Africa.
- `APAC` - (Beta) Data center for the Australia region.
Note: Beta features are subject to change. Please avoid using them in production environments.
Specifies the type of a Model View.
Possible values are: 2d
, 3d
.
The sheet body type to export as, when the output is IGES. Possible values are:
open
shell
surface
- (Default)wireframe
The solid body type to export as, when the output is IGES. Possible values are:
solid
- (Default)surface
wireframe
Specifies how spaces are translated. Applicable only when the source design is of type IFC. Possible values 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
.
Specifies the surface type to export as, when the output is IGES. Possible values are
bounded
- (Default) Bounded surfacetrimmed
- Trimmed surfacewireframe
. Wireframe surface.’
The units the models must be translated to, when the output type is OBJ. For example, from millimeters (10, 123, 31) to centimeters (1.0, 12.3, 3.1). If the source unit or the unit you are translating to is not supported, the values remain unchanged. Possible values are:
meter
decimeter
centimeter
millimeter
micrometer
nanometer
yard
foot
inch
mil
microinch
Note: Not supported when the source design is F3D.
Required options for SVF type. Possible values are 2d
and 3d
.
Width of thumbnail in pixels. Possible values are: 100
, 200
, 400
If width
is omitted, but height
is specified, width
defaults to height
. If both width
and height
are omitted, the server will return a thumbnail closest to 200
, if such a thumbnail is available.
Specifies what Object IDs to return, if the design has legacy SVF derivatives generated by the BIM Docs service. Possible values are:
latest
- (Default) Return SVF2 Object IDs.fallback
- Return SVF Object IDs.
The execution status of the translation job. Possible values are: inprogress
, success
, failed
, timedout
The source of the thumbnail: Possible values are:
rendered
- Generated pursuant to this API callextracted
- Obtained from the original design file’