This API retrieves all the list positions and the corresponding list nodes of a given ident from a project in Smart Materials.
Required Privilege: API_ITEM_DETAILS
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
HTTP Method: GET
URL Format:
https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Idents({ident})/BOMTotalDetails
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language, together define the project environment. The key parameter defines the ident.
Sample Code
Get http://localhost:57464/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/Idents(7500531)/BOMTotalDetails
Success Response
Status: 200OK
{
"@odata.context": "http://localhost:57464/SMAT/V1/$metadata#ListPositions",
"value": [
{
"LpId": 10000087244,
"LnId": 10000048897,
"StatId": 10000008503,
"ProjId": "RS",
"LstId": 10000012293,
"DpId": 5020,
"ListPosition": "10",
"Quantity": 250,
"RequisitionInd": "Y",
"LoadInd": "Y",
"ParentLpId": null,
"CommodityId": 4500832,
"PartId": 502631,
"UnitId": 500127,
"Ident": 7500531,
"ShortCode": null,
"ItyId": 500018,
"ListSubPosition": null,
"Input1": null,
"Input2": null,
"Input3": null,
"Input4": null,
"Input5": "0",
"ResvQty": 0,
"TagNumber": null,
"GroupId": 500378,
"IssueQty": 0,
"ManResvQty": 0,
"Weight": null,
"WeightUnitId": null,
"PlateId": null,
"LockInd": "N"
}
You can retrieve the list node details using List Node read API
(GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Listnodes({key}).
|
Element |
Description |
Type |
|---|---|---|
|
LpId |
Unique ID of the retrieved list position |
Integer |
|
LnId |
Unique ID of the list node to which the given list position belongs |
Integer |
|
StatId |
Unique ID of the associated issue status |
Integer |
|
ProjId |
Unique ID of the project to which the list positions belong |
String |
|
LstId |
Unique ID of the list status |
Integer |
|
DpId |
Unique ID of the discipline to which the list positions belong |
Integer |
|
ListPosition |
Unique position with this structure-element |
String |
|
Quantity |
Ident - quantity of the list position |
Decimal |
|
RequisitionInd |
Indicates whether the quantity of the list position is included in MTO or not. |
String |
|
LoadInd |
Indicates whether the open MTO interface can update the corresponding record or not.
|
String |
|
ParentLpId |
Unique ID of the parent list position |
Integer |
|
CommodityId |
Unique ID of the commodity code |
Integer |
|
PartId |
Unique ID of the commodity part |
Integer |
|
UnitId |
Unique ID of the unit |
Integer |
|
Ident |
Ident number |
Integer |
|
ShortCode |
Specifies the short code of the commodity |
String |
|
ItyId |
Unique ID of the item type |
Integer |
|
ListSubPosition |
Sub positions of the list position |
String |
|
Input (1-5) |
Value for size 1 to 5 |
String |
|
ResvQty |
Reserved quantity set by the Reservation Run |
Decimal |
|
TagNumber |
Tag number of the ident |
String |
|
GroupId |
Unique ID of the commodity group |
Integer |
|
IssueQty |
Issued quantity of the ident |
Decimal |
|
ManResvQty |
Quantity that is reserved manually |
Decimal |
|
Weight |
Specifies weight for position of current node |
Decimal |
|
WeightUnitId |
Specifies unit of weight for position of current node |
Integer |
|
PlateId |
Unique ID of the plate |
Integer |
|
LockInd |
Available values are Y and N.
|
String |