Read 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 retrieves a Flat Pre-Import record from 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:GET 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).

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

Sample Code

GET https://in-smatapi.ingrnet.com/current/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(476)/FlatPreImports(10000073037)

To view all the Flat Pre-Import records of an OMI Import job, use the following:

GET https://in-smatapi.ingrnet.com/current/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(476)/FlatPreImports

Success Response

Status: 200 OK

      {

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

    "FloadId":10000073037,

    "OMIJId":476,

    "Guid":"10000047372",

    "Node0":"MARINE6",

    "NodeType0":"UNIT",

    "IdentCode":"C6AJP3",

    "UnitCode":"EA",

    "Quantity":"280",

    "PositionAttr1":"Area",

    "Import":"N",

    "CommodityCode":null,

    "SpecCode":"1C0031",

    "Size1":null,

    "TagNumber":null,

    "ItemType":"SWT",

    "ShortCode":null,

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

    "LayoutLong":"A pulley also called as drum, is a mechanism composed of a wheel on an axe or shaft.",

    "OptionCode":null,

    "CommodityGroup":null,

    "CommodityPart":null,

    "Position":"12",

    "NodeAttr1":null,

    "NodeAttrValue1":null,

    "TableDetail1":"LS TABLE DETAIL",

    "Table1":"GEMOETRY_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

Guid

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

String

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

NodeType (0-9)

Obtained from the FLC config and cannot be changed

String

IdentCode

Ident code of BOM Position

String

UnitCode

UnitCode of the BOM Quantity

String

Quantity

Quantity of the position

String

PositionAttr (1-120)

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

String

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

CommodityCode

CommodityCode of the BOM Ident

String

SpecCode

Specifications as defined on the screen S.50.03

String

Size (1-4)

Represents sizes

String

Tag Number

Ident Tag Number as defined on the screen S.80.21

String

Item type

Item type as defined on the screen A.10.15

String

ShortCode

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

String

LayoutShort

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

String

LayoutLong

Belongs to the NLS, the user is logged in

String

LayoutShort 2

Belongs to the second NLS as defined in the FLC config

String

LayoutLong 2

Belongs to the second NLS as defined in the FLC config

String

LayoutShort 3

Belongs to the third NLS as defined in the FLC config

String

LayoutLong 3

Belongs to the third NLS as defined in the FLC config

String

OptionCode

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

String

CommodityGroup

Commodity Groups based on the screen S.10.02.

String

CommodityPart

Commodity Parts based on the screen S.10.03.

String

Position (Position number)

Unique position number within a node

String

NodeAttr (1-12)

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

String

NodeAttrValue (1-12)

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

String

TableDetail (1-10)

Represent the values of the corresponding tables1-10

String

Table (1-10)

Tables as defined in the FLC config

String

PositionMain

A value set in this field defines this position as assembly master position.

String

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

IssueStatus

Issue status as defined in the screen B.10.08.

String

Sum

String

ObjectCode

You can define any code in this

String

ListStatus

List status as defined in the screen B.10.02.

String