Read an inventory issue details - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help

This API retrieves the inventory issues of a Material Issue Report (MIR) from Smart Materials. You can either retrieve a single inventory issue using inventory issue ID or all the inventory issues of a MIR.

Required Privilege: API_READONLY

Headers

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

Body

URL Format: GET https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/IssueReports({key1})/InvIssues({key2})

Specify the values for project, discipline, language, and key parameters in the URL to define the project environment. The parameter key1 defines the Material Issue Report ID (MirId) and parameter key2 defines the inventory issue ID (IisId).

To retrieve all the inventory issues of a MIR, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/IssueReports({key1}/InvIssues

Sample Code

GET https://{host}/smat/v1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/IssueReports(5046)/InvIssues(5265)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "http://localhost:53427/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/IssueReports(5046)/InvIssues/$entity",

"ProjId": "RS",

"DpId": 5020,

"IisId": 5265,

"IviId": 5141,

"MirId": 5046,

"IvprId": null,

"BomPath": "0PIPING1/000_DST/A001",

"LpId": 2873997,

"IssueQty": 10,

"Ident": 38187638,

"ListPosQty": 5,

"ListPosIssueQty": 1,

"QtyChanged": "N",

"OverissueQty": 0,

"OnHandQty": 111,

"DCIQty": 0,

"RevWithDC": "N",

"DCIOnHandQty": 0,

"LnId": 196724,

"IssueDate": "2006-05-17T00:00:00+05:30",

"WhId": 5082,

"LocId": 5081,

"SmstId": 5040,

"MLDProcessing": "N",

"MLDRegisterQty": 0,

"TotalOIQty": 0,

"OIOnHandQty": 0,

"SumOIQty": 0,

"UsedOIQty": 0,

"RevOverissueQty": 0,

"UnitId": 500127,

"TagNumber": null,

"TotalRecvQty": 104,

"ListPosResvQty": 0,

"CommodityId": 4526369,

"Size1": ".375",

"Size2": "0",

"Size3": "0",

"Size4": "0",

"Size5": "0",

"HeatId": null,

"ItemShipId": null,

"ResvQty": 0,

"SubstInd":"N"

"OriginalIdent": null

}

Element	Description	Type
ProjId	Unique ID of the Project. Retrieved inventory issue belongs to the MIR related to this project.	String
DpId	Unique ID of the Discipline. Retrieved inventory issue belong to the MIR related to this discipline.	Integer64
IisId	Unique ID of the retrieved inventory issue	Integer64
IviId	Unique ID of the inventory items related to the current inventory issue	Integer64
MirId	Unique ID of the Material Issue Report (MIR)	Integer64
IvprId	Unique ID of the inventory position reservations	Integer64
BOMPath	Refers to the BOM path of a BOM position, if a position is linked/assigned to the issue item	String
LpId	Unique ID of the list positions	Integer64
IssueQty	Quantity of the issued material. Depends on the project default ZC_QTYRECV. If value of ZC_QTYRECV, is set to Y, and revision=0, the amount of issued quantity refers to BOM quantity. If revision is greater than 0, then defined value is considered. If value is ZC_QTYRECV, is set to N, defined value is considered. Issued quantity gets reserved in the inventory, until the MIR is posted.	Decimal
Ident	Name (code) of the ident	Integer64
ListPosQty	Quantity of the list position	Integer64
ListPosIssueQty	Issued quantity of the list position	Integer64
QtyChanged	Indicates whether the quantity of the material is changed after the last revision or not? Available values are Y and N.	String
OverIssueQty	Received quantity by an overissue	Decimal
OnHandQty	Refers to the On-hand quantity and is calculated as (= received quantity - reserved quantity - issued quantity)	Decimal
DCIQty	Refers to the Design Change Issue quantity. You cannot update this quantity.	Decimal
RevWithDC	Indicates whether the quantity is revised with respect to DCI Qty or not. Available values are Y and N.	String
DCIOnHandQty	Refers to the DCI On-hand Quantity. You cannot update this quantity.	Decimal
LnId	Unique ID of the list node	Integer64
IssueDate	Date and time of the material issue	Date Time Offset
WhId	Unique ID of the warehouse. Assigning warehouses depend on the project default ZC_MULT_WH. If ZC_MULT_WH is set to Y, you can assign only those warehouses to user from screen C.10.02 that have checked Multiple Selection indicator, to the MIR.	Integer64
LocId	Unique ID of the location	Integer64
SmstId	Unique ID of the site material status	Integer64
MLDProcessing	MLD processing occurs if any of the MLD type is provided by the user. Available options are: NULL Register and Reissue: MLD gets registered (with this MIR), and a new quantity is issued. You can only insert the MLD quantity and the issue quantity. Register only: MLD gets registered and you can insert only the MLD quantity. Use OI to compensate: this option allows you to insert a quantity (max Overissue Onhand Qty) to compensate the MLD. After, you have posted the MIR, the quantities will be issued against the overissue warehouses (MLD Qty), and the inventory warehouse (Issue Qty). The overissue quantity will be revised for the company in old MIRs. Default value is Register and Reissue.	String
MLDRegisterQty	Refers to the registered Miss or Lost or Damage (MLD) quantity. You can insert or update this quantity only if MIR issue type is Miss, Lost, or Damage. The MX MLD Qty is equal to the Sum Issued/Overissue Qty.	Decimal
TotalOIQty	Total overissue quantity that can be used to compensate a MLD quantity	Decimal
OIOnHandQty	Sum of the overissue on-hand quantity	Decimal
SumOIQty	Sum of the issued and overissued quantity for the company	Decimal
UsedOIQty	You can compensate MLD quantity with overissue quantities made for previous MIRs of the same company. However, to use this overissue quantity, MLD type should be "Use OI to compensate". This quantity is UsedOI quantity. The max quantity of the Used Overissue Qty is equal to the Overissue On-hand Qty and the MLD Qty.	Decimal
RevOverissueQty	Revised quantity by an overissue	Decimal
UnitId	Unique ID of the unit	Integer64
TagNumber	Tag number for this ident	String
TotalRecvQty	Total received quantity for this ident	Integer64
ListPosResvQty	Reserved quantity of the list position	Integer64
CommodityId	Unique ID to identify the commodity	Integer64
Size (1-5)	Sizes of ident (1-5)	String
HeatId	Unique ID of the heat number	Integer64
ItemShipId	Unique ID of the item shipments	Integer64
ResvQty	Reserved quantity by a forecast	Decimal
SubstInd	Indicates whether the ident is a substitute ident or not. Available values are Y and N.	String
OriginalIdent	Original ident	Integer64

Read an inventory issue details - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)