Blackout Operations

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

Parameters No parameters

Response Messages

Response status code	Reason	Description
200		Response 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

Name	Type	Required	Description
id	guid[]	N	Blackout id. Update blackout if id provided and create new blackout if not provided
name	string	Y	Blackout name. Name should be unique in the client
startTime	DateTime	Y	Date and time the blackout starts
stopTime	DateTime	N	Date and time the blackout ends
targetHost	string	Y	Name of host for the blackout
isRecurring	bool	N(false)	Marks the blackout as a reoccurring event
recurrence	Recurrence object	N	Sets the recurrence frequency. See the section “Recurrences Explained” for more detail.

Response Messages

Response status code	Reason	Description
200		Response contains the list of blackouts
400	InvalidJsonSchema	Required parameters not provided
400	InvalidArguments	Data provided is not consistent
400	NameIsNotUnique	Blackout 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

Name	Type	Required	Description
blackoutIds	guid[]	Y	Blackout 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
}