Schedule Agent Procedure

Schedules an agent procedure for a single agent. When the request is valid, returns a 204 No Content response. When the request is invalid, returns a 404 Not Found response. This occurs when :

The supplied {agentProcedureId} does not exist.
The supplied {agentProcedureId} is any system script other then Audit scripts 135, 136 or 137.

The user does not have 'execute' permission in the {agentProcedureId}'s folder security settings.

PUT /automation/agentprocs/{agentId}/{agentProcedureId}/schedule

Does not accept filter and sort expressions.
This is an action API; no business data is returned or changed.

Headers

Authorization: Bearer {hash string returned from Authentication}

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

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`

Sample Request Model

  "ServerTimeZone": true,

  "SkipIfOffLine": true,

  "PowerUpIfOffLine": true,

  "ScriptPrompts": [

      "Caption": "string",

      "Name": "string",

      "Value": "string"

],

  "Recurrence": {

    "Repeat": "Never",

    "Times": 0,

    "DaysOfWeek": "string",

    "DayOfMonth": "FirstSunday",

    "SpecificDayOfMonth": 0,

    "MonthOfYear": "January",

    "EndAt": "T0000",

    "EndOn": "2016-02-05T21:02:56.650Z",

    "EndAfterIntervalTimes": 0

},

  "Distribution": {

    "Interval": "Minutes",

    "Magnitude": 0

},

  "Start": {

    "StartOn": "2016-02-05T21:02:56.650Z",

    "StartAt": "T0000"

},

  "Exclusion": {

    "From": "T0000",

    "To": "T0000"

},

  "Attributes": {}