Headers
Header name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/json |
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/ScheduledJobs
Response
Parameter |
Description |
Type |
Notes |
---|---|---|---|
ScheduledJobId |
Unique ID for the Scheduled Job |
||
TransferJobId |
Unique ID for Transfer Job |
||
Project |
The project or product group where the job is scheduled |
String |
|
IbsQueue |
Enabled queue in Intergraph Batch Manager |
String |
|
ScheduledTime |
The date and time at which the transfer job starts running |
Date |
|
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 |
|
LanguageId |
Language ID |
Number |
|
UsId |
User ID |
String |
Sample Response
{
"@odata.context":
"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/ScheduledJobs",
"value": [
{
"ScheduledJobId": 5001,
"TransferJobId": 49857,
"Project": "SDB",
"IbsQueue": "12345",
"ScheduledTime": "2024-09-22T00:00:00+05:30",
"ExecuteJobInCaseIfPathsAreWriteProtected": "Y",
"ContinueIfSymbolsMissing": "Y",
"ContinueIfDisusedCommodityCodesExist": "Y",
"ContinueIfInterfaceVersionMissingInDestination": "Y",
"SendMail": "Y",
"DestinationChangesExistCancelAndRestart": "IC",
"InterfaceId": 5000,
"LanguageId": null,
"UsId": null,
}]}