This API updates an existing Flat Pre-Import record of an Open MTO Interface Import job in Smart Materials.
Required Privilege: API_BOM
Headers
Header Name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format:PATCH https://in-smatapi.ingrnet.com/current/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/OMIImportJobs({key1})/FlatPreImports({key2})
Specify values for the project, discipline, language, and key parameters in the URL. The project, discipline, and language together, define the project environment and the key parameters define: key 1 is OMI Import job Id (OMIJId) and key2 is Flat Pre-Import Id (FloadId).
If you provide values for NodeType, NodeAttr, and Table, then the system ignores the value and takes the related value from the existing Flat Pre-Import records.
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
OMIJId (key1) |
Unique ID of the OMI Import Job |
Integer |
Required |
|
FloadId (key2) |
Unique ID of the Pre-Import record |
Integer |
Required |
|
Guid |
Unique number created by the tool that |
String |
Optional |
Maximum allowed length is 255. |
Node (0-9) |
Represents the node name that needs to be |
String |
Optional |
Ten values are allowed. Maximum allowed |
Import |
Allowed values are Y and N.
|
String |
Optional |
|
Quantity |
Quantity of the position |
String |
Optional |
Maximum allowed |
IdentCode |
Ident code of the BOM position |
String |
Optional |
Maximum allowed |
UnitCode |
UnitCode of the BOM Quantity |
String |
Optional |
Maximum allowed |
PositionAttr (1-120) |
Refers to the position attribute value |
String |
Optional |
One hundred and |
Size (1-4) |
Represents sizes |
String |
Optional |
Four values are allowed.
|
TagNumber |
Ident Tag Number as defined |
String |
Optional |
Maximum allowed |
ItemType |
Item type as defined |
String |
Optional |
Maximum allowed |
ShortCode |
Code selected from the |
String |
Optional |
Maximum allowed length is 10. |
LayoutShort |
Belongs to the National Language System (NLS), |
String |
Optional |
Maximum allowed length is 2000. |
LayoutLong |
Belongs to the NLS, |
String |
Optional |
Maximum allowed |
OptionCode |
Code obtained from the context of |
String |
Optional |
Maximum allowed |
CommodityGroup |
Commodity Group based on the screen S.10.02. |
String |
Optional |
Maximum allowed |
CommodityPart |
Commodity Part based on the screen S.10.03. |
String |
Optional |
Maximum allowed |
Position (Position number) |
Unique position number within a node. |
String |
Optional |
Maximum allowed |
TableDetail (1-10) |
Represents the value of the corresponding tables1-10. |
String |
Optional |
Maximum allowed length is 40. |
PositionMain |
A value set in this field defines this position as assembly master position. |
String |
Optional |
Maximum allowed length is 6. |
PositionSub (1-10) |
A value in this field defines the assembly level These values must be set without gaps, |
String |
Optional |
Maximum allowed length is 6. |
IssueStatus |
Issue status as defined in the screen B.10.08. |
String |
Optional |
Maximum allowed |
Sum |
String |
Optional |
Maximum allowed |
|
ObejctCode |
You can define any code in this. |
String |
Optional |
Maximum allowed |
LayoutShort2 |
Belongs to the second NLS as defined in the FLC config. |
String |
Optional |
Maximum allowed |
LayoutLong2 |
Belongs to the second NLS as defined in the FLC config. |
String |
Optional |
Maximum allowed |
LayoutShort3 |
Belongs to the third NLS as defined in the FLC config. |
String |
Optional |
Maximum allowed length is 2000. |
LayoutLong3 |
Belongs to the third NLS as defined in the FLC config. |
String |
Optional |
Maximum allowed |
ListStatus |
List status as defined in the screen B.10.02. |
String |
Optional |
Maximum allowed |
NodeAttrValue (1-12) |
Value of the corresponding node attribute as |
String |
Optional |
Maximum allowed length is 255. |
CommodityCode |
CommodityCode of the BOM Ident |
String |
Optional |
Maximum allowed |
SpecCode |
Specifications as defined on the screen S.50.03. |
String |
Optional |
Maximum allowed |
If no parameter is passed, then PATCH method overrides any existing data with a blank value.
Sample Code
PATCH https://in-smatapi.ingrnet.com/current/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000012981)/FlatPreImports(10000071725)
{
"Quantity":"250",
"UnitCode":"I72477143",
"CommodityCode":"GCM2K6L7F11T1A00",
"CommodityGroup":"G",
"CommodityPart":"CM",
"Position":"10",
"PositionSub01":"EA",
"IssueStatus":"DEF",
"ListStatus":"EA"
}
Success Response
Status: 200 OK
{
"@odata.context": "https://localhost:57464/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000012981)/FlatPreImports/$entity",
"FloadId":10000071725,
"OMIJId":10000012981,
"Guid":"10000046852",
"Node0":"SA_DISC",
"Node1":"SA_UNIT",
"Node2":"SA_AREA",
"Node3":"SA_line",
"NodeType0":"DISC1",
"NodeType1":"UNIT",
"IdentCode":"C7FKJ6",
"UnitCode":"I72477143",
"Quantity":"250",
"PositionAttr1":"SGL",
"Import":"Y",
"CommodityCode":"GCM2K6L7F11T1A00",
"SpecCode":"1C0031",
"Size1":null,
"TagNumber":"SD45678",
"ItemType":"SWT",
"ShortCode":"GE Tag testing WO POS QTY",
"LayoutShort":null,
"LayoutLong":"A pulley, also called a sheave or a drum, is a mechanism composed of a wheel on an axle or shaft.",
"OptionCode":null,
"CommodityGroup":"G",
"CommodityPart":"CM",
"Position":"10",
"NodeAttr1":null,
"NodeAttrValue1":null,
"TableDetail1":"LS TABLE DETAIL",
"Table1":"GEOMETRY_INDUSTRY_STANDARD",
"PositionMain":null,
"PositionSub01":"EA",
"IssueStatus":"DEF",
"Sum":null,
"ObjectCode":null,
"LayoutShort2":null,
"LayoutLong2":null,
"LayoutShort3":null,
"LayoutLong3":null,
"ListStatus":"EA"
}
Element |
Description |
Type |
Notes |
---|---|---|---|
Table (1-10) |
Tables as defined in the FLC config. |
String |
|
NodeAttr (1-12) |
Node attribute name based on/obtained from |
String |
|
NodeType (0-9) |
Obtained from the FLC config and cannot be changed. |
String |