Accessing scheduled operations data using the REST API – Help Center

The following is a description of functions to access scheduled operations ("scheduled works") data using the REST API.

Scheduled operations manipulation

GET https://apiserver/ws/rest/api/v19/scheduledworks/{idoperation}

Result: The response will contain actual data about the operation

Response example:

  {    
    "idscheduledwork": 123,
    "iddatabase":"1",
    "name":"My work"
}

GET https://apiserver/ws/rest/api/v19/scheduledworks/{idoperation}/trigger?delay=DELAY

Result: If the operation is active it will be triggered. The response will contain actual data about the operation

Query parameters

Key	Type	Description
delay	Integer	an optional delay to wait before starting the operation. The minimum value is 1

Response example:

{    
    "idscheduledwork": 123,
    "iddatabase":"1",
    "name":"My work"
}