Request

Response

    List Model Views
    GET

    {urn}/metadata

    Returns a list of Model Views (Viewables) in the source design specified by the urn URI parameter. It also returns the IDs that uniquely identify the Model Views. You can use these IDs with other metadata operations to obtain information about the objects within those Model Views.

    Design applications like Fusion 360 and Inventor contain only one Model View per design. Applications like Revit can contain multiple Model Views per design.

    Note You can retrieve metadata only from a design that has been translated to SVF or SVF2.

    Resource Information
    Method and URI
    GET
     https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/metadata
    Method and URI (EMEA)
    GET
     https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/metadata
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers
    Authorization*
    string
    		Must be Bearer <token>, where <token> is obtained via POST /authentication/v2/token.
    Accept-Encoding
    string
    		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.
    region
    enum: string
    		Specifies the data center where the manifest and derivative of the specified source design are stored in. Possible values are:
    • US : (Default) Data center for the US region.
    • EMEA : Data center for the European Union, Middle East, and Africa regions.
    • AUS : (Beta) Data centre for the Australia region.

    Note:

    • Beta features are subject to change. Please avoid using them in production environments.
    • The Model Derivative service ignores this parameter if you use the EMEA URI for this operation.
    * Required

    Request

    URI Parameters
    urn
    string
    		The URL safe Base64 encoded URN of the source design.

    Response

    HTTP Status Code Summary
    200
    OK
    		Success.
    400
    BAD REQUEST
    		Invalid request. E.g. input URN format is invalid.
    401
    UNAUTHORIZED
    		Invalid authorization header.
    403
    FORBIDDEN
    		Access denied regardless of authorization status.
    404
    NOT FOUND
    		Endpoint does not exist.
    500
    INTERNAL SERVICE ERROR
    		Unexpected service interruption

    Response

    HTTP Headers
    x-ads-app-identifier
    string
    		The service identifier comprise service name, version and environment.
    x-ads-startup-time
    string
    		The service startup time with data format EEE MMM dd HH:mm:ss Z yyyy.
    x-ads-duration
    string
    		The request duration in milliseconds.
    x-ads-troubleshooting
    string
    		Provides information about the server failure.

    Response

    Body Structure (200)
    Expand all
    data
    object
    		An envelope that contains the return data.
    type
    string
    		The type of data that is returned.
    metadata
    array:object
    		An array of objects, where each object represents a Model View.
    name
    string
    		Name of the Model View.
    guid
    string
    		Unique ID for the Model View.
    role
    string
    Type of Model View.
    Possible values: 2d, 3d
    isMasterView
    bool
    • true: Model View is a Master View derived from a Revit file.
    • false: Model View is not a Master View.

    Example

    Success. Retrieves a list of Model Views and their IDs (200).

    Request

    curl -X 'GET' \
     -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
     -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata'

    Response

    Status Code: 200 OK
Last-Modified: Fri. 13 May 2016 08:49:06 GMT
x-ads-app-identifier=platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-startup-time: Fri May 13 08:49:06 UTC 2016
x-ads-duration: 3 ms
{
    "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"
            }
        ]
    }
}
    Show More