This API clones an existing Open MTO Interface (OMI) Import job in Smart Materials. While cloning, all the values are copied from the parent OMIJob including ImportPath and ImportFile.
-
This API clones only those OMI Import jobs that have:
-
Data Source: Flat Load Config (FLC)
-
Load options: ASCII/EXCEL/CIP
-
-
If you want to upload a new file to the cloned job, use Upload a file in an Open MTO Interface.
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: https://localhost:56158/smat/v1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/OMIImportJobs({key})/NewRun()
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).
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
OMIJId |
Unique ID of the OMI Import job which you want to clone. |
Integer |
Required |
Maximum allowed length is 12. |
Sample Code
POST https://localhost:56158/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs(10000015828)/NewRun()
Success Response
Status: 201 Created
{
"@odata.context": "https://localhost:56158/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/OMIImportJobs/$entity",
"OMIJId":10000017299,
"JobCode":"SAMPLETEST123-26",
"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 |
Notes |
---|---|---|---|
StatId |
Unique ID of the issue status |
Integer |
|
ListId |
Unique ID of the list status |
Integer |
|
JobCode |
Name of the OMI Import job that user wants to clone |
String |
|
JobStartUser |
User who has started the OMI job |
String |
|
StartDate |
Date and time when the OMI job is 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 |
|
TransferInd |
Allowed values are Y and N.
|
String |
Default value is Y. |
ImportFabSpoolsInd |
Allowed values are Y and N.
|
String |
Default value is N. |
RecognizeInd |
Defines whether the OMI Import job should |
String |
Default mode |
RevIncrementInd |
Defines how the OMI Import job should handle locked BOM data Allowed values are Y and N.
|
String |
Default value is N. |
FindIdentInd |
Allowed values are Y and N.
|
String |
Default value is N. |
MapCCInd |
Allowed values are Y and N.
|
String |
Default value is N. |
RestartableInd |
Allowed values are Y and N.
|
String |
Default value is N. |
TransferSiteQty |
Controls whether the Allowed values are Y and N. |
String |
Default value is Y. |
AppendInd |
Allowed values are Y and N.
|
String |
Default value is N. |
TransactionSize |
Transaction size for the import job |
Integer |
Default value is 100. |
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. 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 login user |
String |
|
FlcId |
Unique ID of a Flat Configuration |
Integer |
|
FlcLoadOption |
Available load option values are:
|
String |
Default Load Option |
CheckConsistencyInd |
Allowed values are Y and N.
|
String |
Default value is N. |
OMIPos |
Method that the OMI Import job uses to create position numbers
|
String |
Default value |
NextStatIdInd |
Refers to NextIssueStatus of B.40.01 screen of Classic. Allowed values are Y and N.
Default value is N. |
String |
Default value is N. |
LockBOMInd |
Allowed values are Y and N.
|
String |
Default value is N. |
FLC Delimiter |
Column separator. |
String |
Default value is ;. |
Skip LInes |
Number of lines to skip in a FLC load |
Integer |
Default value is 0. |
PitStop |
Allowed values are Y and N.
|
String |
Default value is N. |
DataSource |
Data source of the OMI Import job |
String |
Only Flat Load Config |
JobStatus |
Status of the OMI Import job |
String |
Job status always |
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 |