Material status - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help

This API retrieves the material status of the given Tag number or Drawing number from Smart Materials.

API retrieves all the Bill of Materials (BOM) Positions (LpId) of the given Drawing number or Tag number from the latest Forecast run.
If both Drawing number and Tag number is passed, then the status of the Tag number associated with the given Drawing number is retrieved.
If a Forecast run is not available for a ListPostion, then values are retrieved only for LpId, DrawingNumber, and BOMPath properties.

Required Privilege: API_GET_FORECAST_RESULTS

Headers

Header Name	Description	Required	Values
Authorization	Access token	Required	Bearer <access_token>
Content-Type	Request type format	Required	application/JSON

Body

URL Format: POST https://localhost:53215/smat/v1/Projects(':project')/Com.Ingr.Smat.V1.MaterialStatus/

Specify value for the project in the URL. In the body, provide the TimePeriod and BOMNodes details.

Element	Description	Type	Required	Notes
TimePeriod	Represents the time that the application considers and check for the latest Forecast/Reservation Run. Time is in days.	Integer	Optional	Maximum allowed time is 365 days prior to current date. Default value is 180 days.
BOMNodes	Collection of three parameters; DrawingNumber, TagNumber, and FahCode	Collection	Required
DrawingNumber	Name of the BOM node If given DrawingNumber is root node, then all the BOM positions starting from root node to leaf node are retrieved.	String	Required	Either DrawingNumber or TagNumber is mandatory.
TagNumber	Tag number of the material	String	Required	Either DrawingNumber or TagNumber is mandatory.
FahCode	Refers to Forecast/Reservation code in Smart Material	String	Optional	If FahCode is passed, then the material status of the latest Forecast/Reservation code is retrieved, and TimePeriod is ignored.

Sample Code

POST https://localhost:53215/smat/v1/Projects('DEMO')/Com.Ingr.Smat.V1.MaterialStatus/

