Add Inventory Issuing Details - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

Inventory Issuing – This API adds inventory items to the specified MIR.

URL Format

/Projects (':project')/Disciplines(':discipline')/Nls(':language')/IssuingHeaders ({key})/Com.Ingr.Smat.V1. MIRInventory/

Specify values for project, discipline, language and key parameters in the URL. The first three values together define a project environment in which the forecast header is created. The key parameter defines the MIR header id, for which an inventory item is created.

Use the following read-only APIs to get the available values for each parameter.

/Projects,

/projects(':project')/Disciplines,

/projects(':project')/Disciplines(':discipline')/nls

URL Parameter

:project, :discipline, :language, :key

Method

POST

Required Privilege

API_CREATE_INV_ISSUES

Data Parameter

The payload of the request should be in JSON format with the following structure:

<Action Name="MIRInventory" IsBound="true">

<Parameter Name="bindingParameter" 

Type="Com.Ingr.Smat.Core.V1.IssuingHeader"/>

<Parameter Name="InvIssue" 

Type="Com.Ingr.Smat.Core.V1.InventoryIssue"/>

<ReturnType Type="Edm.Int64" Nullable="false"/>

</Action>

Below is the JSON structure of Com.Ingr.Smat.Core.V1.InventoryIssue:

<ComplexType Name="InventoryIssue">

<Property Name="IviId" Type="Edm.Decimal"/>

<Property Name="LpId" Type="Edm.Decimal"/>

<Property Name="IvprId" Type="Edm.Decimal"/>

<Property Name="IssueQty" Type="Edm.Decimal"/>

<Property Name="IssueDate" Type="Edm.DateTimeOffset"/>

<Property Name="Ident" Type="Edm.Decimal"/>

<Property Name="WhId" Type="Edm.Decimal"/>

<Property Name="LocId" Type="Edm.Decimal"/>

<Property Name="SmstId" Type="Edm.Decimal"/>

<Property Name="UnitId" Type="Edm.Decimal"/>

<Property Name="TagNumber" Type="Edm.String"/>

<Property Name="HeatId" Type="Edm.Decimal"/>

<Property Name="PlateId" Type="Edm.Decimal"/>

<Property Name="IdentDeviation" Type="Edm.String"/>

<Property Name="SasId" Type="Edm.Decimal"/>

<Property Name="SiteStatInd" Type="Edm.String"/>

</ComplexType>

Where:

IviId (Edm.Decimal): Required IF IDENT,WH_ID,LOC_ID,SMST_ID,UNIT_ID are null. Use following Read Only API for viewing the IVI_IDs. Use following Read Only API to view the IVI IDs:

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

LpId (Edm.Decimal): List Position ID. It is needed for MIR by Reservation. Use following Read Only API to view the available list positions:

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

IvprId (Edm.Decimal): It is needed for MIR by Reservation.

IssueQty (Edm.Decimal): Issued quantity.

IssueDate (Edm.DateTimeOffset): Date when the material was issued. It is an optional value. In the absence of this value, system will use system date. The acceptable value is a date in the format of "YYYY-MM-DD".

Ident (Edm.Decimal): Name (code) of the ident. Use following Read Only API to view Idents.

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

WhId (Edm.Decimal): Name (code) of the warehouse. Use following Read Only API to view Warehouse IDs.

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

LocId (Edm.Decimal): Name (code) of the location. Use following Read Only API to view location IDs

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Locations

SmstId (Edm.Decimal): Name (code) of the receiving status defined in screen C.10.06 Site Material Status. Use following Read Only API to view SMST IDs.

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/SiteMaterialStatus

UnitId (Edm.Decimal): Name (code) of the unit. Use following Read Only API to view Unit IDs.

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Units

TagNumber (Edm.String): Tag number for this ident. Use following Read Only API to view Tag Numbers.

HeatId (Edm.Decimal): Name (code) of the heat number. Use following Read Only API to view Heat IDs.

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Heats

PlateId (Edm.Decimal): Use following Read Only API to view plate IDs.

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

IdentDeviation (Edm.String):

SasId (Edm.Decimal):

SiteStatInd (Edm.String):

Example:

{

"InvIssue":{

"IviId ":10000059709,

"IssueQty ":1

}

}

Example 2:

{

"InvIssue":{

"Ident":73354280,

"WhId":5921,

"LocId":6783,

"SmstId":5681,

"UnitId":502543,

"IssueQty":1,

"TagNumber":'TAG001',

"HeatId":5805

}

}

Success Response

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Edm.Int64",

"value": 10000011208

}

Error Response

This API may fail with the following error messages:

Error Code: 401 Unauthorized

Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request." }

}

Notes