Get inventory items details - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R2 (2.2)

This API retrieves the possible inventory items for the given Material Issue Report ID (MirId) and List positions ID (LpId) combination, used for creating an Inventory issue detail.

  • This API only supports MIR by BOM Commodity type.

  • Ths API don't support Issue Type;Reverse Pick Ticket.

Required Privilege: API_MIR

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}/GetInventoryItems({key2})

Specify the values for the project, discipline, language, and the key parameters in the URL. The project, discipline, and language together, define the project environment. The key1 parameter defines the Material Issue Report ID (MirId) and key2 parameter defines the list positions ID (LpId).

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/IssueReports(10000054897)/GetInventoryItems(LpId=10000452003)

Success Response

Status: 200 OK

Content:

{

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

    "value": [

        {

            "IviId": 10000062729,

            "ProjId": "RS",

            "Ident": 10000372535,

            "WhId": 10000001259,

            "LocId": 5301,

            "SmstId": 5221,

            "UnitId": 500127,

            "DpId": 5020,

            "RecvQty": 100,

            "ResvQty": 0,

            "IssueQty": 0,

            "ItyId": 500018,

            "TagNumber": "---",

            "SasId": 10000000695,

            "HeatId": 10000006395,

            "IdentDeviation": null,

            "PlateId": null,

            "IntResvQty": 6,

            "ManResvQty": 0,

            "TransRecvQty": 0,

            "PicsRecvQty": 0,

            "OiRecvQty": 0,

            "DciRecvQty": 0,

            "SubstTransRecvQty": 0,

            "RtiRetQty": 0,

            "OnhandQty": 94

        },

        {

            "IviId": 10000083909,

            "ProjId": "RS",

            "Ident": 23162866,

            "WhId": 10000002904,

            "LocId": 10000010899,

            "SmstId": 5701,

            "UnitId": 500127,

            "DpId": 5020,

            "RecvQty": 100,

            "ResvQty": 0,

            "IssueQty": 0,

            "ItyId": 500018,

            "TagNumber": "---",

            "SasId": null,

            "HeatId": null,

            "IdentDeviation": null,

            "PlateId": null,

            "IntResvQty": 12,

            "ManResvQty": 0,

            "TransRecvQty": 0,

            "PicsRecvQty": 0,

            "OiRecvQty": 0,

            "DciRecvQty": 0,

            "SubstTransRecvQty": 0,

            "RtiRetQty": 0,

            "OnhandQty": 88

        }

    ]

}

Element

Description

Type

IviId

Unique ID of the retrieved inventory item

Integer64

ProjId

Unique ID of the Project. Retrieved inventory item belongs to this project.

String

Ident

Name (code) of the ident

Integer64

WhId

Unique ID of the warehouse

Integer64

LocId

Unique ID of the location

Integer64

SmstId

Unique ID of the site material status

Integer64

UnitId

Unique ID of the unit

Integer64

DpId

Unique ID of the Discipline. Retrieved inventory item belongs to this discipline.

Integer64

RecvQty

Received quantity

Decimal

ResvQty

Quantity reserved by a forecast

Decimal

IssueQty

Issued quantity for the retrieved inventory item

Decimal

ItyId

Unique ID of the inventory. Retrieved item belongs to this inventory.

Integer

TagNumber

Tag number for this ident

String

SasId

Unique ID of the site attribute sets

Integer

HeatId

Unique ID of the heat number

Integer64

IdentDeviation

Ident deviation for the retrieved inventory item

String

PlateId

Unique ID of the plate

Integer

IntResvQty

Actual or initial reserved quantity of the inventory item

Decimal

ManResvQty

Manually reserved quantity of the inventory item against the inventory

Decimal

TransRecvQty

Received quantity of the inventory item by a material transfer

Decimal

PicsRecvQty

Received quantity of the inventory item by a physical count sheet rule

Decimal

OiRecvQty

Received quantity of the inventory item by an overissue

Decimal

DciRecvQty

Received quantity of the inventory item by a design change

Decimal

SubstTransRecvQty

Received quantity of the inventory item by a substitution or transformation

Decimal

RtiRetQty

Return quantity of this inventory item from return to inventory number

Decimal

OnhandQty

Refers to the On-hand quantity

Decimal