Request

Response

    Task 1 - Create a Product

    A product is the starting point of the informed design workflow.


    Key learnings

    By the end of this task, you will be able to:

    • Create a Product
    • Retrieve the created Product

    The operations used in this task are as follows:

    OperationHTTP RequestDescription
    Create a Product POST /products Creates a Product.
    Get a Single Product GET /product/{productId} Returns the details of a single product.

    Step 1: Create a Product

    The Informed Design workflow begins with creating a Product. A Product contains metadata such as its name, authoring application, and current state.

    To create a Product, you will need the Project ID and Folder URN from the project and folder you set up in the Before You Begin guide.

    Request

    curl -X POST \
        'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products?accessType=<ACCESS_TYPE>&accessId=<PROJECT_ID>|<FOLDER_URN>' \
        -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
        -H 'Content-Type: application/json' \
        -d '{
                "name": "IND Tutorial Product",
                "authoringApp": "INVENTOR",
                "state": "AVAILABLE"
            }'
    
    Show More

    Notes: - You must specify a name and an authoringApp for your product


    Response

    Returns a JSON response with status 201

    {
        "accessType": "{{ACCESS_TYPE}}",
        "accessId": "{{ACCESS_ID}}",
        "id": "{{PRODUCT_ID}}",
        "name": "IND Tutorial Product",
        "authoringApp": "INVENTOR",
        "defaultRelease": null,
        "releaseCount": 0,
        "state": "AVAILABLE",
        "isPublic": false,
        "createdAt": "2025-04-16T11:56:50.981Z",
        "updatedAt": "2025-04-16T11:56:50.981Z"
    }
    
    Show More

    Step 2: Retrieve the Product

    Using the id of the product in the response, you can retrieve the product details.


    Request

    curl -L -X GET \
    'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/430b9af7-f4cf-4c6d-a6ca-036b885dd8f2?accessType=<ACCESS_TYPE>&accessId=<PROJECT_ID>|<FOLDER_URN>' \
    -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
    

    Response

    Returns a JSON response with status 200 if found

    {
        "accessType": "ACC",
        "accessId": "{{ACCESS_ID}}",
        "id": "{{PRODUCT_ID}}",
        "name": "IND Tutorial Product",
        "authoringApp": "INVENTOR",
        "defaultRelease": null,
        "releaseCount": 0,
        "state": "AVAILABLE",
        "isPublic": false,
        "tags": [],
        "createdAt": "2025-04-16T11:56:50.981Z",
        "updatedAt": "2025-04-16T12:04:11.587Z"
    }
    
    Show More