Headers
|
Header name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
POST body
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
DataBase |
Database Information |
String |
Required |
|
|
ServiceURL |
The SRD service URL |
String |
Required |
|
|
UsId |
User ID |
String |
Required |
|
|
LogFileLocation |
Log file location on the application server |
String |
Required |
|
|
LanguageId |
Language ID |
Number |
Required |
|
|
TransferJobId |
Unique ID for Transfer Job |
Integer |
Required |
|
|
IbsQueue |
Queue in Intergraph Batch Manager |
String |
Required |
|
|
ConsoleExeLocation |
The SRDTransferJobConsoleClient location on application server |
String |
Required |
|
|
ScheduledTime |
The date and time at which the transfer job starts running |
Date |
Required |
|
|
ExecuteJobInCaseIfPathsAreWriteProtected |
Option for user to specify whether to execute the scheduled job or not if paths are write protected |
String |
Required |
|
|
ContinueIfSymbolsMissing |
Option for user to specify whether to continue the execution of scheduled job or not if symbols are missing |
String |
Required |
|
|
ContinueIfDisusedCommodityCodesExist |
Option for user to specify whether to continue the execution of scheduled job or not if disused commodity codes exist |
String |
Required |
|
|
ContinueIfInterfaceVersionMissingInDestination |
Option for user to specify whether to continue the execution of scheduled job or not if interface version is not specified in the destination |
String |
Required |
|
|
SendMail |
Option for user to enable or disable email notifications |
String |
Required |
|
|
MailId |
Email ID to which the email notifications to be sent |
String |
Optional |
|
|
DestinationChangesExistCancelAndRestart |
Option for user to specify whether to continue the execution of scheduled job or not if destination changes are existing |
String |
Required |
|
|
Project |
Retrieves the project details |
String |
Required |
|
|
InterfaceId |
Interface ID |
Number |
Required |
Sample request
POST https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/ScheduledJobs
{
"DataBase":"in-srddevutdb/sprdpr",
"ServiceURL":"http://in-srdappsrv1/SmartplantReferenceDataPlus2015/Service.asmx",
"UsId":"5921",
"LogFileLocation":"D:\\TransferJobsExe\\Logs",
"LanguageId":"5000",
"TransferJobId":56415,
"IbsQueue":"SRDPlusQueue1",
"ConsoleExeLocation":"D:\\TransferJobsExe",
"ScheduledTime":"2019-11-01T19:27:38.7542991+05:30" ,
"ExecuteJobInCaseIfPathsAreWriteProtected":"N",
"ContinueIfSymbolsMissing":"N",
"ContinueIfDisusedCommodityCodesExist":"N",
"ContinueIfInterfaceVersionMissingInDestination":"Y",
"SendMail":"Y",
"MailId":"abc@ingr.com",
"DestinationChangesExistCancelAndRestart":"IC",
"Project":"SDB",
"InterfaceId":5000
}
Response
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
ScheduledJobId |
Unique ID for the Scheduled Job |
Integer |
||
|
TransferJobId |
Unique ID for Transfer Job |
Integer |
||
|
Project |
Retrieves the project details |
String |
||
|
IbsQueue |
Enabled queue in Intergraph Batch Manager |
String |
||
|
ScheduledTime |
The date and time at which the transfer job starts running |
Date |
||
|
ConsoleExeLocation |
The SRDTransferJobConsoleClient location on application server |
String |
||
|
ExecuteJobInCaseIfPathsAreWriteProtected |
Option for user to specify whether to execute the scheduled job or not if paths are write protected |
String |
||
|
ContinueIfSymbolsMissing |
Option for user to specify whether to continue the execution of scheduled job or not if symbols are missing |
String |
||
|
ContinueIfDisusedCommodityCodesExist |
Option for user to specify whether to continue the execution of scheduled job or not if disused commodity codes exist |
String |
||
|
ContinueIfInterfaceVersionMissingInDestination |
Option for user to specify whether to continue the execution of scheduled job or not if interface version is not specified in the destination |
String |
||
|
SendMail |
Option for user to enable or disable email notifications |
String |
||
|
DestinationChangesExistCancelAndRestart |
Option for user to specify whether to continue the execution of scheduled job or not if destination changes are existing |
String |
||
|
InterfaceId |
Interface ID |
Number |
||
|
DataBase |
Database Information |
String |
||
|
LanguageId |
Language ID |
Number |
||
|
ServiceURL |
The SRD service URL |
String |
||
|
UsId |
User ID |
String |
||
|
InterfLogFileLocation |
Log file location on the application server |
String |
||
|
MailId |
Email ID to which the email notifications to be sent |
String |
Sample response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/ScheduledJobs/$entity",
"ScheduledJobId": 6311,
"TransferJobId": 56415,
"Project": "SDB",
"IbsQueue": "SRDPlusQueue1",
"ScheduledTime": "2019-11-01T19:27:38.7542991+05:30",
"ConsoleExeLocation": "D:\\TransferJobsExe",
"ExecuteJobInCaseIfPathsAreWriteProtected": "N",
"ContinueIfSymbolsMissing": "N",
"ContinueIfDisusedCommodityCodesExist": "N",
"ContinueIfInterfaceVersionMissingInDestination": "Y",
"SendMail": "Y",
"DestinationChangesExistCancelAndRestart": "IC",
"InterfaceId": 5000,
"DataBase": "in-srddevutdb/sprdpr",
"LanguageId": "5000",
"ServiceURL": "http://in-srdappsrv1/SmartplantReferenceDataPlus2015/Service.asmx",
"UsId": "5921",
"LogFileLocation": "D:\\TransferJobsExe\\Logs",
"MailId": "abc@ingr.com"
}