Agent.GetSchedule
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Agent.GetSchedule

  • Dark
    Light
  • PDF

Article Summary

Description

Returns the run schedule previously set for an agent.

URL parameters

NameRequiredTypeDescription
AgentIDTruestringUnique identifier of an agent.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.
ScheduleScheduleInformation about the schedule.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetSchedule&AgentID=1001'

Sample responses

XML

<?xmlversion="1.0"encoding="utf-8"?>
<EXAMPLERESPONSE>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
</EXAMPLERESPONSE>

JSON (add &ResponseFormat=JSON)

{
  "ResponseObject": [

  ],
  "JsonResult": {
    "Command": "<Command>",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?