Request

Response

    Retrieve Bill of Materials for a Product
    GET

    products/{productId}/bill-of-materials-items

    Retrieves the first level of the bill of materials (BOM) associated with the specified product.

    Resource Information

    Method and URI
    GET
    https://api.aps.autodesk.com/fusion-operations/v2/products/{productId}/bill-of-materials-items
    Authentication Context
    No security required
    Required OAuth Scopes
    data:read data:write
    Data Format
    JSON

    Request

    URI Parameters

    productId
    int
    The unique identifier of the Product.

    Request

    Query String Parameters

    filter[id]
    int
    Filter Bill of Materials Items matching the specified id.
    limit
    int
    Maximum number of results returned. Defaults to 25.
    offset
    int
    Page offset. Default value is 0.
    sort
    string
    Comma separated fields to sort items by. Fields: id, code. Default: “id asc”.

    Response

    HTTP Status Code Summary

    200
    OK
    Bill of Materials for the specified product
    400
    Bad Request
    Bad request due to invalid data.
    401
    Unauthorized
    The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request.
    403
    Forbidden
    The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request.
    404
    Not Found
    The resource in the path does not exist.
    429
    Too Many Requests
    Rate limit exceeded; wait some time before retrying.
    500
    Internal Server Error
    An unknown server-side error occurred. Please try again later. If the problem persists, please contact support.

    Response

    Header (429)

    Retry-After
    integer
    The number of seconds to wait before retrying the request.

    Response

    Body Structure (200)

    Expand all
    results
    array: object
    List of Bill of Materials items
    id
    int
    The unique identifier of the Bill of Materials Item to retrieve.
    product
    id
    int
    Unique identifier of the referenced entity.
    code
    string
    Code of the referenced entity.

    Max length: 255

    name
    string
    Name of the referenced entity.

    Max length: 255

    anyOf
    0
    1
    operation
    The operation where the material is used. The operation must belong to the product.
    id
    int
    Unique identifier of the referenced entity.
    code
    string
    Code of the referenced entity.

    Max length: 255

    name
    string
    Name of the referenced entity.

    Max length: 255

    anyOf
    The operation where the material is used. The operation must belong to the product.
    0
    1
    quantity
    number
    fixedQuantity
    boolean
    Indicates if the consumption is fixed, regardless of produced quantity. The default value is false.
    pagination
    object
    limit
    int
    Maximum number of results returned in this page.
    offset
    int
    Number of results skipped before this page.
    nextUrl
    string
    URL for the next page of results. Null when there are no additional pages.

    Example

    Bill of Materials for the specified product

    Request

    curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/products/:productId/bill-of-materials-items' \
      -H 'Authorization: '
    

    Response

    {
      "results": [
        {
          "id": 745,
          "product": {
            "id": 435,
            "code": "Consumed product 1",
            "name": "Consumed product 1"
          },
          "operation": {
            "id": 44,
            "code": "Operation of XPTO product",
            "name": "Operation of XPTO product"
          },
          "quantity": 52.6,
          "fixedQuantity": false
        },
        {
          "id": 749,
          "product": {
            "id": 439,
            "code": "Consumed product 4",
            "name": "Consumed product 4"
          },
          "operation": {
            "id": 44,
            "code": "Operation of XPTO product",
            "name": "Operation of XPTO product"
          },
          "quantity": 5,
          "fixedQuantity": false
        }
      ],
      "pagination": {
        "$ref": "#/components/schemas/PaginationResponse"
      }
    }
    
    Show More