BomVersion_Get (Get)
- Last UpdatedNov 06, 2025
- 2 minute read
| Get | BomVersion_Get |
Resource Path:/api/BomVersion
| Name | Description | Data Type |
|---|---|---|
| itemId | The item ID. If an ID is not provided, information about BOM versions for all items is returned. | string |
The response body is of type object.
Returns a JSON array that includes the information about all BOM versions or the BOM versions for the specified item. If no matching BOM versions are found, an empty JSON array is returned.
The following properties are returned.
parent_item_id (string)
The ID of an item being made.
ver_id (string)
The BOM version ID.
ver_date (string)
The date when the BOM version was created or last updated.
ver_comments (string)
The comments about a BOM version.
preferred_ver (Boolean)
The indication whether this is the preferred BOM version to make the parent item.
item_desc (string)
The item description.
disassembly (string)
The indication whether the BOM determines what can be obtained from the main item.
start_eff (datetime)
The date and time when the BOM version becomes effective, in UTC.
end_eff (datetime)
The date and time when the BOM version becomes ineffective, in UTC.
last_edit_comment (string)
The comments about why the record was added or updated.
last_edit_by (string)
The ID of the user who added or last updated this record.
last_edit_at (datetime)
The date and time when the record was added or last updated.
mod_id (timestamp)
A binary number that increments each time the record's table row is modified.
To get information about all BOM versions:
api\BomVersion
To get BOM version information about the item whose ID is RoastedCashews:
api\BomVersion?itemId=RoastedCashews
Examples: Work Tasks Lookups
To get information about all BOM versions:
api\BomVersion
To get BOM version information about a specific item:
api\BomVersion?itemId={itemId}