Next Topic

Previous Topic

Book Contents

Get Scheduled Agent Procedures

Returns an array of agent procedure schedule records for a specified agent.

GET /automation/agentprocs/{agentId}/scheduledprocs

Headers

Model Schema

Field

Datatype

Filterable

Sortable

AgentProcedureId

int

AgentId

decimal

 

ServerTimeZone

boolean

SkipIfOffLine

boolean

 

PowerUpIfOffLine

boolean

ScriptPrompts

(see below)

 

 

Recurrence

(see below)

 

 

Distribution

(see below)

 

 

Start

(see below)

 

 

Exclusion

(see below)

 

 

Attributes

object

 

 

ScriptPrompts

Field

Datatype

Filterable

Sortable

Caption

string

 

 

Name

string

 

 

Value

string

 

 

RecurrenceOptions

See recurrence options values below.

Field

Datatype

Filterable

Sortable

Repeat

string

 

 

Times

int

 

 

DaysOfWeek

string

 

 

DayOfMonth

string

 

 

SpecificDayOfMonth

int

 

 

MonthOfYear

string

 

 

EndAt

string

 

 

EndOn

string

 

 

EndAfterIntervalTimes

int

 

 

DistributionWindow

Field

Datatype

Filterable

Sortable

Interval

string

 

 

Magnitude

int

 

 

StartOptions

Field

Datatype

Filterable

Sortable

StartOn

string

 

 

StartAt

string

 

 

ExclusionWindow

Field

Datatype

Filterable

Sortable

From

string

 

 

To

string

 

 

Recurrence Options Values

Repeat

Never

 

Minutes

 

Hours

 

Days

 

Weeks

 

Months

 

Years

 

 

DaysOfWeek

Sunday

 

Monday

 

Tuesday

 

Wednesday

 

Thursday

 

Friday

 

Saturday

 

 

DayOfMonth

FirstSunday

 

SecondSunday

 

ThirdSunday

 

FourthSunday

 

LastSunday

 

 

 

FirstMonday

 

SecondMonday

 

ThirdMonday

 

FourthMonday

 

LastMonday

 

 

 

FirstTuesday

 

SecondTuesday

 

ThirdTuesday

 

FourthTuesday

 

LastTuesday

 

 

 

FirstWednesday

 

SecondWednesday

 

ThirdWednesday

 

FourthWednesday

 

LastWednesday

 

 

 

FirstThursday

 

SecondThursday

 

ThirdThursday

 

FourthThursday

 

LastThursday

 

 

 

FirstFriday

 

SecondFriday

 

ThirdFriday

 

FourthFriday

 

LastFriday

 

 

 

FirstSaturday

 

SecondSaturday

 

ThirdSaturday

 

FourthSaturday

 

LastSaturday

 

 

 

FirstWeekDay

 

SecondWeekDay

 

ThirdWeekDay

 

FourthWeekDay

 

LastWeekDay

 

 

 

FirstWeekendDay

 

SecondWeekendDay

 

ThirdWeekendDay

 

FourthWeekendDay

 

LastWeekendDay

 

 

 

FirstDay

 

SecondDay

 

ThirdDay

 

FourthDay

 

LastDay

 

 

MonthOfYear

January

 

February

 

March

 

April

 

May

 

June

 

July

 

August

 

September

 

October

 

November

 

December

 

 

EndAt

T0000 to T2345 in increments of 15 minutes

 

Example: to specify 1:45 PM use T1345

 

 

EndOn

Example: 2017-04-27T15:59:59.809Z

Sample Response Model

"TotalRecords": 10, 
"Result": [ 
{ 
"AgentProcedureId": 269, 
"AgentProcedureName": "Patch Scan", 
"NextExecTime": "2017-07-27T17:22:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 week(s) on Thursday", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 228570284, 
"AgentProcedureName": "HtmlAgilityPack - File Dependencies", 
"NextExecTime": "2017-07-26T09:49:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 day(s)", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 265249185, 
"AgentProcedureName": "PSTerminalServices - File Dependencies", 
"NextExecTime": "2017-07-26T05:52:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 day(s)", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 848280032, 
"AgentProcedureName": "MongoDB - File Dependencies",
"NextExecTime": "2017-07-26T01:33:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 day(s)", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 1810882043, 
"AgentProcedureName": "ImportExcel - File Dependencies", 
"NextExecTime": "2017-07-26T07:31:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 day(s)", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 1943737719, 
"AgentProcedureName": "Newtonsoft - File Dependencies", 
"NextExecTime": "2017-07-26T09:07:00", 
"Status": "Script Summary: Success THEN", 
"Admin": "*System*", 
"Recurrence": "Every 1 day(s)", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 0, 
"AgentProcedureName": "Patch Automatic Update", 
"NextExecTime": "2017-07-27T16:25:00", 
"Status": null, 
"Admin": "system.monitoring@area9.com.au", 
"Recurrence": "Pending", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 135, 
"AgentProcedureName": "Baseline Audit", 
"NextExecTime": "2018-03-01T23:11:36", 
"Status": "Script Summary: Success THEN", 
"Admin": "system.monitoring@area9.com.au", 
"Recurrence": "Every 12 month(s) on the 1st Day", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 136, 
"AgentProcedureName": "Latest Audit", 
"NextExecTime": "2017-08-01T09:42:45", 
"Status": "Script Summary: Success THEN", 
"Admin": "system.monitoring@area9.com.au", 
"Recurrence": "Every 1 week(s) on Monday", 
"Attributes": null 
}, 
{ 
"AgentProcedureId": 137, 
"AgentProcedureName": "System Info", 
"NextExecTime": "2017-08-01T05:38:32", 
"Status": "Script Summary: Success THEN", 
"Admin": "system.monitoring@area9.com.au", 
"Recurrence": "Every 1 week(s) on Monday", 
"Attributes": null 
} 
], 
"ResponseCode": 0, 
"Status": "OK", 
"Error": "None"