This API updates an existing Open MTO Interface (OMI) Import job in Smart Materials.
This API updates only those OMI Import jobs that have:
-
Data Source: Flat Load Config (FLC)
-
Load options: ASCII/EXCEL/CIP
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: PUT https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/OMIImportJobs({key})
Specify values for the project, discipline, and language in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the OMI Import job Id (OMIJId).
-
In data source, only FlatConfig source is allowed.
-
You can update an OMI Import job only when the job status is NEW.
-
If no parameter is passed, then PUT method overrides any existing data with a blank value.
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
OMIJId |
Unique ID of the OMI Import job |
Integer |
Required |
|
StatId |
Unique ID of the issue status. GET https://{host}/Smat/V1/Projects(‘:project’) |
Integer |
Required |
Maximum allowed length is 12. |
LstId |
Unique ID of the list status. GET https://{host}/Smat/V1/Projects(‘:project’)/ Only those list status can be included in |
Integer |
Required |
Maximum allowed length is 12. |
JobCode |
Name of the OMI Import Job |
String |
Required |
Maximum allowed length is 20. |
TransferInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
ImportFabSpoolsInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
RecognizeInd |
Defines whether the OMI Import job should run Default is Normal Mode. |
String |
Optional |
If no value is passed, |
RevIncrementInd |
Defines how the OMI Import job should handle locked BOM data
|
String |
Optional |
If no value is passed, |
FindIdentInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
MapCCInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
TransferSiteQty |
Controls whether the (Transfer Site Quantity (TSQ) for IFC |
String |
Optional |
If no value is passed, |
AppendInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
TransactionSize |
Transaction size for the import job |
Integer |
Optional |
Default value is 100. |
CompanyId |
Unique ID of the company for which you want to specify the mapping option. To view available Company IDs, use: GET https://{host}/Smat/V1/Projects(‘:project’)/ |
Integer |
Optional |
Maximum allowed length is 12. |
ImportPath |
Refers to the directory where the import file is stored in the DB server. This DB server path is specified in the DBA setting BOM_IMPORT_PATH. |
String |
Required |
Maximum allowed length is 128. When FLC Load Option CIP |
ImportFile |
Name of the imported file that is stored in the DB server |
String |
Required |
Maximum allowed length is 30. When FLC Load Option CIP |
PDSStartLnId |
Used when data load is obtained from PDS report |
Integer |
Optional |
Maximum allowed length is 12. |
UserComment |
Comment added by the logged-in user |
String |
Optional |
Maximum allowed length is 80. |
FlcId |
Unique ID of a Flat Configuration |
Integer |
Optional |
Maximum allowed length is 12. |
FlcLoadOption |
Available Load option values are:
Default Load Option is ASCII. |
String |
Optional |
If no value is passed, If CIP is passed in Load Option, |
CheckConsistencyInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
OMIPos |
Method used by OMI Import job to create position numbers
|
String |
Optional |
If no value is passed |
NextStatIdInd |
Refers to NextIssueStatus of B.40.01 screen of Classic. Allowed values are Y and N.
Default value is N. |
String |
Optional |
If no value is passed, |
LockBOMInd |
Allowed values are Y and N.
|
String |
Optional |
If no value is passed, |
FLC Delimiter |
Column separator. Default value is ';'. |
String |
Optional |
If no value is passed, |
Skip LInes |
Number of lines to skip in a FLC load |
Integer |
Optional |
Default value is 0. |
PitStop |
Allowed values are Y and N.
|
String |
Optional |
Default value is N. |
Sample Code
PUT https://localhost:56158/SMAT/V1//Projects('AB')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000017298)
{
"JobCode":"PLJOBReview1222",
"StatId":10000003445,
"LstId":5745,
"ImportFabSpoolsInd":"Y",
"RecognizeInd":"Y",
"RevIncrementInd":"Y",
"FindIdentInd":"Y",
"MapCCInd":"Y",
"AppendInd":"Y",
"TransferInd":"Y",
"CompanyId":5735,
"ImportFile":"TestfileName",
"ImportPath":"TestFilepath",
"FlcLoadOption":"EXCEL",
"FLCDelimiter":",",
"SkipLines":6,
"CheckConsistencyInd":"N",
"OMIPos":"AUTO",
"NextStatIdInd":"Y",
"LockBOMInd":"Y",
"UserComment":"Unit test",
"PitStop":"N",
"FlcId":8246,
"TransactionSize":1000,
"PDSStartLNId":10000034373,
"TransferSiteQty":"Y"
}
Success Response
Status: 200OK
{
"@odata.context": "https://localhost:59387/SMAT/V1/$metadata#Projects('AB')/Disciplines('PIPING')/Nls('English')/OMIImportJobs/$entity",
"OMIJId":10000017298,
"JobCode":"PLJOBREVIEW1222",
"StatId":10000003445,
"LstId":5745,
"DataSource":"FLC",
"TransferInd":"Y",
"ImportFabSpoolsInd":"Y",
"RecognizeInd":"Y",
"RevIncrementInd":"Y",
"FindIdentInd":"Y",
"MapCCInd":"Y",
"RestartableInd":"N",
"AppendInd":"Y",
"TransactionSize":1000,
"JobStatus":"NEW",
"CompanyId":5735,
"ImportPath":"TestFilepath",
"ImportFile":"TestfileName",
"PDSStartLNId":10000034373,
"UserComment":"Unit test",
"JobStartUser":null,
"StartDate":null,
"EndDate":null,
"ExecutionSummary":null,
"LogFile":null,
"ErrorFile":null,
"TransferSiteQty":"Y",
"PitStop":"N",
"FlcId":8246,
"FlcLoadOption":"EXCEL",
"FLCDelimiter":",",
"SkipLines":6,
"CheckConsistencyInd":"N",
"OMIPos":"AUTO",
"NextStatIdInd":"Y",
"LockBOMInd":"Y",
"DpId":5020,
"ParentOMIJId":null
}
Element |
Description |
Type |
Notes |
---|---|---|---|
DataSource |
Data source of the OMI Import job |
String |
In this API, |
JobStatus |
Status of the OMI Import job |
String |
Job status always remains |
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 URL. |
Integer |
|
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 |
|
LogFile |
If you have run the OMI job in Online/Batch/Schedule mode, and set the parameters
|
String |
|
ErrorFile |
Provides a record of actions and errors of the OMI Import job |
String |
|
RestartableInd |
Allowed values are Y and N.
|
String |
Default value is N. |