Blackout Operations

/AppSpiderEnterprise/rest/v1/Blackout/GetBlackouts Description Retrieves the blackout list for the client

Parameters No parameters

Response Messages

Response status codeReasonDescription
200Response contains the list of blackouts

Response example:

{ "type": "object", "properties": { "Blackouts": { "type":"array", "items": { "type":"object", "properties": { "Id": { "type":"string", "required": true }, "Name": { "type":"string", "required": true }, "StartTime": { "type":"string", "required": true }, "StopTime": { "type":["string", "null"], "required": true }, "NextOccurrence": { "type":["string", "null"], "required": true }, "LastOccurrence": { "type":["string", "null"], "required": true }, "TargetHost": { "type":"string", "required": true }, "IsRecurring": { "type": "boolean", "required": true }, "ClientId": { "type":"string", "required": true }, "Recurrence": { "type":["string", "null"], "properties": { "Id": { "type":"string", "required": true }, "End": { "type": ["string", "null"], "required": true }, "Type": { "type":"integer", "required": true }, "DduringWeekday": { "type":"integer", "required": true }, "Repeat": { "type": "integer", "required": true }, "DayNumber": { "type": "integer", "required": true }, "WeekOfMonth": { "type":"integer" "required": true }, "Month": { "type":"integer", "required": true }, "OccurrenceCount": { "type":"integer", "reuired": true }, "Range": { "type":"integer", "required": true } }, "required": true, "additionalProperties": false } }, "additionalProperties": false } }, "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string","null"], "required": true }, "Reason": { "type":["string","null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Blackout/SaveBlackout Description Creates or updates a blackout window

Parameters

NameTypeRequiredDescription
idguid[]NBlackout id. Update blackout if id provided and create new blackout if not provided
namestringYBlackout name. Name should be unique in the client
startTimeDateTimeYDate and time the blackout starts
stopTimeDateTimeNDate and time the blackout ends
targetHoststringYName of host for the blackout
isRecurringboolN(false)Marks the blackout as a reoccurring event
recurrenceRecurrence objectNSets the recurrence frequency. See the section “Recurrences Explained” for more detail.

Response Messages

Response status codeReasonDescription
200Response contains the list of blackouts
400InvalidJsonSchemaRequired parameters not provided
400InvalidArgumentsData provided is not consistent
400NameIsNotUniqueBlackout name is not unique in the client

Response example:

{ "type": "object", "properties": { "Blackouts": { "type":"array", "items": { "type":"object", "properties": { "Id": { "type":"string", "required": true }, "Name": { "type":"string", "required": true }, "StartTime": { "type":"string", "required": true }, "StopTime": { "type":["string", "null"], "required": true }, "NextOccurrence": { "type":["string", "null"], "required": true }, "LastOccurrence": { "type":["string", "null"], "required": true }, "TargetHost": { "type":"string", "required": true }, "IsRecurring": { "type": "boolean", "required": true }, "ClientId": { "type":"string", "required": true }, "Recurrence": { "type":["string", "null"], "properties": { "Id": { "type":"string", "required": true }, "End": { "type": ["string", "null"], "required": true }, "Type": { "type":"integer", "required": true }, "DduringWeekday": { "type":"integer", "required": true }, "Repeat": { "type": "integer", "required": true }, "DayNumber": { "type": "integer", "required": true }, "WeekOfMonth": { "type":"integer" "required": true }, "Month": { "type":"integer", "required": true }, "OccurrenceCount": { "type":"integer", "reuired": true }, "Range": { "type":"integer", "required": true } }, "required": true, "additionalProperties": false } }, "additionalProperties": false } }, "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string","null"], "required": true }, "Reason": { "type":["string","null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/Blackout/DeleteBlackouts Description Removes a blackout window

Parameters

NameTypeRequiredDescription
blackoutIdsguid[]YBlackout IDs

Response example:

{ "type":"object", "properties": { "IsSuccess": { "type":"boolean", "required": true }, "ErrorMessage": { "type":["string", "null"], "required": true }, "Reason": { "type":["string", "null"], "required": true } }, "additionalProperties": false }