{

"filterMatStatus":

{

"TimePeriod":360,

"BOMNodes": [

{

"DrawingNumber": "PB_DEMO1"

}

]

}

Success Response
Status: 200 OK

{

"@odata.context": "http://localhost:53427/SMAT/V1/$metadata#Collection(Com.Ingr.Smat.V1.MaterialStatusResult)",

"value": [

{

"LpId": 22320,

"DrawingNumber": "PB_DEMO1",

"FahId": 7525,

"FahType": "Forecast Run",

"ListPosition": "1",

"ListPositionStatus": "Complete",

"StatId": 5186,

"CommodityCode": "GSWAB6DFFAA7ZZZ",

"CommodityCodeShortDesc": " Sp. Wound Gskt , ASME B16.20 , CL 150 , FF , 304-W, mica/graph-F, CS-CR, 304-IR ",

"Size1": ".5",

"Size2": "4.5",

"Size3": "0",

"Size4": "0",

"ShortCode": null,

"IdentCode": "I2544336",

"IdentDesc": ".5 x 4.5 Sp. Wound Gskt, ASME B16.20, CL 150, FF , 304-W, mica/graph-F, CS-CR, 304-IR",

"TagNumber": null,

"BOMPath": "/PB_DEMO1",

"SplitTagIndicator": "N",

"DetailTagsBOMPath": null,

"BOMQty": 100,

"OutstandingQty": 67,

"TotalIssuedQty": 33,

"ListPosResvQty": 0,

"ForecastShortQty": -33,

"TotalResvQty": 100,

"TotalManResvQty": 0,

"ActualResvQty": 100,

"SubTransStatus": null,

"IsSubst": "N",

"IsTrans": "N",

"SubResvQty": null,

"UnitId": 5297,

"UnitCode": "pc",

"TotalOnHandQty": 189,

"TotalAllocatedQty": 100,

"ForecastResults": [

{

"WhId": 5253,

"WhCode": "PB_WH2_IS",

"LocId": 5000,

"LocCode": "A1",

"RecvStatus": "ACCEPTED",

"IdentCode": "I2544336",

"CommodityCode": "GSWAB6DFFAA7ZZZ",

"IviId": 5862,

"SubstInd": "N",

"TransInd": "N",

"ReceivedQty": 200,

"TotalResvQty": 0,

"ActualResvQty": 100,

"ManResvQty": 0,

"IssuedQty": 11,

"OnHandQty": 189,

"AllocatedQty": 100,

"AllocationType": "Inventory",

"ETADate": null,

"PromOnSiteDate": null,

"ROSDate": null

}

"MIRDetails": [

{

"MIRNumber": "PB_MIRDEMO",

"MIRType": "MIR By BOM Commodity",

"IssuedQty": 20,

"MirId": 5760,

"IviId": 5886,

"IisId": 6261,

"RevisionId": 1,

"PostedDate": null

{

"MIRNumber": "PB_MIRDEMO",

"MIRType": "MIR By BOM Commodity",

"IssuedQty": 11,

"MirId": 5626,

"IviId": 5862,

"IisId": 6023,

"RevisionId": 0,

"PostedDate": "2020-12-14T14:04:05+05:30"

}

"ListPositionAttrs": [

{

"AttributeId": 5426,

"AttributeCode": "REQ_NO",

"AttributeValue": null

{

"AttributeId": 5428,

"AttributeCode": "INS_TYPE",

"AttributeValue": null

}

]

}

]

}

Element	Description	Type
FahId	Unique ID of the given Forecast /Reservation header	Integer
LpId	Unique ID of the list position Represents BOM positions.	Integer
ListPosition	Unique position of the structure-element	String
CommodityCode	Name or code of the commodity	String
CommodityCodeShortDesc	Short description of the commodity code	String
Size (1-4)	Commodity size Four different values are allowed.	String
IdentCode	Represents BOM ident code/name or ident assigned to a list position.	String
BOMQty	Quantity of the BOM position	Integer
BOMPath	Path description starting from the root node till the given list node (drawing number).	String
TotalIssuedQty	Total issued quantity of the BOM position	Decimal
UnitId	Unique ID of the unit	Integer
UnitCode	Represents quantity unit	String
ForecastShortQty	Represents the difference between the outstanding quantity and the quantity that could be allocated by the Forecast Run for the given list position.	Decimal
TotalAllocatedQty	Represents the sum of actual, manual reserved, and substitution/transformation quantity at the list position/BOM position level.	Decimal
TotalOnHandQty	Total on hand quantity for this BOM position	Decimal
ListPosResQty	Represents the sum of the reserved quantity of all the Reservation Runs for this position. In Smart Materials, this refers to List Pos Resv Qty.	Decimal
SplitTagIndicator	Indicates whether the tag item is splitted or not. For example, tag item can be splitted in PO,item shipments, and so on.	String
DetailTagsBOMPath	BOM path of the detail tags. It represents the new BOM path of the detail tags created during a forecast run when any tag item gets split in PO , item shipments and so on. If SplitTagIndicator is N, then DetailTagsBOMPath will be null.	String
FahType	Specifies type of Run. Run can be a Forecast Run or Reservation Run.	String
StatId	Unique ID of the associated issue status	Integer
ShortCode	Specifies the short code	String
ListPositionStatus	Status of the list position. Available options are: Complete: Given position is completely forecasted/reserved Partly: Given position is partly forecasted/reserved None: Nothing has been forecasted/reserved by this forecast or reservation run.	String
IdentDesc	Description of the BOM ident	String
OutstandingQty	Represents the quantity that is not issued or reserved against a list position.	Decimal
TotalResvQty	Represents the sum of TotalManResvQty and ActualResvQty	Decimal
ActualResvQty	Represents the quantity reserved/forecasted by a Forecast/Reservation run and is calculated at BOM position level.	Decimal
TotalManResvQty	Represents the total manual reserved quantity of list position.	Decimal
IsTrans	Indicates transformation. If value is Y, then the transformed ident(s) are available for the BOM position in this Forecast/Reservation run	String
IsSubst	Indicates substitution. If value is Y, then the substituted ident(s) are available for the BOM position in this Forecast/Reservation run	String
SubResvQty	Represents quantity of substituted/transformed ident code that is to be reserved. This quantity gets reserved only if substitution/transformation is approved in reservation run and ListPosResvQty gets updated.	Decimal
SubTransStatus	Status of the completion by substitute/transformation. Available options are: Done Complete Done Partly Possible Complete Possible Partly Not available.	String

Forecast Results (ForecastResults)

Element	Description	Type
ETADate	Expected time of arrival of the material. It refers to PredOnSite Date in Smart Materials.	Date time Offset
ROSDate	Date and time when the material is Required on Site	Date time Offset
OnHandQty	On-hand quantity of this inventory item in the displayed warehouse location.	Decimal
AllocatedQty	Quantity that is forecasted by this job. This quantity is reserved for a Reservation job. In Smart Materials, this refers to the sum of Actual ResvQty and Manual Resv Qty.	Decimal
WhId	Unique ID of the associated warehouse	Integer
WhCode	Name of the associated warehouse	String
LocId	Unique ID of the location	Integer
LocCode	Name of the location	String
AllocationType	Defines the level where the material is allocated. Available values are: Purchase Order (PO) Item Shipments (ISH) Requisition Traffic Inventory (IVI). ETADate, ROSDate, and PromOnSiteDate are not applicable (shows null value) for inventory level items.	String
PromOnSiteDate	Promised on Site date	Date Time Offset
RecvStatus	Status of the received material in site	String
IdentCode	Unique code or name of the ident. This represents BOM ident if SubsInd and TransInd are set to N. Represents substituted ident, if SubstInd is set to Y and transformed ident if is set to Y for this item.	String
CommodityCode	Unique code or name of the commodity	String
IviId	Unique ID of the inventory item	Decimal
SubstInd	Indicates whether the ident is a substitute ident or not. Available values are Y and N.	String
TransInd	Indicates whether the ident is a transformation ident or not. Available values are Y and N.	String
ReceivedQty	Quantity received on site for this inventory item	Decimal
TotalResvQty	Quantity reserved for the inventory or shipment item by a specific forecast or reservation run. This also includes the quantity assigned to unposted MIR if "Exclude MIR Qty's" is set to Y in forecast/reservation run. However, this excludes the substituted/transformed reserved quantity.	Decimal
ActualResvQty	Represents the quantity that is either forecasted by a forecast run or reserved by the Reservation run at inventory/itemshipment level.	Decimal
ManResvQty	Manually reserved quantity against the inventory item related to forecast/reservation run.	Decimal
IssuedQty	Issued quantity of the inventory item	Decimal

Material Issuing Report (MIR) details

MIR details is a collection and consist of all the MIRs of the corresponding BOM position.

Element	Description	Type
MIRNumber	Name of the MIR	String
MIRType	Type of MIR. Available options are: MIR by BOM Commodity MIR by BOM Ident MIR by Reservation MIR for plates (BOM Issue) MIR for plates (Reservation Issue).	String
IssuedQty	Issued quantity of the list position associated with the given MIR	Decimal
MirId	Unique ID of the retrieved Material Issue Report	Integer64
IviId	Unique ID of the retrieved inventory item	Decimal
IisId	Unique ID of the inventory issue	Integer64
RevisionId	Unique revision ID of the MIR. Default value is 0.	Integer16
PostedDate	Date when the MIR was posted in the inventory	Date Time Offset

List Position Attributes (ListPositionAttrs)

Element	Description	Type
AttributeId	Unique ID of the attribute	Decimal
AttributeCode	Unique code of the list position attribute	String
AttributeValue	Value of the list position attribute	String

Material status - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)