getAlert: Get an Alert

Description Usage Arguments Value

Description

This function returns a dataframe or json object of an Alert

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
getAlert(
  AlertID,
  CreatedTime = F,
  EndDate = F,
  Information = F,
  IsActive = F,
  IsCritical = F,
  ModifiedTime = F,
  StartDate = F,
  StudentID = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  fieldPaths = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

AlertID

The ID of the Alert to return.

fieldPaths

Fields from other objects with 'Many to One' or 'One to One' relationships to the given object listed as text. Run getSchemaForObjects('Alert') to get more field paths.

entityId

The id of the entity (school). Run listEntities for a list of entities. Defaults to 1 (district).

query

Queries to be added to the request. Ex. list(SchoolYearID = 1). Defaults to NULL.

flatten

Whether to flatten result into a dataframe or return the json object. Default is TRUE (flatten to dataframe).

returnResponse

Whether to return the server response instead of the results. Useful for debugging. Default is FALSE.

fieldNames

A TRUE or FALSE value determining whether or not to return the field for the given Alert. Defaults to FALSE for all return fields which, for convenience, returns all fields for the Alert.

Value

A dataframe or of Alert Skyward's Knowledge Hub


samterfa/rqmlativ documentation built on April 2, 2021, 12:03 p.m.