Add Scheduled Jobs - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

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

UsId

User ID

String

Required

LanguageId

Language ID

Number

Required

TransferJobId

Unique ID for Transfer Job

Integer

Required

IbsQueue

Queue in Intergraph Batch Manager

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

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

{

"UsId":"5921",

"LanguageId":"5000",

"TransferJobId":56415,

"IbsQueue":"SRDPlusQueue1",

"ScheduledTime":"2019-11-01T19:27:38.7542991+05:30" ,

"ExecuteJobInCaseIfPathsAreWriteProtected":"N",

"ContinueIfSymbolsMissing":"N",

"ContinueIfDisusedCommodityCodesExist":"N",

"ContinueIfInterfaceVersionMissingInDestination":"Y",

"SendMail":"Y",

"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

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/$entity",

"ScheduledJobId": 6311,

"TransferJobId": 56415,

"Project": "SDB",

"IbsQueue": "SRDPlusQueue1",

"ScheduledTime": "2019-11-01T19:27:38.7542991+05:30",

"ExecuteJobInCaseIfPathsAreWriteProtected": "N",

"ContinueIfSymbolsMissing": "N",

"ContinueIfDisusedCommodityCodesExist": "N",

"ContinueIfInterfaceVersionMissingInDestination": "Y",

"SendMail": "Y",

"DestinationChangesExistCancelAndRestart": "IC",

"InterfaceId": 5000,

"LanguageId": "5000",

"UsId": "5921",

}