Inventory position reservations (InvPosReservations) - 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 inventory position reservations of a project from Smart Materials. You can either retrieve a single inventory position reservation using inventory position reservations Id or all the inventory position reservations of a project.

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’)/InvPosReservations({key})

Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the inventory position reservation Id (IvprId).

To retrieve all the inventory position reservations of a project, use the following URL:

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

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/InvPosReservations(5717)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/InvPosReservations",

"value":[

{

"IvprId":5717,

"ProjId":"RS",

"LpId":2873758,

"IviId":5107,

"ItemShipId":null,

"FahId":5699,

"DpId":500017,

"UnitId":500127,

"IvprType":"RR",

"ResvQty":0,

"Ident":44864086,

"LnId":196643,

"TransResvQty":0,

"OldResvQty":0,

"ParentIvprId":null,

"OriginalLpId":null,

"OriginalResvQty":0,

"FsmnSelInd":"N"

}]

}

Element

Description

Type

IvprId

Unique ID of the inventory position reservations

Integer

ProjId

Unique ID of the Project. Retrieved inventory position reservations belong to this Project.

String

LpId

Unique ID of the list positions

Integer

IviId

Unique ID of the inventory items

Integer

ItemShipId

Unique ID of the item shipment

Integer

FahId

Unique ID of the Forecast header

Integer

DpId

Unique ID of the Discipline. Retrieved inventory position reservations belong to this Discipline.

Integer

UnitId

Unique ID of the unit

Integer

IvprType

Type of the inventory position reservation

String

ResvQty

Reserved quantity

Decimal

Ident

Ident number

Integer

LnId

Unique ID of the list nodes

Integer

TransResvQty

Reserved quantity by a material transfer

Decimal

OldResvQty

Actual reserved quantity

Decimal

ParentIvprId

Unique ID of the parent inventory position reservation of the current inventory position reservation

Integer

OriginalLpId

Unique ID of the original list position

Integer

OriginalResvQty

Actual or original reserved quantity of the list position

Decimal

FsmnSellnd

String