Create a Flat Pre-Import record - 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 creates a new Flat Pre-Import record in 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:POST https://{host}/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':Language')/OMIImportJobs ({key})/FlatPreImports

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 OMI Import job Id (OMIJId).

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

Unique ID of the OMI Import Job

Integer

Required

Guid

Unique number created by the
tool that generates the OMI Import files

String

Optional

Maximum allowed
length is 255.

Node (0-9)

Represents the node name that needs to be imported from
the respective Nodes Types as defined in NodeType (0-9)
in FLC

String

Optional

Maximum allowed
length is 255.

Import

Allowed values are Y and N.

  • If value Y is passed, record is considered
    during the import job.

  • If value N is passed, record is ignored
    during the import job.

String

Optional

Quantity

Quantity of the position

String

Optional

Maximum allowed
length is 10.

IdentCode

Ident code of the BOM position

String

Optional

Maximum allowed
length is 100.

UnitCode

UnitCode of the BOM Quantity

String

Optional

Maximum allowed
length is 10.

PositionAttr (1-120)

Refers to the position attribute value and
is defined in the FLC config

String

Optional

Maximum allowed
length is 2000.

Size (1-4)

Represents sizes

String

Optional

Maximum allowed
length is 60.

TagNumber

Ident Tag Number as defined on the screen S.80.21

String

Optional

Maximum allowed
length is 60.

ItemType

Item type as defined on the screen A.10.15

String

Optional

Maximum allowed
length is 10.

ShortCode

Code selected from the context of Specification
Management screen S.50.06

String

Optional

Maximum allowed
length is 10.

LayoutShort

Belongs to the National Language System (NLS), the
user is logged in

String

Optional

Maximum allowed
length is 2000.

LayoutLong

Belongs to the NLS, the user is logged in

String

Optional

Maximum allowed
length is 2000.

OptionCode

Code obtained from the context of Specification
Management screen S.50.06.

String

Optional

Maximum allowed
length is 10.

CommodityGroup

Commodity group based on the screen S.10.02

String

Optional

Maximum allowed
length is 100.

CommodityPart

Commodity part based on the screen S.10.03

String

Optional

Maximum allowed
length is 100.

Position

Unique position number within a node

String

Optional

Maximum allowed
length is 100.

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 within
the assembly master.

These values must be set without gaps,
e.g. a position on the third level must have fields
Pos Sub 1-3 filled with values.

String

Optional

Maximum allowed
length is 6.

IssueStatus

Issue status as defined in the screen B.10.08

String

Optional

Maximum allowed
length is 10.

Sum

String

Optional

Maximum allowed
length is 5.

ObejctCode

You can define any code in this

String

Optional

Maximum allowed
length is 100.

LayoutShort2

Belongs to the second NLS as defined in the FLC config

String

Optional

Maximum allowed
length is 2000.

LayoutLong2

Belongs to the second NLS as defined in the FLC config

String

Optional

Maximum allowed
length is 2000.

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
length is 2000.

ListStatus

List status as defined in the screen B.10.02

String

Optional

Maximum allowed
length is 10.

NodeAttrValue (1-12)

Value of the corresponding node attribute as defined in the NodeAttr fields.

String

Optional

Maximum allowed
length is 255.

CommodityCode

CommodityCode of the BOM Ident

String

Optional

Maximum allowed
length is 60.

SpecCode

Specifications as defined on the screen S.50.03.

String

Optional

Maximum allowed
length is 256.

Sample Code

POST https://localhost:57464/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000008849)/FlatPreImports

{

"Guid":"10000047372",

"Node0":"MARINE400",

"Node1":"PPM400",

"Node2":"AERO4",

"Node3":"CSV108444",

"Import":"Y",

"Quantity":"250"

}

Success Response

Status: 201 Created

{

"@odata.context": "https://localhost:57464/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000008849)/FlatPreImports/$entity",

"FloadId":10000094398,

"OMIJId":10000008849,

"Guid":"10000047372",

"Node0":"MARINE400",

"Node1":"PPM400",

"Node2":"AERO4",

"Node3":"CSV108444",

"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":null,

"LayoutShort":"GE Tag testing WO POS QTY",

"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",

"NodeAttr":null,

"NodeAttrValue1":null,

"TableDetail1":"LS TABLE DETAIL",

"Table1":"GEOMETRY_INDUSTRY_STANDARD",

"PositionMain":null,

"PositionSub01":"EA",

"IssueStatus":"pb_is2",

"Sum":null,

"ObjectCode":null,

"LayoutShort2":null,

"LayoutLong2":null,

"LayoutShort3":null,

"LayoutLong3":null,

"ListStatus":"EA"

}

Element

Description

Type

Notes

FloadId

Unique ID of the Pre-Import record

Integer

Table (1-10)

Tables as defined in the FLC config.

String

NodeAttr (1-12)

Node attribute name based on/obtained from
the FLC config and cannot be changed.

String

NodeType (0-9)

Obtained from the FLC config and cannot be changed.

String