openapi: 3.0.1 info: title: Model Derivative version: '2.0' description: Use the Model Derivative API to translate designs from one CAD format to another. You can also use this API to extract metadata from a model. termsOfService: 'https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service' x-support: 'https://stackoverflow.com/questions/tagged/autodesk-model-derivative' contact: name: Autodesk Platform Services url: 'https://aps.autodesk.com/' email: aps.help@autodesk.com security: - 2-legged: - 'data:read' - 'data:write' - 3-legged: - 'data:read' - 'data:write' servers: - url: 'https://developer.api.autodesk.com' tags: - name: Informational - name: Jobs - name: Manifest - name: Derivatives - name: Thumbnails - name: Metadata components: securitySchemes: 3-legged: type: oauth2 flows: authorizationCode: authorizationUrl: 'https://developer.api.autodesk.com/authentication/v2/authorize' tokenUrl: 'https://developer.api.autodesk.com/authentication/v2/token' refreshUrl: 'https://developer.api.autodesk.com/authentication/v2/token' scopes: 'data:read': read your data 'data:write': modify your data 'data:create': create new data x-authentication_context: user context required description: User context required. 2-legged: type: oauth2 flows: clientCredentials: tokenUrl: 'https://developer.api.autodesk.com/authentication/v2/token' scopes: 'data:read': read application accessible data 'data:write': write application accessible data 'data:create': create application accessible data x-authentication_context: application context required description: Application context required. parameters: accept-encoding: name: Accept-Encoding in: header schema: type: string description: | A comma separated list of the algorithms you want the response to be encoded in, specified in the order of preference. If you specify ``gzip`` or ``*``, content is compressed and returned in gzip format. x-ads-force: name: x-ads-force in: header required: false schema: type: boolean description: | - ``true`` - Forces the system to parse property data all over again. Use this option to retrieve an object tree when previous attempts have failed. - ``false`` - (Default) Use previously parsed property data to extract the object tree. x-ads-force-job: name: x-ads-force in: header required: false schema: type: boolean description: | Specifies how the translation job must handle any existing manifest and derivatives. - ``true`` - Deletes the existing manifest and derivatives of the source design before translation. - ``false`` - (Default) Updates existing manifest and generates derivatives only for the formats that the source design has no derivatives. x-ads-derivative-format: name: x-ads-derivative-format in: header required: false schema: $ref: '#/components/schemas/XAdsDerivativeFormat' description: | Specifies which Object IDs to return if the design has legacy SVF derivatives generated by the BIM Docs or Forma Data Management service. Possible values: - ``latest`` - (Default) Return SVF2 Object IDs. - ``fallback`` - Return SVF Object IDs. **Note:** 1. This header applies only to designs with legacy SVF derivatives generated by the BIM 360 Docs or Forma Data Management service. 2. The BIM 360 Docs or Forma Data Management service now generates SVF2 derivatives. SVF2 Object IDs may not be compatible with the SVF Object IDs previously generated by the BIM 360 Docs or Forma Data Management service. Setting this header to fallback may resolve backward compatibility issues resulting from Object IDs of legacy SVF derivatives being retained on the client side. 3. If you use this header with one derivative (URN), you must use it consistently across the following operations: - `Create Translation Job `_ (for OBJ output) - `Fetch Object Tree `_ - `Fetch All Properties `_ - `Fetch Specific Properties `_ forceget: name: forceget in: query required: false schema: type: string description: | - ``true`` - Retrieves large resources, even beyond the 20 MB limit. If exceptionally large (over 800 MB), the system acts as if ``forceget`` is ``false``. - ``false`` - (Default) Does not retrieve resources if they are larger than 20 MB. region: name: region in: header schema: $ref: '#/components/schemas/Region' description: | Specifies the data center where the manifest and derivatives of the specified source design are stored. Possible values are: - ``US`` - (Default) Data center for the US region. - ``EMEA`` - Data center for the European Union, Middle East, and Africa. - ``AUS`` - Data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. source-design-urn: name: urn in: path schema: type: string description: The URL-safe Base64 encoded URN of the source design. This value is used as the ``urn`` URI parameter in operations to access data for this source design. required: true width: name: width in: query required: false schema: $ref: '#/components/schemas/Width' description: | Width of thumbnail in pixels. Possible values: - ``100`` - 100 pixels wide. - ``200`` - 200 pixels wide. - ``400`` - 400 pixels wide. 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. height: name: height in: query required: false schema: $ref: '#/components/schemas/Height' description: | Height of thumbnails in pixels. Possible values: - ``100`` - 100 pixels high. - ``200`` - 200 pixels high. - ``400`` - 400 pixels high. 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. headers: x-ads-startup-time: description: 'The service startup time, in the following date format: ``EEE MMM dd HH:mm:ss Z yyyy``.' schema: type: string x-ads-app-identifier: description: 'The service identifier. Comprises of the service name, version, and environment.' schema: type: string x-ads-duration: description: 'The amount of time spent servicing the request, in milliseconds.' schema: type: string x-ads-troubleshooting: description: 'Provides information about server failures, if any.' schema: type: string x-ads-size: description: 'Size in bytes of the request data. Additionally, the system uses this information to determine if a 413 (content too large) response is returned.' schema: type: string responses: 400-general: description: The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 401-general: description: The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 403-general: description: The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 404-general: description: The requested resource was not found. Review the request and try again. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 406-general: description: 'The request contains values that are not acceptable. Please check your request parameters, especially the headers and modify them to include a supported media type, or contact the support team for a list of available content types.' content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 409-general: description: 'The request could not be completed due to a conflict with the current state of a resource. For example, you may be trying to create a resource that is currently being created by another request. Please review the response body for details and adjust your request accordingly.' content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 429-general: description: The request was rejected because too many requests were sent within a specific time period. Wait before retrying the request. Check the response headers for rate limit information and recommended retry timing. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' 500-general: description: 'An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.' content: application/json: schema: $ref: '#/components/schemas/Diagnostic' schemas: Diagnostic: type: object title: Diagnostic description: Contains information about why the request failed. properties: diagnostics: type: string description: 'A detailed description of the error, which can help you troubleshoot the issue.' View: type: string description: Required options for SVF type. Possible values are ``2d`` and ``3d``. enum: - 2d - 3d title: '' Role: type: string minLength: 1 enum: - 2d - 3d description: |- Specifies the type of a Model View. Possible values are: ``2d``, ``3d``. Payload: type: string description: | Specifies the format for numeric values in the response body. Possible values: - ``text`` - (Default) Returns all properties requested in ``fields`` without applying any special formatting. - ``unit`` - Applies a filter and returns only the properties that contain numerical values. Additionally, it formats property values as ``##``. For example ``##94.172{mm}[3]{m}``, where ``94.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. minLength: 1 enum: - text - unit ConversionMethod: type: string enum: - legacy - modern - v3 - v4 description: |- 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. BuildingStoreys: type: string description: |- 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``. enum: - hide - show - skip Spaces: type: string description: |- 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``. enum: - hide - show - skip OpeningElements: type: string description: | 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``. enum: - hide - show - skip ExtractorVersion: type: string description: |- 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. enum: - next - previous MaterialMode: type: string description: |- 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. enum: - auto - basic - autodesk Hierarchy: type: string description: |- 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:** 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. enum: - Classic - SystemPath 2dView: type: string description: |- 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. enum: - legacy - pdf Width: type: integer description: | Width of thumbnail in pixels. Possible values: - ``100`` - 100 pixels wide. - ``200`` - 200 pixels wide. - ``400`` - 400 pixels wide. 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. enum: - 100 - 200 - 400 Height: type: integer description: | Height of thumbnails in pixels. Possible values: - ``100`` - 100 pixels high. - ``200`` - 200 pixels high. - ``400`` - 400 pixels high. 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. enum: - 100 - 200 - 400 Format: type: string description: | 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. default: binary enum: - binary - ascii ExportFileStructure: type: string description: | 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 default: single enum: - single - multiple ApplicationProtocol: type: string description: | 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. default: '214' enum: - '203' - '214' - '242' SurfaceType: type: string description: | Specifies the surface type to export as, when the output is IGES. Possible values are - ``bounded`` - (Default) Bounded surface - ``trimmed`` - Trimmed surface - `wireframe`. Wireframe surface.' default: bounded enum: - bounded - trimmed - wireframe SheetType: type: string description: | The sheet body type to export as, when the output is IGES. Possible values are: - ``open`` - ``shell`` - ``surface`` - (Default) - ``wireframe`` default: surface enum: - open - surface - shell - wireframe SolidType: type: string description: | The solid body type to export as, when the output is IGES. Possible values are: - ``solid`` - (Default) - ``surface`` - ``wireframe`` default: solid enum: - solid - surface - wireframe Unit: type: string description: |- 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. enum: - meter - decimeter - centimeter - millimeter - micrometer - nanometer - yard - foot - inch - mil - microinch XAdsRole: type: string enum: - rendered - extracted description: |- The source of the thumbnail: Possible values are: - ``rendered`` - Generated pursuant to this API call - ``extracted`` - Obtained from the original design file' XAdsJobStatus: type: string enum: - inprogress - success - failed - timedout description: 'The execution status of the translation job. Possible values are: ``inprogress``, ``success``, ``failed``, ``timedout``' Region: type: string description: | Specifies where the referenced files are stored. Possible values: - ``US`` - Data center for the US region. - ``EMEA`` - Data center for the European Union, Middle East, and Africa. - ``AUS`` - Data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. enum: - US - EMEA - AUS - CAN - DEU - IND - JPN - GBR SupportedFormats: description: Represents the successful response of a List Supported Formats operation. type: object properties: formats: type: object description: 'A dictionary object that contains a collection of key-value pairs, where each pair represents the target file format and the corresponding source file formats.' additionalProperties: type: array items: type: string description: | Key-value pairs. The key is the target file format. The value is an array of source design file formats that can be translated to the specified target file format. title: '' ObjectTree: description: Represents the successful response of a Fetch Object Tree operation. type: object properties: data: type: object description: Envelope that contains the returned data. required: - type - objects properties: type: type: string description: The type of data that is returned. Always ``objects``. minLength: 1 objects: type: array description: Collection of "objects" that constitute the nodes of the object tree. uniqueItems: true minItems: 1 items: type: object properties: objectid: type: number description: A non-persistent ID that is assigned to an object at translation time. name: type: string description: Name of the object. minLength: 1 objects: type: array description: An optional array of objects of type ``object`` where each object represents a child of the current node on the object tree. uniqueItems: true minItems: 1 items: type: object required: - objectid - name required: - objectid - name ModelViews: type: object properties: data: type: object description: Container for the data returned by the List Model Views operation. properties: type: type: string minLength: 1 description: The type of data that is returned. metadata: type: array uniqueItems: true minItems: 1 description: 'An array of objects, where each object represents a Model View.' items: type: object description: An array of flat JSON objects representing metadata. properties: name: type: string minLength: 1 description: Name of the Model View. guid: type: string minLength: 1 description: Unique ID of the Model View. role: $ref: '#/components/schemas/Role' isMasterView: type: boolean description: |- - ``true`` - Model View is a Master View derived from a Revit source design. - ``false`` - (Default) Model View is not a Master View. description: Represents the successful response of a List Model Views operation. PropertiesData: type: object description: Container for the data returned by the Fetch All Properties operation. properties: type: type: string minLength: 1 description: The type of data that is returned. Always ``properties``. collection: type: array uniqueItems: true minItems: 1 description: |- A non-hierarchical list of objects contained in the specified Model View. Each object has a ``properties`` attribute, which contains the properties of that object. items: type: object properties: objectid: type: number description: | Unique identifier of the object. **Note:** The ``objectid`` is a non-persistent ID assigned to an object when a design file is translated to SVF or SVF2. So: - The ``objectid`` of an object can change if the design is translated to SVF or SVF2 again. - If you require a persistent ID to reference an object, use ``externalId``. name: type: string minLength: 1 description: Name of the object. externalId: type: string minLength: 1 description: 'A unique identifier of the object as defined in the source design. For example, ``UniqueID`` in Revit files.' properties: type: object additionalProperties: true description: 'A JSON object containing dictionary objects (key value pairs), where the key is the property name and the value is the value of the property.' Properties: description: Represents a successful response to a Fetch All Properties operation. type: object properties: data: $ref: '#/components/schemas/PropertiesData' SpecificPropertiesPage: description: Represents the successful response of a Fetch Specific Properties operation. type: object properties: pagination: type: object description: Container for the attributes that define how the response paginated. required: - limit - offset - totalResults properties: limit: type: number description: The maximum number of properties you requested for this page. offset: type: number description: The number of items skipped (because they were returned in previous pages) when returning this page. totalResults: type: number description: The total number of properties to be returned. data: $ref: '#/components/schemas/PropertiesData' required: - pagination - data SpecificPropertiesPayload: type: object description: Represents the request body of a Fetch Specific Properties operation. properties: pagination: type: object description: 'Specifies how to split the response into multiple pages, and return the response one page at a time.' required: - offset - limit properties: offset: type: number description: 'The number of properties to skip. Use this attribute with the ``limit`` attribute to split the properties into multiple pages. To fetch the first page, specify ``offset`` =0 (do not skip any properties). To fetch the second page, specify ``offset`` = value of ``limit`` you specified for the first page. So, the server skips the properties returned on the first page. In general, ``offset`` = ``previous_offset`` + ``previous_limit``. This attribute is 0 by default. The minimum value is 0.' limit: type: number description: 'The maximum number of properties to return in a single page. Use this attribute with the ``offset`` attribute to split the properties into multiple pages. To fetch the first page, specify ``offset`` =0 (do not skip any properties). To fetch the second page, specify ``offset`` = value of ``limit`` you specified for the first page. So, the server skips the search results returned on the first page. In general, ``offset`` = ``previous_offset`` + ``previous_limit``. This attribute is 20 by default. The minimum value is 1 and the maximum is 1000.' query: description: |- Specifies what objects to query. Contains the parameters to pass to the search service. You can use one of the following forms: oneOf: - $ref: '#/components/schemas/MatchId' - $ref: '#/components/schemas/BeginsWith' - $ref: '#/components/schemas/EqualsTo' - $ref: '#/components/schemas/Between' - $ref: '#/components/schemas/LessThan' - $ref: '#/components/schemas/GreaterThan' - $ref: '#/components/schemas/Contains' fields: type: array items: type: string description: | Specifies what properties of the objects to return. If you do not specify this attribute, the response returns all properties. Possible values are: - ``properties`` - Return all properties. - ``properties.something``- Return the property named ``something`` and all its children. - ``properties.some*`` - Return all properties with names that begin with ``some`` and all their children. - ``properties.category.*`` - Return the property named ``category`` and all its children. - ``properties.*.property`` - Return any property named ``property`` regardless of its parent. payload: $ref: '#/components/schemas/Payload' required: - pagination - query - fields Manifest: type: object properties: urn: type: string description: The URL-safe Base64 encoded URN of the source design. derivatives: type: array description: 'An array of objects, where each object represents a derivative of the source design.' items: $ref: '#/components/schemas/ManifestDerivative' hasThumbnail: type: string minLength: 1 description: | - ``true``: There is a thumbnail for the source design. - ``false``: There is no thumbnail for the source design. progress: type: string minLength: 1 description: 'Indicates the overall progress of all translation jobs, as a percentage. Once all requested derivatives are generated, the value changes to ``complete``.' type: type: string minLength: 1 description: The type of data that is returned. Always ``manifest``. region: type: string minLength: 1 description: | Specifies the data center where the manifest, derivatives, and references are stored. Possible values are: - ``US`` - Data center for the US region. - ``EMEA`` - Data center for European Union, Middle East, and Africa. - ``AUS`` - Data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. version: type: string minLength: 1 description: Indicates the version of the schema that the manifest is based on. status: type: string minLength: 1 description: 'Overall status of all translation jobs for the source design. Possible values are: ``pending``, ``success``, ``inprogress``, ``failed``, ``timeout``.' description: Represents the successful response of a Fetch Manifest operation. JobPayload: type: object description: Represents the request body of a Create Translation Job operation. required: - input - output properties: input: type: object description: Describes the attributes of the source design. required: - urn properties: urn: type: string description: | The URL safe Base64 encoded URN of the source design. **Note:** The URN is returned as the ``objectID`` once you complete uploading the source design to APS. This value must be converted to a `Base64 (URL Safe) encoded `_ string before you can specify it for this attribute. compressedUrn: type: boolean description: | - ``true`` - The source design is compressed as a zip file. If set to ``true``, you need to define the ``rootFilename`` attribute. - ``false`` - (Default) The source design is not compressed. default: false rootFilename: type: string description: The file name of the top-level component of the source design. Mandatory if ``compressedUrn`` is set to ``true``. checkReferences: type: boolean description: |- - ``true`` - Instructs the system to check for references and, if any exist, download all referenced files. Setting this attribute to ``true`` is mandatory when translating source designs consisting of multiple files, such as Autodesk Inventor assemblies. - ``false`` - (Default) Instructs the system not to check for references. output: type: object description: Describes the attributes of the requested derivatives. required: - formats properties: destination: type: object description: |- (Deprecated) Specifies where to store generated derivatives. **Note:** Please use the ``region`` header instead of this attribute. deprecated: true properties: region: type: string description: | Specifies where to store generated derivatives. Possible values are: - ``US`` - (Default) Store derivatives at a data center for the United States of America. - ``EMEA`` - Store derivatives at a data center for the European Union. - ``AUS`` - Store derivatives at a data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. **Note**: - Please use the ``region`` header instead of this attribute. deprecated: true formats: type: array description: 'An array of objects, where each object represents a requested derivative format. You can request multiple derivatives.' items: $ref: '#/components/schemas/JobPayloadFormat' misc: type: object description: Contains webhook configuration settings for notifying external systems about translation job events. properties: workflow: type: string description: 'The workflow ID of the webhook that listens to Model Derivative events. It must be 36 characters or less and can only contain alphanumeric characters (A-Z, 0-9) and hyphens (-).' workflowAttribute: type: object description: 'A user-defined JSON object, which you can use to set some custom workflow information. It must be less than 1KB and is ignored if ``misc.workflow`` is not specified.' JobPayloadFormat: description: Contains the configuration settings for each output type a translation job must produce. The available options depend on the output type. anyOf: - $ref: '#/components/schemas/JobPayloadFormatSVF' - $ref: '#/components/schemas/JobPayloadFormatSVF2' - $ref: '#/components/schemas/JobPayloadFormatThumbnail' - $ref: '#/components/schemas/JobPayloadFormatSTL' - $ref: '#/components/schemas/JobPayloadFormatSTEP' - $ref: '#/components/schemas/JobPayloadFormatIGES' - $ref: '#/components/schemas/JobPayloadFormatOBJ' - $ref: '#/components/schemas/JobPayloadFormatDWG' - $ref: '#/components/schemas/JobPayloadFormatIFC' JobPayloadFormatSVF: type: object description: Describes the options for translation jobs producing SVF outputs. properties: views: type: array description: Specifies the type of view to generate. Possible values are `2d` and `3d`. items: $ref: '#/components/schemas/View' type: $ref: '#/components/schemas/OutputType' advanced: description: Contains advanced configuration settings for translation jobs producing ``svf`` outputs. The available options depend on the input type. oneOf: - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedRVT' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedDGN' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedDWG' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedIDW' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedIFC' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedNWD' - $ref: '#/components/schemas/JobPayloadFormatSVFAdvancedVUE' type: object title: SVF Options JobPayloadFormatSVF2: type: object description: Describes the options for translation jobs producing SVF2 outputs. properties: views: type: array description: Specifies the type of view to generate. Possible values are `2d` and `3d`. items: $ref: '#/components/schemas/View' type: $ref: '#/components/schemas/OutputType' advanced: description: Contains advanced configuration settings for translation jobs producing ``svf2`` outputs. The available options depend on the input type. anyOf: - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedRVT' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedDGN' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedDWG' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedIDW' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedIFC' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedNWD' - $ref: '#/components/schemas/JobPayloadFormatSVF2AdvancedVUE' type: object title: SVF2 Options JobPayloadFormatThumbnail: type: object description: Describes the options for translation jobs producing thumbnail outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedThumbnail' title: Thumbnail Options JobPayloadFormatSTL: type: object description: Describes the options for translation jobs producing STL outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedSTL' title: STL Options JobPayloadFormatIGES: type: object example: type: svf advanced: tolerance: 0.001 surfaceType: bounded sheetType: surface solidType: solid description: Describes the options for translation jobs producing IGES outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedIGES' title: IGES Options JobPayloadFormatSTEP: type: object description: Describes the options for translation jobs producing STEP outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedSTEP' title: STEP Options JobPayloadFormatOBJ: type: object description: Describes the options for translation jobs producing OBJ outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedOBJ' title: OBJ Options JobPayloadFormatDWG: type: object description: Describes the options for translation jobs producing DWG outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedDWG' title: DWG Options JobPayloadFormatIFC: type: object description: Describes the options for translation jobs producing IFC outputs. properties: type: $ref: '#/components/schemas/OutputType' advanced: $ref: '#/components/schemas/JobPayloadFormatAdvancedIFC' title: IFC Options Job: required: - acceptedJobs - result - urn type: object properties: result: type: string description: reporting success status urn: type: string description: the urn identifier of the source file acceptedJobs: required: - output type: object properties: output: type: object properties: {} description: 'Identical to the ``output`` object of the request body. For information on each attribute, see the request body structure description.' description: List of the requested outputs. title: '' description: Represents the successful response of a Create Translation Job operation. XAdsDerivativeFormat: type: string title: XAdsDerivativeFormat description: |- 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. enum: - latest - fallback DerivativeDownload: title: DerivativeDownload type: object description: Represents the successful response of a Fetch Derivative Download operation. properties: etag: type: string description: 'The calculated ETag hash of the derivative/file, if available.' size: type: number description: 'The size of the derivative/file, in bytes.' url: type: string description: The download URL. content-type: type: string description: The content type of the derivative/file. expiration: type: number description: The 13-digit epoch time stamp indicating the time the signed cookies expire. JobPayloadFormatSVFAdvancedRVT: type: object description: Contains advanced configuration settings for translation jobs processing Revit inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' extractorVersion: $ref: '#/components/schemas/ExtractorVersion' generateMasterViews: type: boolean description: |- Specifies whether to generate master views when translating from the Revit input format to SVF. This option is ignored for all other input formats. Possible values: - ``true`` - Generate master views. - ``false`` - (Default) Do not generate master views. Master views are 3D views that are generated for each phase of the Revit model. A master view contains all elements (including “room” elements) present in the host model for that phase. The display name of a master view defaults to the name of the phase it is generated from. However, if a view with that name already exists, the Model Derivative service appends a suffix to the default display name. **Notes:** 1. Master views do not contain elements from linked models. 2. Enabling this option can increase the time it takes to translate the model. materialMode: $ref: '#/components/schemas/MaterialMode' title: Revit JobPayloadFormatSVF2AdvancedRVT: type: object description: Contains advanced configuration settings for translation jobs processing Revit inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' extractorVersion: $ref: '#/components/schemas/ExtractorVersion' generateMasterViews: type: boolean description: |- Specifies whether to generate master views when translating from the Revit input format to SVF. This option is ignored for all other input formats. Possible values: - ``true`` - Generate master views. - ``false`` - (Default) Do not generate master views. Master views are 3D views that are generated for each phase of the Revit model. A master view contains all elements (including “room” elements) present in the host model for that phase. The display name of a master view defaults to the name of the phase it is generated from. However, if a view with that name already exists, the Model Derivative service appends a suffix to the default display name. **Notes:** 1. Master views do not contain elements from linked models. 2. Enabling this option can increase the time it takes to translate the model. materialMode: $ref: '#/components/schemas/MaterialMode' title: Revit JobPayloadFormatSVFAdvancedIFC: type: object description: Contains advanced configuration settings for translation jobs processing IFC inputs. properties: conversionMethod: $ref: '#/components/schemas/ConversionMethod' buildingStoreys: $ref: '#/components/schemas/BuildingStoreys' spaces: $ref: '#/components/schemas/Spaces' openingElements: $ref: '#/components/schemas/OpeningElements' title: IFC JobPayloadFormatSVF2AdvancedIFC: type: object description: Contains advanced configuration settings for translation jobs processing IFC inputs. properties: conversionMethod: $ref: '#/components/schemas/ConversionMethod' buildingStoreys: $ref: '#/components/schemas/BuildingStoreys' spaces: $ref: '#/components/schemas/Spaces' openingElements: $ref: '#/components/schemas/OpeningElements' title: IFC JobPayloadFormatSVFAdvancedDGN: type: object description: Contains advanced configuration settings for translation jobs processing DGN inputs. properties: requestedLinkageIDs: type: array description: An array containing user data linkage IDs of the linkage data to be extracted from the DGN file. Linkage data is not extracted if you do not specify this attribute. items: type: integer title: DGN JobPayloadFormatSVF2AdvancedDGN: type: object description: Contains advanced configuration settings for translation jobs processing DGN inputs. properties: requestedLinkageIDs: type: array description: An array containing user data linkage IDs of the linkage data to be extracted from the DGN file. Linkage data is not extracted if you do not specify this attribute. items: type: integer title: DGN JobPayloadFormatSVFAdvancedDWG: type: object description: Contains advanced configuration settings for translation jobs processing DWG inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' title: DWG JobPayloadFormatSVFAdvancedIDW: type: object description: Contains advanced configuration settings for translation jobs processing IDW inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' title: IDW JobPayloadFormatSVF2AdvancedIDW: type: object description: Contains advanced configuration settings for translation jobs processing IDW inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' title: IDW JobPayloadFormatSVF2AdvancedDWG: type: object description: Contains advanced configuration settings for translation jobs processing DWG inputs. properties: 2dviews: $ref: '#/components/schemas/2dView' title: DWG JobPayloadFormatSVFAdvancedNWD: type: object description: Contains advanced configuration settings for translation jobs processing NWD inputs. properties: hiddenObjects: type: boolean description: | Specifies whether hidden objects must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract hidden objects from the input file. - ``false``: (Default) Do not extract hidden objects from the input file. basicMaterialProperties: type: boolean description: | Specifies whether basic material properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract properties for basic materials. - ``false``: (Default) Do not extract properties for basic materials. autodeskMaterialProperties: type: boolean description: | Specifies whether Autodesk material properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract properties for Autodesk materials. - ``false``: (Default) Do not extract properties for Autodesk materials. timelinerProperties: type: boolean description: | Specifies whether timeliner properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract timeliner properties. - ``false``: (Default) Do not extract timeliner properties. title: NWD JobPayloadFormatSVF2AdvancedNWD: type: object description: Contains advanced configuration settings for translation jobs processing NWD inputs. properties: hiddenObjects: type: boolean description: | Specifies whether hidden objects must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract hidden objects from the input file. - ``false``: (Default) Do not extract hidden objects from the input file. basicMaterialProperties: type: boolean description: | Specifies whether basic material properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract properties for basic materials. - ``false``: (Default) Do not extract properties for basic materials. autodeskMaterialProperties: type: boolean description: | Specifies whether Autodesk material properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract properties for Autodesk materials. - ``false``: (Default) Do not extract properties for Autodesk materials. timelinerProperties: type: boolean description: | Specifies whether timeliner properties must be extracted. Applicable only when the source design type is Navisworks. - ``true``: Extract timeliner properties. - ``false``: (Default) Do not extract timeliner properties. title: NWD JobPayloadFormatSVFAdvancedVUE: type: object description: Contains advanced configuration settings for translation jobs processing VUE inputs. properties: hierarchy: $ref: '#/components/schemas/Hierarchy' title: VUE JobPayloadFormatSVF2AdvancedVUE: type: object description: Contains advanced configuration settings for translation jobs processing VUE inputs. properties: hierarchy: $ref: '#/components/schemas/Hierarchy' title: VUE Messages: type: object description: 'An array of objects where each object represents a message logged to the manifest during translation. For example, error messages and warning messages.' properties: type: type: string description: 'Indicates the type of the message. For example, warning indicates a warning message and error indicates an error message.' code: type: string description: 'The ID of the message. For example, the error code reported by an error message.' message: type: object description: A human-readable explanation of the event being reported. Can be a string or an array of string. ManifestDerivative: type: object description: Represents a derivative generated for the source design. properties: name: type: string minLength: 1 description: The name of the source design. hasThumbnail: type: string minLength: 1 description: | - ``true``: The derivative has a thumbnail. - ``false``: The derivative does not have a thumbnail. progress: type: string minLength: 1 description: 'Indicates the progress of the process generating this derivative, as a percentage. Once complete, the value changes to ``complete``.' outputType: type: string minLength: 1 description: 'The file type/format of the derivative. Possible values are: ``dwg``, ``fbx``, ``ifc``, ``iges``, ``obj`` , ``step``, ``stl``, ``svf``, ``svf2``, ``thumbnail``.' properties: type: object description: |- A JSON object containing metadata extracted from the source design. This metadata provides valuable information about the model, such as its author, client name, project status, and other relevant details. **Note:** This metadata is currently returned for the following source design types: - RVT - Revit models - NWD - Navisworks models - DWG - AutoCAD models status: type: string minLength: 1 description: 'Status of the task generating this derivative. Possible values are: ``pending``, ``inprogress``, ``success``, ``failed``, ``timeout``.' messages: type: array description: 'An array of objects where each object represents a message logged to the manifest during translation. For example, error messages and warning messages.' items: $ref: '#/components/schemas/Messages' children: type: array description: 'An array of objects, where each object represents a resource generated for the derivative. For example, a Model View (Viewable) of the source design.' items: $ref: '#/components/schemas/ManifestResources' ManifestResources: type: object description: Represents a resource generated for a derivative. properties: guid: type: string minLength: 1 description: An ID that uniquely identifies the resource. type: type: string minLength: 1 description: Type of resource this JSON object represents. urn: type: string minLength: 1 description: The URN that you can use to access the resource. role: type: string minLength: 1 description: File type of the resource. mime: type: string minLength: 1 description: MIME type of the content of the resource. viewableID: type: string minLength: 1 description: An ID assigned to a resource that can be displayed in a viewer. name: type: string minLength: 1 description: The name of the resource. status: type: string minLength: 1 description: 'Status of the task generating this resource; Possible values are: ``pending``, ``inprogress``, ``success``, ``failed``, ``timeout``' hasThumbnail: type: string minLength: 1 description: | - ``true``: There is a thumbnail for the resource. - ``false``: There is no thumbnail for the resource. progress: type: string minLength: 1 description: 'Indicates the progress of the process generating this resource, as a percentage. Once complete, the value changes to ``complete``.' phaseNames: description: The name of the phase the resource file was generated from. This attribute is present only on Model Views (Viewables) generated from a Revit source design. This attribute can be a string (for Revit non-sheet 2D or 3D views) or an array of strings (for Revit sheet views). oneOf: - type: string - type: array items: type: string phaseIds: description: The unique ID of the phase the resource file was generated from. This attribute is present only on Model Views (Viewables) generated from a Revit source design. This attribute can be a string (for Revit non-sheet 2D or 3D views) or an array of strings (for Revit sheet views). oneOf: - type: string - type: array items: type: string camera: type: array description: The default viewpoint of a viewable 3D resource. items: type: number resolution: type: array description: 'An array of two integers where the first number represents the width of a thumbnail in pixels, and the second the height. Available only for thumbnail resources.' items: type: integer messages: type: array description: 'An array of objects where each object represents a message logged to the manifest during translation. For example, error messages and warning messages.' items: $ref: '#/components/schemas/Messages' children: description: 'An optional array of objects, where each object (of type ``children``) represents another resource generated for this resource.' type: array items: $ref: '#/components/schemas/ManifestResources' JobPayloadFormatAdvancedDWG: title: DWG type: object properties: exportSettingName: type: string description: The export settings should be one of the DWG Export settings pre-saved in the source design. description: Contains advanced configuration settings for translation jobs producing DWG outputs. JobPayloadFormatAdvancedIFC: title: IFC type: object properties: exportSettingName: type: string description: The export settings should be one of the IFC Export settings pre-saved in the source design. description: Contains advanced configuration settings for translation jobs producing IFC outputs. JobPayloadFormatAdvancedIGES: title: IGES type: object properties: tolerance: type: number description: Possible values are between `0` and `1`. By default it is set at 0.001. format: float default: 0.001 surfaceType: $ref: '#/components/schemas/SurfaceType' sheetType: $ref: '#/components/schemas/SheetType' solidType: $ref: '#/components/schemas/SolidType' description: Contains advanced configuration settings for translation jobs producing IGES outputs. JobPayloadFormatAdvancedOBJ: title: OBJ type: object properties: type: type: string description: The requested output type. ``obj`` in this case. advanced: type: object description: Contains advanced configuration settings for translation jobs producing `obj` outputs. properties: exportFileStructure: $ref: '#/components/schemas/ExportFileStructure' unit: $ref: '#/components/schemas/Unit' modelGuid: type: string description: Required for geometry extractions. Specifies the ID of the Model View that contains the geometry to extract. objectIds: type: array description: | Required for geometry extractions. Specifies the IDs of the objects (``objectID) to extract. -1 will extract the entire model. items: type: integer description: Contains advanced configuration settings for translation jobs producing `obj` outputs. JobPayloadFormatAdvancedSTEP: title: STEP type: object properties: applicationProtocol: $ref: '#/components/schemas/ApplicationProtocol' tolerance: type: number description: Possible values are between `0` and `1`. By default it is set at 0.001. format: float default: 0.001 description: Contains advanced configuration settings for translation jobs producing a STEP output. JobPayloadFormatAdvancedSTL: title: STL type: object properties: type: type: string description: The requested output type. ``stl`` in this case. advanced: type: object description: Contains advanced configuration settings for translation jobs producing `stl` outputs. properties: format: $ref: '#/components/schemas/Format' exportColor: type: boolean description: | - ``true`` - (Default) Exports color. - ``false`` - Does not export color. default: true exportFileStructure: $ref: '#/components/schemas/ExportFileStructure' description: Contains advanced configuration settings for translation jobs producing `stl` outputs. JobPayloadFormatAdvancedThumbnail: title: Thumbnail type: object properties: width: $ref: '#/components/schemas/Width' height: $ref: '#/components/schemas/Height' description: Contains advanced configuration settings for translation jobs producing thumbnail outputs. MatchId: title: Match Id type: object description: Describes a query for retrieving objects having the specified Object IDs or External IDs. properties: $in: type: array description: | Returns only the objects with their ``objectid`` or ``externalId`` attribute exactly matching one of the values specified in the array. The first element of the array contains the name of the attribute to match (``objectid`` or ``externalId``). 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``. items: oneOf: - type: string - type: number required: - '$in' additionalProperties: false BeginsWith: title: Begins With type: object description: Describes a query for retrieving objects with names that start with a specified string. properties: $prefix: type: array description: | Returns only the objects with their ``name`` attribute beginning with the specified string. The first element of the array contains the name of the attribute to match (``name``). The second element contains the string to match. The array can have only two elements. Only the objects whose name begin with the specified string are returned. items: type: string required: - '$prefix' additionalProperties: false EqualsTo: title: Equals To type: object description: Describes a query for retrieving objects where a specified attribute exactly matches a specified value. properties: $eq: type: array description: |- Returns only the objects where the value of the specified attribute (``name`` attribute or any numerical property) is exactly equal to the specified value. The first element of the array contains the name of the attribute. This can be the ``name`` attribute or the name of a numerical property. The second element of the array must be the value to match. If the first element is ``name``, must be a string value. If the first element is a numerical property, must be a numeric. The array can only be two elements long. For example, if you specify an array as: ``"$eq":["name","Rectangular"]``, the request will only return the properties of the object named ``Rectangular``. if you specify an array as: ``"$eq":["properties.Dimensions.Width1",0.6]``, the request will return the properties of all objects whose ``properties.Dimensions.Width1`` property is exactly equal to ``0.6``. **Note:** We recommend that you use ``$between`` instead of ``$eq`` when testing non-integer numeric values for equality. Using ``between`` mitigates floating-point errors. items: oneOf: - type: string - type: number required: - '$eq' additionalProperties: false Between: title: Between type: object description: Describes a query for retrieving objects where a specified numeric property falls within a specified range. properties: $between: type: array description: |- Returns only the objects where the value of the specified numeric property lies between the specified values. The first element of the array contains the name of the property. The next two elements specify the values that the property must lie between. The array can only be three elements long. For example, if you specify an array as: ``"$between":["properties.Dimensions.Width1",1,10]``, the request returns the properties of all objects whose ``properties.Dimensions.Width1`` property is between ``1`` and ``10``. **Note:** The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, you must specify the values to compare with in metric base units. For example, if the property you are comparing is a length measurement, you must specify the values in ``m``. Not in ``cm``, ``mm``, or ``ft``. items: oneOf: - type: string - type: number required: - '$between' additionalProperties: false LessThan: title: Less Than type: object description: Describes a query for retrieving objects where a specified numeric property is less than or equal to a specified value. properties: $le: type: array description: |- Returns only the objects where the value of the specified numeric property is less than or equal to the specified value. The first element of the array contains the name of the property. The next element specifies the values that the property must be less than or equal to. The array can only be two elements long. For example, if you specify an array as: ``"$le":["properties.Dimensions.Width1",10]``, the request returns the properties of all objects whose ``properties.Dimensions.Width1`` property is less than or equal to ``10``. **Note:** The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, the value to compare with must be specified in metric base units. For example, if the property you are comparing is a length measurement, you must specify the value in ``m``. Not in ``cm``, ``mm``, or ``ft``. items: oneOf: - type: string - type: number required: - '$le' additionalProperties: false GreaterThan: title: Greater Than type: object description: 'Use this to retrieve only the properties of objects where a specified property is greater than a specified value. ' properties: $ge: type: array description: | Returns only the objects where the value of the specified numerical property is greater than or equal to the specified value. The first element of the array contains the name of the property. The next element specifies the values that the property must be greater than or equal to. The array can only be two elements long. For example, if you specify an array as: ``"$ge":["properties.Dimensions.Width1",0.1]``, the request returns the properties of all objects whose ``properties.Dimensions.Width1`` property is greater than or equal to ``0.1``. **Note:** The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, the value to compare with must be specified in metric base units. For example, if the property you are comparing is a length measurement, you must specify the value in ``m``. Not in ``cm``, ``mm``, or ``ft``. items: oneOf: - type: string - type: number required: - '$ge' additionalProperties: false Contains: title: Contains type: object description: Describes a query for retrieving objects where a specified property contains one or more words in a specified string. properties: $contains: type: array description: |- Returns only the objects where the value of the specified property contains the words specified in a string. The first element of the array contains the name of the property. The second element contains a string containing the words to match. The array can only be two elements long. For example, if you specify an array as: ``"$contains":["properties.Materials and Finishes.Structural Material","Concrete Situ"]``, the request returns the properties of all objects whose ``properties.Materials and Finishes.Structural Material`` property contains the words ``Concrete`` and ``Situ``. You can specify up to 50 words. items: type: string required: - '$contains' additionalProperties: false DeleteManifest: title: DeleteManifest type: object properties: result: type: string description: A message describing outcome of the operation. Always ``success`` for status ``200``. description: 'Represents the successful response of a Delete Manifest operation. ' SpecifyReferencesPayload: title: SpecifyReferencesPayload type: object properties: urn: type: string description: The URL safe Base64 encoded URN of the source design. Mandatory if the Base64 encoded urn in the request URL is a logical URN. region: $ref: '#/components/schemas/Region' filename: type: string minLength: 1 description: 'The file name of the top level component. By default, it is set to ``""`` and the file will be download with its ``urn``.' references: type: array uniqueItems: true minItems: 1 description: 'An array of objects, where each object represents a referenced file.' items: type: object properties: urn: type: string minLength: 1 description: The URN of the referenced file. relativePath: type: string minLength: 1 description: 'The path to the referenced file, relative to the top level component. By default, it is set to ``""``, which means that the referenced file and top level component are in the same folder.' filename: type: string minLength: 1 description: 'The file name of the referenced file. By default, it is set to ``""`` and the referenced file will be downloaded by its ``urn`` and placed relative to the top-level component using ``relativePath``.' metadata: type: object additionalProperties: type: object description: An object to hold custom metadata. required: - urn - relativePath - filename required: - urn - filename - references description: Represents the request body of a Specify References operation. SpecifyReferences: title: SpecifyReferences type: object properties: result: type: string description: The result of the operation. Always ``success`` for status ``200``. urn: type: string description: The URN of the top level component. description: 'Represents the successful response of a Specify References operation. ' OutputType: title: OutputType type: string description: 'The requested output types. Possible values include `svf`, `svf2`, `thumbnail`, `stl`, `step`, `iges`, `obj`, `ifc` or `dwg`. For a list of supported types, call [List Supported Formats](/en/docs/model-derivative/v2/reference/http/formats-GET).' enum: - svf - svf2 - thumbnail - stl - step - iges - obj - ifc - dwg - fbx MatchIdType: title: MatchIdType type: string description: |- The first element of the array contains the name of the attribute to match (`objectid` or `externalId`). 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`. enum: - objectid - externalId paths: /modelderivative/v2/designdata/formats: get: summary: List Supported Formats tags: - Informational responses: '200': description: A list of supported formats was successfully retrieved. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' Last-Modified: schema: type: string description: 'Indicates the date and time (in ``Day of the week, DD Month YYYY HH:MM:SS GMT`` format) the supported formats were last modified.' content: application/json: schema: $ref: '#/components/schemas/SupportedFormats' examples: all-formats: summary: This example demonstrates the successful retrieval of all supported formats. value: formats: dwg: - f2d - f3d - rvt fbx: - f3d ifc: - rvt iges: - f3d - fbx - iam - ipt - wire obj: - asm - f3d - fbx - iam - ipt - neu - prt - sldasm - sldprt - smb - smt - step - stp - stpz - wire - x_b - x_t - asm\.\d+$ - neu\.\d+$ - prt\.\d+$ step: - f3d - fbx - iam - ipt - smb - smt - wire stl: - f3d - fbx - iam - ipt - wire svf: - 3dm - 3ds - a - asm - axm - brd - catpart - catproduct - cgr - collaboration - dae - ddx - ddz - dgk - dgn - dlv3 - dmt - dwf - dwfx - dwg - dwt - dxf - emodel - exp - f3d - fbrd - fbx - fsch - g - gbxml - glb - gltf - iam - idw - ifc - ifw - ige - iges - igs - ipt - iwm - jt - max - model - mpf - msr - neu - nwc - nwd - obj - osb - par - pdf - pmlprj - pmlprjz - prt - psm - psmodel - rcp - rvt - sab - sat - sch - session - skp - sldasm - sldprt - smb - smt - ste - step - stl - stla - stlb - stp - stpz - vpb - vue - wire - x_b - x_t - xas - xpr - zip - asm\.\d+$ - neu\.\d+$ - prt\.\d+$ svf2: - 3dm - 3ds - a - asm - axm - brd - catpart - catproduct - cgr - collaboration - dae - ddx - ddz - dgk - dgn - dlv3 - dmt - dwf - dwfx - dwg - dwt - dxf - emodel - exp - f3d - fbrd - fbx - fsch - g - gbxml - glb - gltf - iam - idw - ifc - ifw - ige - iges - igs - ipt - iwm - jt - max - model - mpf - msr - neu - nwc - nwd - obj - osb - par - pdf - pmlprj - pmlprjz - prt - psm - psmodel - rcp - rvt - sab - sat - sch - session - skp - sldasm - sldprt - smb - smt - ste - step - stl - stla - stlb - stp - stpz - vpb - vue - wire - x_b - x_t - xas - xpr - zip - asm\.\d+$ - neu\.\d+$ - prt\.\d+$ thumbnail: - 3dm - 3ds - a - asm - axm - axmf - brd - catpart - catproduct - cgr - collaboration - dae - ddx - ddz - dgk - dgn - dlv3 - dmt - dwf - dwfx - dwg - dwgx - dwt - dxf - emodel - exp - f2d - f3d - fbrd - fbx - flbr - fprj - fsch - g - gbxml - glb - gltf - iam - idw - ifc - ifw - ige - iges - igs - ipt - iwm - jt - max - model - mpf - msr - neu - nwc - nwd - obj - osb - par - pdf - pmlprj - pmlprjz - prt - psm - psmodel - rcp - rva - rvt - sab - sat - sch - session - skp - sldasm - sldprt - smb - smt - ste - step - stl - stla - stlb - stp - stpz - vpb - vue - wire - x_b - x_t - xas - xpr - zip - asm\.\d+$ - neu\.\d+$ - prt\.\d+$ '304': description: Supported formats have not changed since the date specified by the ``If-Modified-Since`` header. '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: getFormats description: |- Retrieves an up-to-date list of supported translations, including information on the types of derivatives that can be generated for each source design file type. You can also obtain a list of translations that have changed since a specified date. See the [Supported Translation Formats table](/en/docs/model-derivative/v2/overview/supported-translations/) for more details. **Note:** New file formats are continuously added to the supported translations list. parameters: - schema: type: string in: header name: If-Modified-Since description: 'Specifies a date in the ``Day of the week, DD Month YYYY HH:MM:SS GMT`` format. The response will contain only the formats modified since the specified date and time. If you specify an invalid date, the response will contain all supported formats. If no changes have been made after the specified date, the service returns HTTP status ``304``, NOT MODIFIED.' - $ref: '#/components/parameters/accept-encoding' security: - 2-legged: [] - 3-legged: [] x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/formats" -X GET -H "Authorization: Bearer eyJh..."' parameters: [] '/modelderivative/v2/designdata/{urn}/metadata': parameters: - $ref: '#/components/parameters/source-design-urn' get: summary: List Model Views tags: - Metadata responses: '200': description: A list of Model Views was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/ModelViews' examples: model-views: summary: This example demonstrates the successful retrieval of a list of model views and their IDs (200). value: data: type: metadata metadata: - name: NAVISWORKS/IFC EXPORT role: 3d guid: 04b9a71d-9015-0a7b-338b-8522a705a8d7 - name: New Construction role: 3d guid: 1d6e48c5-e4a4-8ca5-5b02-3f2acc354470 isMasterView: true - name: 001 - 4128-AA-DC-681100**_IS01 role: 2d guid: eea006f7-042b-c298-d497-9ef4047e8378 headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: getModelViews description: |- Retrieves a list of Model Views (Viewables) in the source design specified by the ``urn`` URI parameter. The response also returns an ID that uniquely identifies each Model View. You can use these IDs with other metadata operations to obtain information about the objects within those Model Views. Designs created with applications like Fusion 360 and Inventor contain only one Model View per design. Applications like Revit allow multiple Model Views per design. **Note:** You can retrieve metadata only from a design that has already been translated to SVF or SVF2. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata" -X GET -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json"' parameters: - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/region' '/modelderivative/v2/designdata/{urn}/metadata/{modelGuid}': parameters: - $ref: '#/components/parameters/source-design-urn' - name: modelGuid in: path required: true schema: type: string description: The ID of the Model View you are extracting the object tree from. Use the `List Model Views `_ operation to obtain the IDs of the Model Views in the source design. get: summary: Fetch Object tree tags: - Metadata operationId: getObjectTree description: | Retrieves the structured hierarchy of objects, known as an object tree, from the specified Model View (Viewable) within the specified source design. The object tree represents the arrangement and relationships of various objects present in that Model View. **Note:** A design file must be translated to SVF or SVF2 before you can retrieve its object tree. Before you call this operation: - Use the `List Model Views `_ operation to obtain the list of Model Views in the source design. - Pick the ID of the Model View you want to query and specify that ID as the value for the ``modelGuid`` URI parameter. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40" -X GET -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json"' parameters: - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/region' - $ref: '#/components/parameters/x-ads-force' - $ref: '#/components/parameters/x-ads-derivative-format' - $ref: '#/components/parameters/forceget' - schema: type: integer in: query name: objectid description: 'If specified, retrieves the sub-tree that has the specified Object ID as its parent node. If this parameter is not specified, retrieves the entire object tree.' - schema: type: string in: query name: level description: 'Specifies how many child levels of the hierarchy to return, when the ``objectid`` parameter is specified. Currently supports only ``level`` = ``1``.' responses: '200': description: The object tree of the specified Model View was successfully retrieved. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' x-ads-size: $ref: '#/components/headers/x-ads-size' content: application/json: schema: $ref: '#/components/schemas/ObjectTree' examples: object-tree: summary: This example demonstrates the successful retrieval of object hierarchy of a Revit model (200). value: data: type: objects objects: - objectid: 1 name: A5 objects: - objectid: 2 name: Model objects: - objectid: 3 name: Bottom objects: - objectid: 4 name: Box - objectid: 5 name: Pillar objects: - objectid: 6 name: Cylinder - objectid: 7 name: Top objects: - objectid: 8 name: Box '202': description: The request was accepted but processing is not complete. Repeat the request until you receive an HTTP status of ``200``. content: application/json: schema: type: object '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '406': $ref: '#/components/responses/406-general' '409': $ref: '#/components/responses/409-general' '429': $ref: '#/components/responses/429-general' '500': $ref: '#/components/responses/500-general' '/modelderivative/v2/designdata/{urn}/metadata/{modelGuid}/properties': parameters: - $ref: '#/components/parameters/source-design-urn' - name: modelGuid in: path required: true schema: type: string description: The ID of the Model View you are querying. Use the `List Model Views `_ operation to obtain the IDs of the Model Views in the source design. get: summary: Fetch All Properties tags: - Metadata responses: '200': description: All properties were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Properties' examples: all-properties: summary: This example demonstrates the successful retrieval of all properties of all objects (200). This example uses an Inventor model translated to SVF. value: data: type: properties collection: - objectid: 1 name: A5 externalId: mou0zG8ViUOsqUzhb4TUiA properties: Name: A5 - objectid: 2 name: Model externalId: z4u0zG8ViUOsqUzhb4TUiA properties: Component Name: Model Name: Model Design Tracking Properties: Design State: WorkInProgress Designer: ADSK File Subtype: Assembly File Properties: Author: ADSK Creation Date: 2012-Jul-09 20:18:20 Original System: Autodesk Inventor 2017 Part Number: Model Mass Properties: Area: 19772.676 millimeter^2 Volume: 83673.946 millimeter^3 - objectid: 4 name: Box externalId: 1Iu0zG8ViUOsqUzhb4TUiA properties: 'Center of Gravity:': '-13.452 mm, -9.879 mm, -40.735 mm' Name: Box headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' x-ads-size: $ref: '#/components/headers/x-ads-size' '202': description: The request was accepted but processing is not complete. Repeat the request until you receive an HTTP status of ``200``. content: application/json: schema: description: '' type: object properties: result: type: string minLength: 1 required: - result examples: accepted: summary: The request was accepted but processing is not complete (202). value: result: success '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '406': $ref: '#/components/responses/406-general' '409': $ref: '#/components/responses/409-general' '429': $ref: '#/components/responses/429-general' '500': $ref: '#/components/responses/500-general' operationId: getAllProperties description: |- Retrieves a list of properties of all objects in the Model View specified by the ``modelGuid`` URI parameter. This operation returns properties of all objects by default. However, you can restrict the results to a specific object by specifying its ID as the ``objectid`` query parameter. Properties are returned as a flat list, ordered by their ``objectid``. The ``objectid`` is a non-persistent ID assigned to an object when the source design is translated to the SVF or SVF2 format. This means that: - A design file must be translated to SVF or SVF2 before you can retrieve properties. - The ``objectid`` of an object can change if the design is translated to SVF or SVF2 again. If you require a persistent ID across translations, use ``externalId`` to reference objects instead of ``objectid``. Before you call this operation: - Use the `List Model Views `_ operation to obtain the list of Model Views (Viewables) in the source design. - Pick the ID of the Model View you want to query and specify that ID as the value for the ``modelGuid`` URI parameter. **Tip:** Use `Fetch Specific Properties `_ to retrieve only the objects and properties of interest. The response is paginated, so when the number of properties returned is large, responses start arriving more promptly. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/4f981e94-8241-4eaf-b08b-cd337c6b8b1f/properties" -X GET -H "Authorization: Bearer eyJh......"' parameters: - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/x-ads-force' - $ref: '#/components/parameters/x-ads-derivative-format' - $ref: '#/components/parameters/region' - schema: type: integer in: query name: objectid description: 'The Object ID of the object you want to restrict the response to. If you do not specify this parameter, all properties of all objects within the Model View are returned. ' - $ref: '#/components/parameters/forceget' '/modelderivative/v2/designdata/{urn}/metadata/{modelGuid}/properties:query': parameters: - $ref: '#/components/parameters/source-design-urn' - name: modelGuid in: path required: true schema: type: string description: The ID of the Model View you are querying. Use the `List Model Views `_ operation to obtain the IDs of the Model Views in the source design. post: summary: Fetch Specific Properties tags: - Metadata responses: '200': description: The requested properties were successfully retrieved. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' x-ads-size: $ref: '#/components/headers/x-ads-size' content: application/json: schema: $ref: '#/components/schemas/SpecificPropertiesPage' examples: specific-properties: summary: The requested properties were successfully retrieved (200). value: pagination: limit: 20 offset: 0 totalResults: 2 data: type: properties collection: - objectid: 438 name: 'Floor [418183]' externalId: d85573c2-f8d5-46ae-966a-ac82fa18f500-00066187 properties: Constraints: Level: Level 2 Height Offset From Level: 0.000 mm Room Bounding: 'Yes' Related to Mass: 'No' Construction: Structure: '' Default Thickness: 300.000 mm Function: Interior - objectid: 4269 name: Generic 150mm externalId: e3e052f9-0156-11d5-9301-0000863f27ad-00000153 properties: Construction: Structure: '' Default Thickness: 150.000 mm Function: Interior '202': description: The request was accepted but processing is not complete. Repeat the request until you receive an HTTP status of ``200``. '400': $ref: '#/components/responses/400-general' '403': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Diagnostic' '404': $ref: '#/components/responses/404-general' '429': $ref: '#/components/responses/429-general' '500': $ref: '#/components/responses/500-general' operationId: fetchSpecificProperties description: |- Queries the objects in the Model View (Viewable) specified by the ``modelGuid`` URI parameter and returns the specified properties in a paginated list. You can limit the number of objects to be queried by specifying a filter using the ``query`` attribute in the request body. **Note:** A design file must be translated to SVF or SVF2 before you can query object properties. Before you call this operation: - Use the `List Model Views `_ operation to obtain the list of Model Views in the source design. - Pick the ID of the Model View you want to query and specify that ID as the value for the ``modelGuid`` URI parameter. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query" -X POST -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json" --data ''{"query":{"$in":["objectid",4269,438]},"fields":["objectid","name","externalId","properties.Cons*"],"pagination":{"offset":0,"limit":20},"payload":"text"}''' parameters: - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/region' - $ref: '#/components/parameters/x-ads-derivative-format' requestBody: content: application/json: schema: $ref: '#/components/schemas/SpecificPropertiesPayload' examples: query-properties: summary: Queries specific properties for a set of objects. value: query: $in: - objectid - 4269 - 438 fields: - objectid - name - externalId - properties.Cons* pagination: offset: 0 limit: 20 payload: text '/modelderivative/v2/designdata/{urn}/thumbnail': parameters: - $ref: '#/components/parameters/source-design-urn' get: summary: Fetch Thumbnail tags: - Thumbnails responses: '200': description: The requested thumbnail was successfully retrieved. headers: x-ads-name: schema: type: string description: 'The thumbnail file name, expressed as an encoded string. The encoding method is indicated by the ``x-ads-name-encoding`` response header. If the value contains no %-encoded sequences, it is already the literal filename and decoding will leave it unchanged.' x-ads-name-encoding: schema: type: string enum: - url-encoded description: 'The encoding scheme used for the ``x-ads-name`` value. Use this header to determine how to decode the filename. Possible values: ``url-encoded`` - RFC 3986 percent-encoding (UTF-8). This header is included only when ``x-ads-name`` is present in the response.' x-ads-size: description: 'Thumbnail size. Possible values are: ``[100,100]``, ``[200,200]``, ``[400,400]``' schema: type: string x-ads-role: schema: $ref: '#/components/schemas/XAdsRole' x-ads-job-status: schema: $ref: '#/components/schemas/XAdsJobStatus' x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' content: image/png: schema: type: string format: binary description: The body response is a binary stream of the thumbnail. properties: {} '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: getThumbnail description: Retrieves a thumbnail of the specified source design. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/region' - $ref: '#/components/parameters/width' - $ref: '#/components/parameters/height' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/thumbnail" -X GET -H "Authorization: Bearer eyJh..."' '/modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}/signedcookies': parameters: - name: derivativeUrn in: path schema: type: string description: The URL-encoded URN of the derivative. Use the `Fetch Manifest operation `_ to obtain the URNs of derivatives for the specified source design. required: true - $ref: '#/components/parameters/source-design-urn' get: summary: Fetch Derivative Download URL tags: - Derivatives responses: '200': description: The download URL of the specified derivative was successfully retrieved. headers: Content-Type: schema: type: string description: application/octet-stream Content-Length: schema: type: string description: 'Denotes the size of the derivative, in bytes.' x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' Set-Cookie: schema: type: string description: Signed cookie to use with download URL. There will be three headers in the response named Set-Cookie content: application/json: schema: $ref: '#/components/schemas/DerivativeDownload' '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: getDerivativeUrl description: 'Retrieves a download URL and a set of signed cookies that let you securely download the derivative specified by the ``derivativeUrn`` URI parameter. The signed cookies have a lifetime of 6 hours. You can use range headers with the returned download URL to download the derivative in chunks, in parallel.' parameters: - schema: type: integer in: query name: minutes-expiration description: 'Specifies how many minutes the signed cookies should remain valid. Default value is 360 minutes. The value you specify must be lower than the default value for this parameter. If you specify a value greater than the default value, the Model Derivative service will return an error with an HTTP status code of ``400``.' - schema: type: string in: query name: response-content-disposition description: The value that must be specified as the ``response-content-disposition`` query string parameter with the download URL. Must begin with ``attachment``. This value defaults to the default value corresponding to the derivative/file. - $ref: '#/components/parameters/region' security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtMjIwNTIwL2JveC5pcHQ/manifest/urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtMjIwNTIwL2JveC5pcHQ/output/225ba6fd-8516-460d-bb34-8bc85c09a79d/box.obj/signedcookies" -X GET -H "Authorization: Bearer eyJh..."' '/modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}': parameters: - $ref: '#/components/parameters/source-design-urn' - name: derivativeUrn in: path schema: type: string description: The URL-encoded URN of the derivative. Check the manifest of the source design to get the URNs of the derivatives available for download. required: true head: summary: Check Derivative Details tags: - Derivatives responses: '200': description: Information about the specified derivative was successfully retrieved. headers: Content-Type: schema: type: string description: application/octet-stream Content-Length: schema: type: string description: 'Denotes the size of the specified derivative, in bytes.' x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-troubleshooting: $ref: '#/components/headers/x-ads-troubleshooting' '202': description: The request was accepted but processing is not complete. Repeat the request until you receive an HTTP status of ``200``. '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: headCheckDerivative description: |- Retrieves information about the specified derivative. Use this operation to determine the total content length of a derivative before you download it. If the derivative is large, you can choose to download the derivative in chunks, by specifying a chunk size using the ``Range`` header parameter. parameters: - $ref: '#/components/parameters/region' security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest/urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf" -X HEAD -H "Authorization: Bearer eyJh..."' '/modelderivative/v2/designdata/{urn}/manifest': parameters: - $ref: '#/components/parameters/source-design-urn' get: summary: Fetch Manifest tags: - Manifest responses: '200': description: The manifest was successfully retrieved. headers: x-ads-app-identifier: schema: type: string x-ads-startup-time: schema: type: string x-ads-duration: schema: type: string x-ads-troubleshooting: schema: type: string content: application/json: schema: $ref: '#/components/schemas/Manifest' examples: manifest: summary: This example demonstrates the successful retrieval of the manifest of a source design (200). value: urn: dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0 derivatives: - hasThumbnail: 'true' children: - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/model.sdb' role: Autodesk.CloudPlatform.PropertyDatabase mime: application/autodesk-db guid: 6fac95cb-af5d-3e4f-b943-8a7f55847ff1 type: resource status: success - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/AECModelData.json' role: Autodesk.AEC.ModelData mime: application/json guid: a4aac952-a3f4-031c-4113-b2d9ac2d0de6 type: resource status: success - phaseNames: New Construction role: 3d hasThumbnail: 'true' children: - guid: 92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0 type: view role: 3d name: 3D status: success progress: complete camera: - 63.460731506347656 - -69.05099487304688 - 85.06072235107422 - -12.099991798400879 - 6.50972843170166 - 9.5 - -0.40824830532073975 - 0.40824830532073975 - 0.8164966106414795 - 1.3879648447036743 - 0 - 1 - 1 - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D1.png' role: thumbnail mime: image/png guid: c70aa596-d404-714f-6795-9276087c3800 type: resource resolution: - 100 - 100 status: success - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D2.png' role: thumbnail mime: image/png guid: 6ef65d1a-4a59-111d-f1ec-4e543bd2712b type: resource resolution: - 200 - 200 status: success - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D4.png' role: thumbnail mime: image/png guid: 2c06739e-5164-4f6d-450e-c8833fd2a2ba type: resource resolution: - 400 - 400 status: success - role: graphics mime: application/autodesk-svf2 guid: 1821b502-b91e-f9f2-56e9-2d7cb4b0f4a3 type: resource name: 3D guid: 02efa4e8-11ec-5b90-1c0b-4775bad24b58 progress: complete type: geometry viewableID: 92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0 status: success name: Link Arc_2018.rvt progress: complete outputType: svf2 status: success - children: - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview1.png' role: thumbnail mime: image/png guid: db899ab5-939f-e250-d79d-2d1637ce4565 type: resource resolution: - 100 - 100 status: success - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview2.png' role: thumbnail mime: image/png guid: 3f6c118d-f551-7bf0-03c9-8548d26c9772 type: resource resolution: - 200 - 200 status: success - urn: 'urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview4.png' role: thumbnail mime: image/png guid: 4e751806-0920-ce32-e9fd-47c3cec21536 type: resource resolution: - 400 - 400 status: success progress: complete outputType: thumbnail status: success hasThumbnail: 'true' progress: complete type: manifest region: US version: '1.0' status: success '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: getManifest description: |- Retrieves the manifest of the specified source design. The manifest is a JSON file containing information about all the derivatives translated from the specified source design, including the URNs of the derivatives, the translation status of each derivative, and other details. The first time you translate a source design, the Model Derivative service creates a manifest for that design. Thereafter, every time you translate that source design, even to a different format, the Model Derivative service updates the same manifest rather than creating a new one. The manifest acts as a central registry for all the derivatives of your source design created through the Model Derivative service. When the Model Derivative service starts a translation job (as a result of a request you make using `Create Translation Job `_), it updates the manifest at regular intervals. You can use the manifest to check the status and progress of each derivative being generated. When multiple derivatives have been requested, each may complete at a different time. Each derivative has its own ``status`` attribute. The manifest also contains an overall ``status`` attribute. The overall ``status`` becomes ``complete`` when the ``status`` of all individual derivatives become complete. Once the translation status of a derivative is ``complete``, you can download the derivative. **Note:** You cannot download 3D SVF2 derivatives. security: - 2-legged: - 'data:read' - 'viewable:read' - 3-legged: - 'data:read' - 'viewable:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest" -X GET -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json"' parameters: - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/region' delete: summary: Delete Manifest tags: - Manifest responses: '200': description: The manifest was successfully deleted. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' content: application/json: schema: $ref: '#/components/schemas/DeleteManifest' '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '500': $ref: '#/components/responses/500-general' operationId: deleteManifest description: | Deletes the manifest of the specified source design. It also deletes all derivatives (translated output files) generated from the source design. However, it does not delete the source design. **Note:** This operation is idempotent. If you call it multiple times, even when no manifest exists, it will still return a successful response (200). security: - 2-legged: - 'data:write' - 'data:read' - 3-legged: - 'data:write' - 'data:read' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest" -X DELETE -H "Authorization: Bearer eyJh..."' parameters: - $ref: '#/components/parameters/region' /modelderivative/v2/designdata/job: post: summary: Create Translation Job tags: - Jobs responses: '200': description: The translation job was successfully created and started. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' x-ads-duration: $ref: '#/components/headers/x-ads-duration' content: application/json: schema: $ref: '#/components/schemas/Job' '201': description: 'The requested derivative already exists, so a new derivative will not be generated.' '400': description: The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. content: application/json: schema: $ref: '#/components/schemas/Diagnostic' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '406': description: 'The request contains values that are not acceptable. For example, the output type you requested may not be supported. Please check your request parameters and modify them to contain only supported values.' content: application/json: schema: $ref: '#/components/schemas/Diagnostic' '409': $ref: '#/components/responses/409-general' '429': $ref: '#/components/responses/429-general' '500': $ref: '#/components/responses/500-general' operationId: startJob description: |- Creates a job to translate the specified source design to another format, generating derivatives of the source design. You can optionally: - Extract selected parts of a design and export the set of geometries in OBJ format. - Generate different-sized thumbnails. When the translation job runs, details about the process and generated derivatives are logged to a JSON file known as a manifest. This manifest is typically created during the first translation of a source design. Subsequently, the system updates the same manifest whenever a translation is performed for that design. If necessary, you can set the ``x-ads-force`` header to ``true``. The system will then delete the existing manifest and create a new one. However, be aware that doing so will also delete all previously generated derivatives. security: - 2-legged: - 'data:read' - 'data:write' - 'data:create' - 3-legged: - 'data:read' - 'data:write' - 'data:create' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/job" -X POST -H "Content-Type: application/json" -H "Authorization: Bearer eyJh..." --data ''{"input":{"urn":"dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtYnVja2V0LTI1MDUwMi9ib3guaXB0"},"output":{"destination":{"region":"EMEA"},"formats":[{"type":"svf2","views":["2d","3d"]}]}}''' parameters: - $ref: '#/components/parameters/x-ads-force-job' - $ref: '#/components/parameters/x-ads-derivative-format' - $ref: '#/components/parameters/region' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobPayload' parameters: [] '/modelderivative/v2/designdata/{urn}/references': post: summary: Specify References tags: - Jobs responses: '200': description: The locations of referenced files were successfully recorded. headers: x-ads-app-identifier: $ref: '#/components/headers/x-ads-app-identifier' x-ads-duration: $ref: '#/components/headers/x-ads-duration' x-ads-startup-time: $ref: '#/components/headers/x-ads-startup-time' content: application/json: schema: $ref: '#/components/schemas/SpecifyReferences' '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '406': description: 'The request contains unacceptable references. For example, one or more referenced files may be stored in a different region than the source design. Please verify that all referenced resources are in the same region and adjust your request accordingly.' content: application/json: schema: $ref: '#/components/schemas/Diagnostic' '500': $ref: '#/components/responses/500-general' operationId: specifyReferences description: | Specifies the location of the files referenced by the specified source design. When you call `Create Translation Job `_, set ``checkReferences`` to ``true``. The Model Derivative service will then use the details you specify in this operation to locate and download the referenced files. security: - 2-legged: - 'data:read' - 'data:write' - 'data:create' - 3-legged: - 'data:read' - 'data:write' - 'data:create' x-codeSamples: - lang: cURL source: 'curl -v "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6anAtYnVja2V0LTI1MDUwMi9zY2lzc29ycy5pYW0=/references" -X POST -H "Authorization: Bearer eyJh..." -H "Content-Type: application/json" --data ''{"urn":"urn:adsk.objects:os.object:jp-bucket-250502/scissors.iam","filename":"scissors.iam","references":[{"urn":"urn:adsk.objects:os.object:jp-bucket-250502/blade_main.ipt","relativePath":"Components/blade_main.ipt","filename":"blade_main.ipt"},{"urn":"urn:adsk.objects:os.object:jp-bucket-250502/blade_top.ipt","relativePath":"Components/blade_top.ipt","filename":"blade_top.ipt"},{"urn":"urn:adsk.objects:os.object:jp-bucket-250502/scissor_spring.ipt","relativePath":"Components/scissor_spring.ipt","filename":"scissor_spring.ipt"}]}''' parameters: - $ref: '#/components/parameters/region' requestBody: content: application/json: schema: $ref: '#/components/schemas/SpecifyReferencesPayload' parameters: - name: urn in: path required: true schema: type: string description: The Base64 (URL Safe) encoded design URN.