Read an Open MTO Interface Import job - 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 an Open MTO Interface (OMI) Import job from Smart Materials. You can retrieve a single OMI Import job by using OMI Import job Id or all the OMI Import jobs of a project.

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://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/OMIImportJobs({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 OMI Import job Id (OMIJId).

To retrieve all the OMI Import jobs of a project, use the following URL:

GET https://localhost:53965/SMAT/V1//Projects(':project')/Disciplines(':discipline')/Nls(':language')/OMIImportJobs

OMI Import job is retrieved based on the given discipline and Queryable discipline.

Sample Code

GET https://localhost:59387/SMAT/V1//Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000016817)

If the BOM job is unable to get the session lock for Project or Project/Discipline, when started/re-started in Batch/Schedule mode, it gets queued. In this scenario the JobStatus is "QUEUED".

Success Response

Status: 200OK

{

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

    "OMIJId":10000016817,

    "JobCode":"SAMPLETEST123-5",

    "StatId":5565,

    "LstId":10000006822,

    "DataSource":"FLC",

    "TransferInd":"Y",

    "ImportFabSpoolsInd":"N",

    "RecognizeInd":"N",

    "RevIncrementInd":"N",

    "FindIdentInd":"N",

    "MapCCInd":"N",

"RestartableInd":"N",

    "AppendInd":"N",

    "TransactionSize":100,

    "JobStatus":"NEW",

    "CompanyId":null,

    "ImportPath":"C:\\DEVELOPMENT\\trunk\\SPMAT\\SPMAT\\download\\",

    "ImportFile":"OMIJID10000015828",

    "PDSStartLNId":null,

    "UserComment":null,

    "JobStartUser":null,

    "StartDate":null,

    "EndDate":null,

    "ExecutionSummary":null,

    "LogFile":null,

    "ErrorFile":null,

    "TransferSiteQty":"Y",

    "PitStop":"N",

    "FlcId":null,

    "FlcLoadOption":"ASCII",

    "FLCDelimiter":";",

    "SkipLines":0,

    "CheckConsistencyInd":"N",

    "OMIPos":"BOTH",

    "NextStatIdInd":"N",

    "LockBOMInd":"N",

    "DpId":5020,

    "ParentOMIJId":10000015828

}

Element

Description

Type

OMIJId

Unique ID of the OMI Import Job

Integer

StatId

Unique ID of the issue status

Integer

ListId

Unique ID of the list status

Integer

JobCode

Name of the OMI Import job

String

JobStartUser

User who has started the OMI job

String

StartDate

Date and time when the OMI job started

Date Time Offset

EndDate

Date and time when the OMI job is completed

Date Time Offset

ExecutionSummary

A short description of the job outcome

String

ErrorFile

Provides a record of actions and errors of the OMI Import job.
When the job is finished, you can review FLC_ERR_RPT log file.

String

LogFile

If you have run the OMI job in Online/Batch/Schedule mode, and set the parameters
'LOG_FILE_DEST' and 'LOG_ONLINE_JOBS'
in screen A.60.04, then OMI job generates a log file (FLC_ERR_RPT, FLC).

String

TransferInd

Allowed values are Y and N.

  • If value Y is passed, data is transferred from the import file to BOM.

  • If value N is passed, simulation occurs, and no data is transferred.

Default value is Y.

String

ImportFabSpoolsInd

Allowed values are Y and N.

  • If value Y is passed,
    the OMI Import job imports only fabricated
    spool piece items (TFM item type) and
    rejects the other (non-TFM item type).

Default value is N.

String

RecognizeInd

Defines whether the OMI Import job should run in
Recognize mode or Normal mode.
Default mode is Normal mode.

String

RevIncrementInd

Defines how the OMI Import job should handle
Locked BOM data whose modification records
are present in the import file.
Default value is N.

Allowed values are Y and N.

  • If value Y is passed,
    the OMI Import job unlocks BOM data.
    Create a new version of affected BOM nodes
    and assign the
    default list status to the positions.

  • If value N is passed,
    the OMI Import job rejects the
    locked BOM data.

String

FindIdentInd

Allowed values are Y and N.

  • If value Y is passed,
    you can find idents for new BOM positions
    during OMI import itself.

Default value is N.

String

MapCCInd

Allowed values are Y and N.

  • If value Y is passed,
    the company specific mapping for
    commodity codes and idents occur
    during the OMI import.

Default value is N.

String

RestartableInd

Allowed values are Y and N.

  • If value Y appears, then the job can be restarted. Default value is N.

String

TransferSiteQty

Controls whether the
(Transfer Site Quantity (TSQ) for IFC to highest
Issue Status at node) logic should apply in the
OMI import job when a new highest
issue status is loaded.

Allowed values are Y and N.Default value is Y.

String

AppendInd

Allowed values are Y and N.

  • If value Y is passed,
    the OMI Import job appends
    BOM position data to positions already
    existing in BOM nodes.

  • If value N is passed,
    the OMI Import job replaces the
    BOM position data in BOM nodes.

Default value is N.

String

TransactionSize

Transaction size for the import job. Default value is 100.

Integer

CompanyId

Unique ID of the company for which you want to specify the mapping option.

Integer

ImportPath

Refers to the directory where the import file is stored in the DB server.

SHARED Tip This DB server path is specified in the DBA setting BOM_IMPORT_PATH.

String

ImportFile

Name of the imported file that is stored in the DB server

String

PDSStartLnId

Used when data load is obtained from the PDS report

Integer

UserComment

Comment added by the logged-in user

String

FlcId

Unique ID of a Flat Configuration

Integer

FlcLoadOption

Available Load option values are:

  • ASCII

  • CIP

  • EXCEL.

Default load option is ASCII.

String

CheckConsistencyInd

Allowed values are Y and N.

  • If value Y is passed, M_PCK_OMI_CUSTOM.CHECK_Consistency
    CIP is executed.
    This CIP performs additional checks that are not included in other OMI processing.

Default value is N.

String

OMIPos

Method which the OMI Import job uses to create position
numbers for the imported BOM positions.
Available methods are:

  • AUTO: OMI Import job neglects the position number
    of the imported data, instead build
    position numbers automatically based on ZB_LPSTART
    and ZB_LP_INC.

  • DATA: OMI Import job consider position numbers
    of the imported data as a
    mandatory field.

  • BOTH: OMI Import job first checks
    the imported data parameters.
    If parameters are present,
    it uses DATA position, else switch to AUTO.

Default value is AUTO.

String

NextStatIdInd

Refers to NextIssueStatus of B.40.01 screen of Classic. Allowed values are Y and N.

  • If value Y is passed, then the issues status specified
    in the OMI Import job and BOM file is ignored.
    BOM positions are created with the next highest issue status
    available for the node where they are imported.

String

LockBOMInd

Allowed values are Y and N.

  • If value Y is passed, nodes, node values,
    positions, and position values are
    locked automatically during the BOM import.

Default value is N.

String

FLC Delimiter

Column separator.
Example: “/”, “,”, “%”, and so on.
Default value is ;.

String

Skip LInes

Number of lines to skip in a FLC load.
Default value is 0.

Integer

PitStop

Allowed values are Y and N.

  • If value Y is passed,
    the FLC based import job is
    paused at status stage.
    You can edit and review data before continuing the job.

Default value is N.

String

DataSource

Data source of the OMI Import job

String

JobStatus

Status of the OMI Import job.

String

DpId

Unique ID of the cloned OMI Import job Discipline

Integer

ParentOmijId

Parent OMI Import job of the current OMI Import job as specified in the URL.

Integer