#' Get all ApplySchemaChangeAllChangesConfirmations.
#'
#' This function returns a dataframe of all ApplySchemaChangeAllChangesConfirmations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ApplySchemaChangeAllChangesConfirmations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllApplySchemaChangeAllChangesConfirmations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnApplySchemaChangeAllChangesConfirmationID = F, returnApplySchemaChangeRunID = F, returnChangeType = F, returnCreatedTime = F, returnFieldID = F, returnFieldPendingName = F, returnModifiedTime = F, returnModuleID = F, returnModulePendingName = F, returnObjectID = F, returnObjectPendingName = F, returnRelationshipID = F, returnRelationshipPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ApplySchemaChangeAllChangesConfirmation", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ApplySchemaChangeAllChangesConfirmation
#'
#' This function returns fields for an ApplySchemaChangeAllChangesConfirmation.
#'
#' @param ApplySchemaChangeAllChangesConfirmationID The id of the ApplySchemaChangeAllChangesConfirmation.\cr Run \code{\link{getAllApplySchemaChangeAllChangesConfirmations}} for a list of ApplySchemaChangeAllChangesConfirmations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ApplySchemaChangeAllChangesConfirmation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getApplySchemaChangeAllChangesConfirmation <- function(ApplySchemaChangeAllChangesConfirmationID, EntityID = 1, returnApplySchemaChangeAllChangesConfirmationID = F, returnApplySchemaChangeRunID = F, returnChangeType = F, returnCreatedTime = F, returnFieldID = F, returnFieldPendingName = F, returnModifiedTime = F, returnModuleID = F, returnModulePendingName = F, returnObjectID = F, returnObjectPendingName = F, returnRelationshipID = F, returnRelationshipPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ApplySchemaChangeAllChangesConfirmation", ApplySchemaChangeAllChangesConfirmationID, searchFields, EntityID)
}
#' Modify a specific ApplySchemaChangeAllChangesConfirmation
#'
#' This function modifies fields for an ApplySchemaChangeAllChangesConfirmation.
#'
#' @param ApplySchemaChangeAllChangesConfirmationID The id of the ApplySchemaChangeAllChangesConfirmation to be modified.\cr Run \code{\link{getAllApplySchemaChangeAllChangesConfirmations}} for a list of ApplySchemaChangeAllChangesConfirmations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ApplySchemaChangeAllChangesConfirmation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyApplySchemaChangeAllChangesConfirmation <- function(ApplySchemaChangeAllChangesConfirmationID, EntityID = 1, setApplySchemaChangeRunID = NULL, setChangeType = NULL, setFieldID = NULL, setFieldPendingName = NULL, setModuleID = NULL, setModulePendingName = NULL, setObjectID = NULL, setObjectPendingName = NULL, setRelationshipID = NULL, setRelationshipPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ApplySchemaChangeAllChangesConfirmation", ApplySchemaChangeAllChangesConfirmationID, names(functionParams), functionParams, EntityID)
}
#' Create new ApplySchemaChangeAllChangesConfirmation.
#'
#' This function creates a new ApplySchemaChangeAllChangesConfirmation.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ApplySchemaChangeAllChangesConfirmation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createApplySchemaChangeAllChangesConfirmation <- function(EntityID = 1, setApplySchemaChangeRunID = NULL, setChangeType = NULL, setFieldID = NULL, setFieldPendingName = NULL, setModuleID = NULL, setModulePendingName = NULL, setObjectID = NULL, setObjectPendingName = NULL, setRelationshipID = NULL, setRelationshipPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ApplySchemaChangeAllChangesConfirmation", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ApplySchemaChangeAllChangesConfirmation
#'
#' This function deletes an ApplySchemaChangeAllChangesConfirmation.
#'
#' @param ApplySchemaChangeAllChangesConfirmationID The id of the ApplySchemaChangeAllChangesConfirmation.\cr Run \code{\link{getAllApplySchemaChangeAllChangesConfirmations}} for a list of ApplySchemaChangeAllChangesConfirmations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ApplySchemaChangeAllChangesConfirmation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteApplySchemaChangeAllChangesConfirmation <- function(ApplySchemaChangeAllChangesConfirmationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ApplySchemaChangeAllChangesConfirmation", ApplySchemaChangeAllChangesConfirmationID, EntityID)
}
#' Get all ApplySchemaChangeFieldSelections.
#'
#' This function returns a dataframe of all ApplySchemaChangeFieldSelections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ApplySchemaChangeFieldSelections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllApplySchemaChangeFieldSelections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnApplySchemaChangeFieldSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnFieldChangeType = F, returnFieldCurrentName = F, returnFieldHasChangedRelationships = F, returnFieldID = F, returnFieldPendingName = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ApplySchemaChangeFieldSelection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ApplySchemaChangeFieldSelection
#'
#' This function returns fields for an ApplySchemaChangeFieldSelection.
#'
#' @param ApplySchemaChangeFieldSelectionID The id of the ApplySchemaChangeFieldSelection.\cr Run \code{\link{getAllApplySchemaChangeFieldSelections}} for a list of ApplySchemaChangeFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ApplySchemaChangeFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getApplySchemaChangeFieldSelection <- function(ApplySchemaChangeFieldSelectionID, EntityID = 1, returnApplySchemaChangeFieldSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnFieldChangeType = F, returnFieldCurrentName = F, returnFieldHasChangedRelationships = F, returnFieldID = F, returnFieldPendingName = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ApplySchemaChangeFieldSelection", ApplySchemaChangeFieldSelectionID, searchFields, EntityID)
}
#' Modify a specific ApplySchemaChangeFieldSelection
#'
#' This function modifies fields for an ApplySchemaChangeFieldSelection.
#'
#' @param ApplySchemaChangeFieldSelectionID The id of the ApplySchemaChangeFieldSelection to be modified.\cr Run \code{\link{getAllApplySchemaChangeFieldSelections}} for a list of ApplySchemaChangeFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ApplySchemaChangeFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyApplySchemaChangeFieldSelection <- function(ApplySchemaChangeFieldSelectionID, EntityID = 1, setApplySchemaChangeRunID = NULL, setFieldChangeType = NULL, setFieldCurrentName = NULL, setFieldHasChangedRelationships = NULL, setFieldID = NULL, setFieldPendingName = NULL, setModulePendingName = NULL, setObjectPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ApplySchemaChangeFieldSelection", ApplySchemaChangeFieldSelectionID, names(functionParams), functionParams, EntityID)
}
#' Create new ApplySchemaChangeFieldSelection.
#'
#' This function creates a new ApplySchemaChangeFieldSelection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ApplySchemaChangeFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createApplySchemaChangeFieldSelection <- function(EntityID = 1, setApplySchemaChangeRunID = NULL, setFieldChangeType = NULL, setFieldCurrentName = NULL, setFieldHasChangedRelationships = NULL, setFieldID = NULL, setFieldPendingName = NULL, setModulePendingName = NULL, setObjectPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ApplySchemaChangeFieldSelection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ApplySchemaChangeFieldSelection
#'
#' This function deletes an ApplySchemaChangeFieldSelection.
#'
#' @param ApplySchemaChangeFieldSelectionID The id of the ApplySchemaChangeFieldSelection.\cr Run \code{\link{getAllApplySchemaChangeFieldSelections}} for a list of ApplySchemaChangeFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ApplySchemaChangeFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteApplySchemaChangeFieldSelection <- function(ApplySchemaChangeFieldSelectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ApplySchemaChangeFieldSelection", ApplySchemaChangeFieldSelectionID, EntityID)
}
#' Get all ApplySchemaChangeObjectSelections.
#'
#' This function returns a dataframe of all ApplySchemaChangeObjectSelections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ApplySchemaChangeObjectSelections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllApplySchemaChangeObjectSelections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnApplySchemaChangeObjectSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectChangeType = F, returnObjectCurrentName = F, returnObjectHasChangedFields = F, returnObjectHasChangedRelationships = F, returnObjectID = F, returnObjectPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ApplySchemaChangeObjectSelection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ApplySchemaChangeObjectSelection
#'
#' This function returns fields for an ApplySchemaChangeObjectSelection.
#'
#' @param ApplySchemaChangeObjectSelectionID The id of the ApplySchemaChangeObjectSelection.\cr Run \code{\link{getAllApplySchemaChangeObjectSelections}} for a list of ApplySchemaChangeObjectSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ApplySchemaChangeObjectSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getApplySchemaChangeObjectSelection <- function(ApplySchemaChangeObjectSelectionID, EntityID = 1, returnApplySchemaChangeObjectSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectChangeType = F, returnObjectCurrentName = F, returnObjectHasChangedFields = F, returnObjectHasChangedRelationships = F, returnObjectID = F, returnObjectPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ApplySchemaChangeObjectSelection", ApplySchemaChangeObjectSelectionID, searchFields, EntityID)
}
#' Modify a specific ApplySchemaChangeObjectSelection
#'
#' This function modifies fields for an ApplySchemaChangeObjectSelection.
#'
#' @param ApplySchemaChangeObjectSelectionID The id of the ApplySchemaChangeObjectSelection to be modified.\cr Run \code{\link{getAllApplySchemaChangeObjectSelections}} for a list of ApplySchemaChangeObjectSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ApplySchemaChangeObjectSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyApplySchemaChangeObjectSelection <- function(ApplySchemaChangeObjectSelectionID, EntityID = 1, setApplySchemaChangeRunID = NULL, setModulePendingName = NULL, setObjectChangeType = NULL, setObjectCurrentName = NULL, setObjectHasChangedFields = NULL, setObjectHasChangedRelationships = NULL, setObjectID = NULL, setObjectPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ApplySchemaChangeObjectSelection", ApplySchemaChangeObjectSelectionID, names(functionParams), functionParams, EntityID)
}
#' Create new ApplySchemaChangeObjectSelection.
#'
#' This function creates a new ApplySchemaChangeObjectSelection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ApplySchemaChangeObjectSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createApplySchemaChangeObjectSelection <- function(EntityID = 1, setApplySchemaChangeRunID = NULL, setModulePendingName = NULL, setObjectChangeType = NULL, setObjectCurrentName = NULL, setObjectHasChangedFields = NULL, setObjectHasChangedRelationships = NULL, setObjectID = NULL, setObjectPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ApplySchemaChangeObjectSelection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ApplySchemaChangeObjectSelection
#'
#' This function deletes an ApplySchemaChangeObjectSelection.
#'
#' @param ApplySchemaChangeObjectSelectionID The id of the ApplySchemaChangeObjectSelection.\cr Run \code{\link{getAllApplySchemaChangeObjectSelections}} for a list of ApplySchemaChangeObjectSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ApplySchemaChangeObjectSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteApplySchemaChangeObjectSelection <- function(ApplySchemaChangeObjectSelectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ApplySchemaChangeObjectSelection", ApplySchemaChangeObjectSelectionID, EntityID)
}
#' Get all ApplySchemaChangeRelationshipSelections.
#'
#' This function returns a dataframe of all ApplySchemaChangeRelationshipSelections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ApplySchemaChangeRelationshipSelections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllApplySchemaChangeRelationshipSelections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnApplySchemaChangeRelationshipSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnFieldPendingName = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectPendingName = F, returnRelationshipChangeType = F, returnRelationshipCurrentName = F, returnRelationshipID = F, returnRelationshipPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ApplySchemaChangeRelationshipSelection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ApplySchemaChangeRelationshipSelection
#'
#' This function returns fields for an ApplySchemaChangeRelationshipSelection.
#'
#' @param ApplySchemaChangeRelationshipSelectionID The id of the ApplySchemaChangeRelationshipSelection.\cr Run \code{\link{getAllApplySchemaChangeRelationshipSelections}} for a list of ApplySchemaChangeRelationshipSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ApplySchemaChangeRelationshipSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getApplySchemaChangeRelationshipSelection <- function(ApplySchemaChangeRelationshipSelectionID, EntityID = 1, returnApplySchemaChangeRelationshipSelectionID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnFieldPendingName = F, returnModifiedTime = F, returnModulePendingName = F, returnObjectPendingName = F, returnRelationshipChangeType = F, returnRelationshipCurrentName = F, returnRelationshipID = F, returnRelationshipPendingName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ApplySchemaChangeRelationshipSelection", ApplySchemaChangeRelationshipSelectionID, searchFields, EntityID)
}
#' Modify a specific ApplySchemaChangeRelationshipSelection
#'
#' This function modifies fields for an ApplySchemaChangeRelationshipSelection.
#'
#' @param ApplySchemaChangeRelationshipSelectionID The id of the ApplySchemaChangeRelationshipSelection to be modified.\cr Run \code{\link{getAllApplySchemaChangeRelationshipSelections}} for a list of ApplySchemaChangeRelationshipSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ApplySchemaChangeRelationshipSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyApplySchemaChangeRelationshipSelection <- function(ApplySchemaChangeRelationshipSelectionID, EntityID = 1, setApplySchemaChangeRunID = NULL, setFieldPendingName = NULL, setModulePendingName = NULL, setObjectPendingName = NULL, setRelationshipChangeType = NULL, setRelationshipCurrentName = NULL, setRelationshipID = NULL, setRelationshipPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ApplySchemaChangeRelationshipSelection", ApplySchemaChangeRelationshipSelectionID, names(functionParams), functionParams, EntityID)
}
#' Create new ApplySchemaChangeRelationshipSelection.
#'
#' This function creates a new ApplySchemaChangeRelationshipSelection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ApplySchemaChangeRelationshipSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createApplySchemaChangeRelationshipSelection <- function(EntityID = 1, setApplySchemaChangeRunID = NULL, setFieldPendingName = NULL, setModulePendingName = NULL, setObjectPendingName = NULL, setRelationshipChangeType = NULL, setRelationshipCurrentName = NULL, setRelationshipID = NULL, setRelationshipPendingName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ApplySchemaChangeRelationshipSelection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ApplySchemaChangeRelationshipSelection
#'
#' This function deletes an ApplySchemaChangeRelationshipSelection.
#'
#' @param ApplySchemaChangeRelationshipSelectionID The id of the ApplySchemaChangeRelationshipSelection.\cr Run \code{\link{getAllApplySchemaChangeRelationshipSelections}} for a list of ApplySchemaChangeRelationshipSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ApplySchemaChangeRelationshipSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteApplySchemaChangeRelationshipSelection <- function(ApplySchemaChangeRelationshipSelectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ApplySchemaChangeRelationshipSelection", ApplySchemaChangeRelationshipSelectionID, EntityID)
}
#' Get all ApplySchemaChangeRuns.
#'
#' This function returns a dataframe of all ApplySchemaChangeRuns in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ApplySchemaChangeRuns in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllApplySchemaChangeRuns <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnExecutedTime = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ApplySchemaChangeRun", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ApplySchemaChangeRun
#'
#' This function returns fields for an ApplySchemaChangeRun.
#'
#' @param ApplySchemaChangeRunID The id of the ApplySchemaChangeRun.\cr Run \code{\link{getAllApplySchemaChangeRuns}} for a list of ApplySchemaChangeRuns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ApplySchemaChangeRun.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getApplySchemaChangeRun <- function(ApplySchemaChangeRunID, EntityID = 1, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnExecutedTime = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ApplySchemaChangeRun", ApplySchemaChangeRunID, searchFields, EntityID)
}
#' Modify a specific ApplySchemaChangeRun
#'
#' This function modifies fields for an ApplySchemaChangeRun.
#'
#' @param ApplySchemaChangeRunID The id of the ApplySchemaChangeRun to be modified.\cr Run \code{\link{getAllApplySchemaChangeRuns}} for a list of ApplySchemaChangeRuns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ApplySchemaChangeRun.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyApplySchemaChangeRun <- function(ApplySchemaChangeRunID, EntityID = 1, setExecutedTime = NULL, setStatus = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ApplySchemaChangeRun", ApplySchemaChangeRunID, names(functionParams), functionParams, EntityID)
}
#' Create new ApplySchemaChangeRun.
#'
#' This function creates a new ApplySchemaChangeRun.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ApplySchemaChangeRun.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createApplySchemaChangeRun <- function(EntityID = 1, setExecutedTime = NULL, setStatus = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ApplySchemaChangeRun", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ApplySchemaChangeRun
#'
#' This function deletes an ApplySchemaChangeRun.
#'
#' @param ApplySchemaChangeRunID The id of the ApplySchemaChangeRun.\cr Run \code{\link{getAllApplySchemaChangeRuns}} for a list of ApplySchemaChangeRuns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ApplySchemaChangeRun.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteApplySchemaChangeRun <- function(ApplySchemaChangeRunID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ApplySchemaChangeRun", ApplySchemaChangeRunID, EntityID)
}
#' Get all Attachments.
#'
#' This function returns a dataframe of all Attachments in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Attachments in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAttachments <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAttachmentID = F, returnAttachmentTypeID = F, returnComment = F, returnCreatedTime = F, returnCurrentUserCanReadAttachmentsOfThisAttachmentType = F, returnMediaID = F, returnModifiedTime = F, returnObjectID = F, returnSourceID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Attachment", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Attachment
#'
#' This function returns fields for an Attachment.
#'
#' @param AttachmentID The id of the Attachment.\cr Run \code{\link{getAllAttachments}} for a list of Attachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Attachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAttachment <- function(AttachmentID, EntityID = 1, returnAttachmentID = F, returnAttachmentTypeID = F, returnComment = F, returnCreatedTime = F, returnCurrentUserCanReadAttachmentsOfThisAttachmentType = F, returnMediaID = F, returnModifiedTime = F, returnObjectID = F, returnSourceID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Attachment", AttachmentID, searchFields, EntityID)
}
#' Modify a specific Attachment
#'
#' This function modifies fields for an Attachment.
#'
#' @param AttachmentID The id of the Attachment to be modified.\cr Run \code{\link{getAllAttachments}} for a list of Attachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Attachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAttachment <- function(AttachmentID, EntityID = 1, setAttachmentTypeID = NULL, setComment = NULL, setMediaID = NULL, setObjectID = NULL, setSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Attachment", AttachmentID, names(functionParams), functionParams, EntityID)
}
#' Create new Attachment.
#'
#' This function creates a new Attachment.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Attachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAttachment <- function(EntityID = 1, setAttachmentTypeID = NULL, setComment = NULL, setMediaID = NULL, setObjectID = NULL, setSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Attachment", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Attachment
#'
#' This function deletes an Attachment.
#'
#' @param AttachmentID The id of the Attachment.\cr Run \code{\link{getAllAttachments}} for a list of Attachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Attachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAttachment <- function(AttachmentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Attachment", AttachmentID, EntityID)
}
#' Get all AttachmentTypes.
#'
#' This function returns a dataframe of all AttachmentTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All AttachmentTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAttachmentTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAttachmentTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurrentUserCanCreateAttachmentsOfThisAttachmentType = F, returnCustomizationID = F, returnDescription = F, returnEffectiveIsDefault = F, returnEffectiveShowInActivityAccess = F, returnEffectiveShowInAdministrativeAccess = F, returnEffectiveShowInEmployeeAccess = F, returnEffectiveShowInFamilyAccess = F, returnEffectiveShowInNewStudentEnrollment = F, returnEffectiveShowInStudentAccess = F, returnEffectiveShowInStudentServices = F, returnEffectiveShowInTeacherAccess = F, returnIncludeWithEmail = F, returnIsDefault = F, returnModifiedTime = F, returnObjectID = F, returnShowInActivityAccess = F, returnShowInAdministrativeAccess = F, returnShowInEmployeeAccess = F, returnShowInFamilyAccess = F, returnShowInNewStudentEnrollment = F, returnShowInStudentAccess = F, returnShowInStudentServices = F, returnShowInTeacherAccess = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSkywardShowInActivityAccess = F, returnSkywardShowInAdministrativeAccess = F, returnSkywardShowInEmployeeAccess = F, returnSkywardShowInFamilyAccess = F, returnSkywardShowInNewStudentEnrollment = F, returnSkywardShowInStudentAccess = F, returnSkywardShowInStudentServices = F, returnSkywardShowInTeacherAccess = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "AttachmentType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AttachmentType
#'
#' This function returns fields for an AttachmentType.
#'
#' @param AttachmentTypeID The id of the AttachmentType.\cr Run \code{\link{getAllAttachmentTypes}} for a list of AttachmentTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the AttachmentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAttachmentType <- function(AttachmentTypeID, EntityID = 1, returnAttachmentTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurrentUserCanCreateAttachmentsOfThisAttachmentType = F, returnCustomizationID = F, returnDescription = F, returnEffectiveIsDefault = F, returnEffectiveShowInActivityAccess = F, returnEffectiveShowInAdministrativeAccess = F, returnEffectiveShowInEmployeeAccess = F, returnEffectiveShowInFamilyAccess = F, returnEffectiveShowInNewStudentEnrollment = F, returnEffectiveShowInStudentAccess = F, returnEffectiveShowInStudentServices = F, returnEffectiveShowInTeacherAccess = F, returnIncludeWithEmail = F, returnIsDefault = F, returnModifiedTime = F, returnObjectID = F, returnShowInActivityAccess = F, returnShowInAdministrativeAccess = F, returnShowInEmployeeAccess = F, returnShowInFamilyAccess = F, returnShowInNewStudentEnrollment = F, returnShowInStudentAccess = F, returnShowInStudentServices = F, returnShowInTeacherAccess = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSkywardShowInActivityAccess = F, returnSkywardShowInAdministrativeAccess = F, returnSkywardShowInEmployeeAccess = F, returnSkywardShowInFamilyAccess = F, returnSkywardShowInNewStudentEnrollment = F, returnSkywardShowInStudentAccess = F, returnSkywardShowInStudentServices = F, returnSkywardShowInTeacherAccess = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "AttachmentType", AttachmentTypeID, searchFields, EntityID)
}
#' Modify a specific AttachmentType
#'
#' This function modifies fields for an AttachmentType.
#'
#' @param AttachmentTypeID The id of the AttachmentType to be modified.\cr Run \code{\link{getAllAttachmentTypes}} for a list of AttachmentTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified AttachmentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAttachmentType <- function(AttachmentTypeID, EntityID = 1, setCode = NULL, setCustomizationID = NULL, setDescription = NULL, setIncludeWithEmail = NULL, setIsDefault = NULL, setObjectID = NULL, setShowInActivityAccess = NULL, setShowInAdministrativeAccess = NULL, setShowInEmployeeAccess = NULL, setShowInFamilyAccess = NULL, setShowInNewStudentEnrollment = NULL, setShowInStudentAccess = NULL, setShowInStudentServices = NULL, setShowInTeacherAccess = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setSkywardShowInActivityAccess = NULL, setSkywardShowInAdministrativeAccess = NULL, setSkywardShowInEmployeeAccess = NULL, setSkywardShowInFamilyAccess = NULL, setSkywardShowInNewStudentEnrollment = NULL, setSkywardShowInStudentAccess = NULL, setSkywardShowInStudentServices = NULL, setSkywardShowInTeacherAccess = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "AttachmentType", AttachmentTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new AttachmentType.
#'
#' This function creates a new AttachmentType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created AttachmentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAttachmentType <- function(EntityID = 1, setCode = NULL, setCustomizationID = NULL, setDescription = NULL, setIncludeWithEmail = NULL, setIsDefault = NULL, setObjectID = NULL, setShowInActivityAccess = NULL, setShowInAdministrativeAccess = NULL, setShowInEmployeeAccess = NULL, setShowInFamilyAccess = NULL, setShowInNewStudentEnrollment = NULL, setShowInStudentAccess = NULL, setShowInStudentServices = NULL, setShowInTeacherAccess = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setSkywardShowInActivityAccess = NULL, setSkywardShowInAdministrativeAccess = NULL, setSkywardShowInEmployeeAccess = NULL, setSkywardShowInFamilyAccess = NULL, setSkywardShowInNewStudentEnrollment = NULL, setSkywardShowInStudentAccess = NULL, setSkywardShowInStudentServices = NULL, setSkywardShowInTeacherAccess = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "AttachmentType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AttachmentType
#'
#' This function deletes an AttachmentType.
#'
#' @param AttachmentTypeID The id of the AttachmentType.\cr Run \code{\link{getAllAttachmentTypes}} for a list of AttachmentTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted AttachmentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAttachmentType <- function(AttachmentTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "AttachmentType", AttachmentTypeID, EntityID)
}
#' Get all BenchmarkingQuestions.
#'
#' This function returns a dataframe of all BenchmarkingQuestions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingQuestions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingQuestions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingQuestionID = F, returnCreatedTime = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnText = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingQuestion", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingQuestion
#'
#' This function returns fields for a BenchmarkingQuestion.
#'
#' @param BenchmarkingQuestionID The id of the BenchmarkingQuestion.\cr Run \code{\link{getAllBenchmarkingQuestions}} for a list of BenchmarkingQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingQuestion <- function(BenchmarkingQuestionID, EntityID = 1, returnBenchmarkingQuestionID = F, returnCreatedTime = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnText = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingQuestion", BenchmarkingQuestionID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingQuestion
#'
#' This function modifies fields for a BenchmarkingQuestion.
#'
#' @param BenchmarkingQuestionID The id of the BenchmarkingQuestion to be modified.\cr Run \code{\link{getAllBenchmarkingQuestions}} for a list of BenchmarkingQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingQuestion <- function(BenchmarkingQuestionID, EntityID = 1, setSkywardHash = NULL, setSkywardID = NULL, setText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingQuestion", BenchmarkingQuestionID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingQuestion.
#'
#' This function creates a new BenchmarkingQuestion.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingQuestion <- function(EntityID = 1, setSkywardHash = NULL, setSkywardID = NULL, setText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingQuestion", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingQuestion
#'
#' This function deletes a BenchmarkingQuestion.
#'
#' @param BenchmarkingQuestionID The id of the BenchmarkingQuestion.\cr Run \code{\link{getAllBenchmarkingQuestions}} for a list of BenchmarkingQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingQuestion <- function(BenchmarkingQuestionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingQuestion", BenchmarkingQuestionID, EntityID)
}
#' Get all BenchmarkingQuestionAnswers.
#'
#' This function returns a dataframe of all BenchmarkingQuestionAnswers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingQuestionAnswers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingQuestionAnswers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingQuestionAnswerID = F, returnBenchmarkingQuestionID = F, returnBenchmarkingSurveyInstanceID = F, returnComment = F, returnCreatedTime = F, returnModifiedTime = F, returnNumericValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingQuestionAnswer", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingQuestionAnswer
#'
#' This function returns fields for a BenchmarkingQuestionAnswer.
#'
#' @param BenchmarkingQuestionAnswerID The id of the BenchmarkingQuestionAnswer.\cr Run \code{\link{getAllBenchmarkingQuestionAnswers}} for a list of BenchmarkingQuestionAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingQuestionAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingQuestionAnswer <- function(BenchmarkingQuestionAnswerID, EntityID = 1, returnBenchmarkingQuestionAnswerID = F, returnBenchmarkingQuestionID = F, returnBenchmarkingSurveyInstanceID = F, returnComment = F, returnCreatedTime = F, returnModifiedTime = F, returnNumericValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingQuestionAnswer", BenchmarkingQuestionAnswerID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingQuestionAnswer
#'
#' This function modifies fields for a BenchmarkingQuestionAnswer.
#'
#' @param BenchmarkingQuestionAnswerID The id of the BenchmarkingQuestionAnswer to be modified.\cr Run \code{\link{getAllBenchmarkingQuestionAnswers}} for a list of BenchmarkingQuestionAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingQuestionAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingQuestionAnswer <- function(BenchmarkingQuestionAnswerID, EntityID = 1, setBenchmarkingQuestionID = NULL, setBenchmarkingSurveyInstanceID = NULL, setComment = NULL, setNumericValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingQuestionAnswer", BenchmarkingQuestionAnswerID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingQuestionAnswer.
#'
#' This function creates a new BenchmarkingQuestionAnswer.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingQuestionAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingQuestionAnswer <- function(EntityID = 1, setBenchmarkingQuestionID = NULL, setBenchmarkingSurveyInstanceID = NULL, setComment = NULL, setNumericValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingQuestionAnswer", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingQuestionAnswer
#'
#' This function deletes a BenchmarkingQuestionAnswer.
#'
#' @param BenchmarkingQuestionAnswerID The id of the BenchmarkingQuestionAnswer.\cr Run \code{\link{getAllBenchmarkingQuestionAnswers}} for a list of BenchmarkingQuestionAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingQuestionAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingQuestionAnswer <- function(BenchmarkingQuestionAnswerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingQuestionAnswer", BenchmarkingQuestionAnswerID, EntityID)
}
#' Get all BenchmarkingSurveies.
#'
#' This function returns a dataframe of all BenchmarkingSurveies in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingSurveies in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingSurveies <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingSurveyID = F, returnBannerMessage = F, returnCreatedTime = F, returnEndTime = F, returnHeaderMessage = F, returnModifiedTime = F, returnSecurityLocationID = F, returnSkywardHash = F, returnSkywardID = F, returnStartTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingSurvey", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingSurvey
#'
#' This function returns fields for a BenchmarkingSurvey.
#'
#' @param BenchmarkingSurveyID The id of the BenchmarkingSurvey.\cr Run \code{\link{getAllBenchmarkingSurveies}} for a list of BenchmarkingSurveies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingSurvey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingSurvey <- function(BenchmarkingSurveyID, EntityID = 1, returnBenchmarkingSurveyID = F, returnBannerMessage = F, returnCreatedTime = F, returnEndTime = F, returnHeaderMessage = F, returnModifiedTime = F, returnSecurityLocationID = F, returnSkywardHash = F, returnSkywardID = F, returnStartTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingSurvey", BenchmarkingSurveyID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingSurvey
#'
#' This function modifies fields for a BenchmarkingSurvey.
#'
#' @param BenchmarkingSurveyID The id of the BenchmarkingSurvey to be modified.\cr Run \code{\link{getAllBenchmarkingSurveies}} for a list of BenchmarkingSurveys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingSurvey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingSurvey <- function(BenchmarkingSurveyID, EntityID = 1, setBannerMessage = NULL, setEndTime = NULL, setHeaderMessage = NULL, setSecurityLocationID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStartTime = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingSurvey", BenchmarkingSurveyID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingSurvey.
#'
#' This function creates a new BenchmarkingSurvey.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingSurvey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingSurvey <- function(EntityID = 1, setBannerMessage = NULL, setEndTime = NULL, setHeaderMessage = NULL, setSecurityLocationID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStartTime = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingSurvey", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingSurvey
#'
#' This function deletes a BenchmarkingSurvey.
#'
#' @param BenchmarkingSurveyID The id of the BenchmarkingSurvey.\cr Run \code{\link{getAllBenchmarkingSurveies}} for a list of BenchmarkingSurveies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingSurvey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingSurvey <- function(BenchmarkingSurveyID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingSurvey", BenchmarkingSurveyID, EntityID)
}
#' Get all BenchmarkingSurveyDelaies.
#'
#' This function returns a dataframe of all BenchmarkingSurveyDelaies in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingSurveyDelaies in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingSurveyDelaies <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingSurveyDelayID = F, returnBenchmarkingSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnResumeTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingSurveyDelay", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingSurveyDelay
#'
#' This function returns fields for a BenchmarkingSurveyDelay.
#'
#' @param BenchmarkingSurveyDelayID The id of the BenchmarkingSurveyDelay.\cr Run \code{\link{getAllBenchmarkingSurveyDelaies}} for a list of BenchmarkingSurveyDelaies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingSurveyDelay.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingSurveyDelay <- function(BenchmarkingSurveyDelayID, EntityID = 1, returnBenchmarkingSurveyDelayID = F, returnBenchmarkingSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnResumeTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingSurveyDelay", BenchmarkingSurveyDelayID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingSurveyDelay
#'
#' This function modifies fields for a BenchmarkingSurveyDelay.
#'
#' @param BenchmarkingSurveyDelayID The id of the BenchmarkingSurveyDelay to be modified.\cr Run \code{\link{getAllBenchmarkingSurveyDelaies}} for a list of BenchmarkingSurveyDelays.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingSurveyDelay.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingSurveyDelay <- function(BenchmarkingSurveyDelayID, EntityID = 1, setBenchmarkingSurveyID = NULL, setResumeTime = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingSurveyDelay", BenchmarkingSurveyDelayID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingSurveyDelay.
#'
#' This function creates a new BenchmarkingSurveyDelay.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingSurveyDelay.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingSurveyDelay <- function(EntityID = 1, setBenchmarkingSurveyID = NULL, setResumeTime = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingSurveyDelay", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingSurveyDelay
#'
#' This function deletes a BenchmarkingSurveyDelay.
#'
#' @param BenchmarkingSurveyDelayID The id of the BenchmarkingSurveyDelay.\cr Run \code{\link{getAllBenchmarkingSurveyDelaies}} for a list of BenchmarkingSurveyDelaies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingSurveyDelay.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingSurveyDelay <- function(BenchmarkingSurveyDelayID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingSurveyDelay", BenchmarkingSurveyDelayID, EntityID)
}
#' Get all BenchmarkingSurveyInstances.
#'
#' This function returns a dataframe of all BenchmarkingSurveyInstances in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingSurveyInstances in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingSurveyInstances <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingSurveyInstanceID = F, returnBenchmarkingSurveyID = F, returnComment = F, returnContactEmail = F, returnCreatedTime = F, returnModifiedTime = F, returnTakenOnMobile = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingSurveyInstance", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingSurveyInstance
#'
#' This function returns fields for a BenchmarkingSurveyInstance.
#'
#' @param BenchmarkingSurveyInstanceID The id of the BenchmarkingSurveyInstance.\cr Run \code{\link{getAllBenchmarkingSurveyInstances}} for a list of BenchmarkingSurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingSurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingSurveyInstance <- function(BenchmarkingSurveyInstanceID, EntityID = 1, returnBenchmarkingSurveyInstanceID = F, returnBenchmarkingSurveyID = F, returnComment = F, returnContactEmail = F, returnCreatedTime = F, returnModifiedTime = F, returnTakenOnMobile = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingSurveyInstance", BenchmarkingSurveyInstanceID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingSurveyInstance
#'
#' This function modifies fields for a BenchmarkingSurveyInstance.
#'
#' @param BenchmarkingSurveyInstanceID The id of the BenchmarkingSurveyInstance to be modified.\cr Run \code{\link{getAllBenchmarkingSurveyInstances}} for a list of BenchmarkingSurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingSurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingSurveyInstance <- function(BenchmarkingSurveyInstanceID, EntityID = 1, setBenchmarkingSurveyID = NULL, setComment = NULL, setContactEmail = NULL, setTakenOnMobile = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingSurveyInstance", BenchmarkingSurveyInstanceID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingSurveyInstance.
#'
#' This function creates a new BenchmarkingSurveyInstance.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingSurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingSurveyInstance <- function(EntityID = 1, setBenchmarkingSurveyID = NULL, setComment = NULL, setContactEmail = NULL, setTakenOnMobile = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingSurveyInstance", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingSurveyInstance
#'
#' This function deletes a BenchmarkingSurveyInstance.
#'
#' @param BenchmarkingSurveyInstanceID The id of the BenchmarkingSurveyInstance.\cr Run \code{\link{getAllBenchmarkingSurveyInstances}} for a list of BenchmarkingSurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingSurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingSurveyInstance <- function(BenchmarkingSurveyInstanceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingSurveyInstance", BenchmarkingSurveyInstanceID, EntityID)
}
#' Get all BenchmarkingSurveyQuestions.
#'
#' This function returns a dataframe of all BenchmarkingSurveyQuestions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BenchmarkingSurveyQuestions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBenchmarkingSurveyQuestions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBenchmarkingSurveyQuestionID = F, returnBenchmarkingQuestionID = F, returnBenchmarkingSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BenchmarkingSurveyQuestion", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BenchmarkingSurveyQuestion
#'
#' This function returns fields for a BenchmarkingSurveyQuestion.
#'
#' @param BenchmarkingSurveyQuestionID The id of the BenchmarkingSurveyQuestion.\cr Run \code{\link{getAllBenchmarkingSurveyQuestions}} for a list of BenchmarkingSurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BenchmarkingSurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBenchmarkingSurveyQuestion <- function(BenchmarkingSurveyQuestionID, EntityID = 1, returnBenchmarkingSurveyQuestionID = F, returnBenchmarkingQuestionID = F, returnBenchmarkingSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BenchmarkingSurveyQuestion", BenchmarkingSurveyQuestionID, searchFields, EntityID)
}
#' Modify a specific BenchmarkingSurveyQuestion
#'
#' This function modifies fields for a BenchmarkingSurveyQuestion.
#'
#' @param BenchmarkingSurveyQuestionID The id of the BenchmarkingSurveyQuestion to be modified.\cr Run \code{\link{getAllBenchmarkingSurveyQuestions}} for a list of BenchmarkingSurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BenchmarkingSurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBenchmarkingSurveyQuestion <- function(BenchmarkingSurveyQuestionID, EntityID = 1, setBenchmarkingQuestionID = NULL, setBenchmarkingSurveyID = NULL, setOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BenchmarkingSurveyQuestion", BenchmarkingSurveyQuestionID, names(functionParams), functionParams, EntityID)
}
#' Create new BenchmarkingSurveyQuestion.
#'
#' This function creates a new BenchmarkingSurveyQuestion.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BenchmarkingSurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBenchmarkingSurveyQuestion <- function(EntityID = 1, setBenchmarkingQuestionID = NULL, setBenchmarkingSurveyID = NULL, setOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BenchmarkingSurveyQuestion", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BenchmarkingSurveyQuestion
#'
#' This function deletes a BenchmarkingSurveyQuestion.
#'
#' @param BenchmarkingSurveyQuestionID The id of the BenchmarkingSurveyQuestion.\cr Run \code{\link{getAllBenchmarkingSurveyQuestions}} for a list of BenchmarkingSurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BenchmarkingSurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBenchmarkingSurveyQuestion <- function(BenchmarkingSurveyQuestionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BenchmarkingSurveyQuestion", BenchmarkingSurveyQuestionID, EntityID)
}
#' Get all Browses.
#'
#' This function returns a dataframe of all Browses in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Browses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseID = F, returnApplyEntityDistrictFilter = F, returnApplyFiscalYearFilter = F, returnApplySchoolYearFilter = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnEffectiveDataModule = F, returnEffectiveDataObject = F, returnFormattedBrowsePath = F, returnIsReference = F, returnModifiedTime = F, returnModule = F, returnName = F, returnObject = F, returnObjectScreenNamePath = F, returnScreen = F, returnScreenNamePath = F, returnSkywardHash = F, returnSkywardID = F, returnTask = F, returnUseAudit = F, returnUseOldPagingSystem = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Browse", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Browse
#'
#' This function returns fields for a Browse.
#'
#' @param BrowseID The id of the Browse.\cr Run \code{\link{getAllBrowses}} for a list of Browses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Browse.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowse <- function(BrowseID, EntityID = 1, returnBrowseID = F, returnApplyEntityDistrictFilter = F, returnApplyFiscalYearFilter = F, returnApplySchoolYearFilter = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnEffectiveDataModule = F, returnEffectiveDataObject = F, returnFormattedBrowsePath = F, returnIsReference = F, returnModifiedTime = F, returnModule = F, returnName = F, returnObject = F, returnObjectScreenNamePath = F, returnScreen = F, returnScreenNamePath = F, returnSkywardHash = F, returnSkywardID = F, returnTask = F, returnUseAudit = F, returnUseOldPagingSystem = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Browse", BrowseID, searchFields, EntityID)
}
#' Modify a specific Browse
#'
#' This function modifies fields for a Browse.
#'
#' @param BrowseID The id of the Browse to be modified.\cr Run \code{\link{getAllBrowses}} for a list of Browses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Browse.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowse <- function(BrowseID, EntityID = 1, setApplyEntityDistrictFilter = NULL, setApplyFiscalYearFilter = NULL, setApplySchoolYearFilter = NULL, setDataModule = NULL, setDataObject = NULL, setIsReference = NULL, setModule = NULL, setName = NULL, setObject = NULL, setScreen = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTask = NULL, setUseAudit = NULL, setUseOldPagingSystem = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Browse", BrowseID, names(functionParams), functionParams, EntityID)
}
#' Create new Browse.
#'
#' This function creates a new Browse.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Browse.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowse <- function(EntityID = 1, setApplyEntityDistrictFilter = NULL, setApplyFiscalYearFilter = NULL, setApplySchoolYearFilter = NULL, setDataModule = NULL, setDataObject = NULL, setIsReference = NULL, setModule = NULL, setName = NULL, setObject = NULL, setScreen = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTask = NULL, setUseAudit = NULL, setUseOldPagingSystem = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Browse", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Browse
#'
#' This function deletes a Browse.
#'
#' @param BrowseID The id of the Browse.\cr Run \code{\link{getAllBrowses}} for a list of Browses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Browse.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowse <- function(BrowseID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Browse", BrowseID, EntityID)
}
#' Get all BrowseFilters.
#'
#' This function returns a dataframe of all BrowseFilters in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BrowseFilters in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowseFilters <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseFilterID = F, returnBrowseFilterIDClonedFrom = F, returnBrowseID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnFilterID = F, returnFilterTemplate = F, returnFilterTemplateData = F, returnIsAutoCreated = F, returnIsBase = F, returnIsCurrent = F, returnIsDefault = F, returnIsEnabled = F, returnModifiedTime = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnType = F, returnTypeCode = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BrowseFilter", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BrowseFilter
#'
#' This function returns fields for a BrowseFilter.
#'
#' @param BrowseFilterID The id of the BrowseFilter.\cr Run \code{\link{getAllBrowseFilters}} for a list of BrowseFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BrowseFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowseFilter <- function(BrowseFilterID, EntityID = 1, returnBrowseFilterID = F, returnBrowseFilterIDClonedFrom = F, returnBrowseID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnFilterID = F, returnFilterTemplate = F, returnFilterTemplateData = F, returnIsAutoCreated = F, returnIsBase = F, returnIsCurrent = F, returnIsDefault = F, returnIsEnabled = F, returnModifiedTime = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnType = F, returnTypeCode = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BrowseFilter", BrowseFilterID, searchFields, EntityID)
}
#' Modify a specific BrowseFilter
#'
#' This function modifies fields for a BrowseFilter.
#'
#' @param BrowseFilterID The id of the BrowseFilter to be modified.\cr Run \code{\link{getAllBrowseFilters}} for a list of BrowseFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BrowseFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowseFilter <- function(BrowseFilterID, EntityID = 1, setBrowseFilterIDClonedFrom = NULL, setBrowseID = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setFilterID = NULL, setFilterTemplateData = NULL, setIsAutoCreated = NULL, setIsBase = NULL, setIsCurrent = NULL, setIsDefault = NULL, setIsEnabled = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setType = NULL, setTypeCode = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BrowseFilter", BrowseFilterID, names(functionParams), functionParams, EntityID)
}
#' Create new BrowseFilter.
#'
#' This function creates a new BrowseFilter.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BrowseFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowseFilter <- function(EntityID = 1, setBrowseFilterIDClonedFrom = NULL, setBrowseID = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setFilterID = NULL, setFilterTemplateData = NULL, setIsAutoCreated = NULL, setIsBase = NULL, setIsCurrent = NULL, setIsDefault = NULL, setIsEnabled = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setType = NULL, setTypeCode = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BrowseFilter", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BrowseFilter
#'
#' This function deletes a BrowseFilter.
#'
#' @param BrowseFilterID The id of the BrowseFilter.\cr Run \code{\link{getAllBrowseFilters}} for a list of BrowseFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BrowseFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowseFilter <- function(BrowseFilterID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BrowseFilter", BrowseFilterID, EntityID)
}
#' Get all BrowseFilterLastUseds.
#'
#' This function returns a dataframe of all BrowseFilterLastUseds in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BrowseFilterLastUseds in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowseFilterLastUseds <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseFilterLastUsedID = F, returnBrowseFilterID = F, returnCreatedTime = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BrowseFilterLastUsed", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BrowseFilterLastUsed
#'
#' This function returns fields for a BrowseFilterLastUsed.
#'
#' @param BrowseFilterLastUsedID The id of the BrowseFilterLastUsed.\cr Run \code{\link{getAllBrowseFilterLastUseds}} for a list of BrowseFilterLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BrowseFilterLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowseFilterLastUsed <- function(BrowseFilterLastUsedID, EntityID = 1, returnBrowseFilterLastUsedID = F, returnBrowseFilterID = F, returnCreatedTime = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BrowseFilterLastUsed", BrowseFilterLastUsedID, searchFields, EntityID)
}
#' Modify a specific BrowseFilterLastUsed
#'
#' This function modifies fields for a BrowseFilterLastUsed.
#'
#' @param BrowseFilterLastUsedID The id of the BrowseFilterLastUsed to be modified.\cr Run \code{\link{getAllBrowseFilterLastUseds}} for a list of BrowseFilterLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BrowseFilterLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowseFilterLastUsed <- function(BrowseFilterLastUsedID, EntityID = 1, setBrowseFilterID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BrowseFilterLastUsed", BrowseFilterLastUsedID, names(functionParams), functionParams, EntityID)
}
#' Create new BrowseFilterLastUsed.
#'
#' This function creates a new BrowseFilterLastUsed.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BrowseFilterLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowseFilterLastUsed <- function(EntityID = 1, setBrowseFilterID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BrowseFilterLastUsed", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BrowseFilterLastUsed
#'
#' This function deletes a BrowseFilterLastUsed.
#'
#' @param BrowseFilterLastUsedID The id of the BrowseFilterLastUsed.\cr Run \code{\link{getAllBrowseFilterLastUseds}} for a list of BrowseFilterLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BrowseFilterLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowseFilterLastUsed <- function(BrowseFilterLastUsedID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BrowseFilterLastUsed", BrowseFilterLastUsedID, EntityID)
}
#' Get all BrowseMenus.
#'
#' This function returns a dataframe of all BrowseMenus in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BrowseMenus in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowseMenus <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseMenuID = F, returnAppendDataObjectNameToDisplayName = F, returnBrowseID = F, returnCondition = F, returnCreatedTime = F, returnData = F, returnDescription = F, returnDisplayInBrowse = F, returnDisplayInDetails = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnEffectiveTarget = F, returnFilter = F, returnImage = F, returnImageCode = F, returnImageText = F, returnIncludeInRowMoreMenu = F, returnIsDefault = F, returnIsEnabled = F, returnIsRowMenu = F, returnIsSkywardBrowseMenu = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnPostData = F, returnPrimaryKeyBindSource = F, returnRenderCondition = F, returnScreen = F, returnSkywardDescription = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSkywardTarget = F, returnTarget = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BrowseMenu", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BrowseMenu
#'
#' This function returns fields for a BrowseMenu.
#'
#' @param BrowseMenuID The id of the BrowseMenu.\cr Run \code{\link{getAllBrowseMenus}} for a list of BrowseMenus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BrowseMenu.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowseMenu <- function(BrowseMenuID, EntityID = 1, returnBrowseMenuID = F, returnAppendDataObjectNameToDisplayName = F, returnBrowseID = F, returnCondition = F, returnCreatedTime = F, returnData = F, returnDescription = F, returnDisplayInBrowse = F, returnDisplayInDetails = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnEffectiveTarget = F, returnFilter = F, returnImage = F, returnImageCode = F, returnImageText = F, returnIncludeInRowMoreMenu = F, returnIsDefault = F, returnIsEnabled = F, returnIsRowMenu = F, returnIsSkywardBrowseMenu = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnPostData = F, returnPrimaryKeyBindSource = F, returnRenderCondition = F, returnScreen = F, returnSkywardDescription = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSkywardTarget = F, returnTarget = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BrowseMenu", BrowseMenuID, searchFields, EntityID)
}
#' Modify a specific BrowseMenu
#'
#' This function modifies fields for a BrowseMenu.
#'
#' @param BrowseMenuID The id of the BrowseMenu to be modified.\cr Run \code{\link{getAllBrowseMenus}} for a list of BrowseMenus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BrowseMenu.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowseMenu <- function(BrowseMenuID, EntityID = 1, setAppendDataObjectNameToDisplayName = NULL, setBrowseID = NULL, setDescription = NULL, setDisplayInBrowse = NULL, setDisplayInDetails = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setImage = NULL, setImageCode = NULL, setImageText = NULL, setIncludeInRowMoreMenu = NULL, setIsDefault = NULL, setIsEnabled = NULL, setIsRowMenu = NULL, setIsSkywardBrowseMenu = NULL, setModule = NULL, setObject = NULL, setPostData = NULL, setPrimaryKeyBindSource = NULL, setScreen = NULL, setSkywardDescription = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setSkywardTarget = NULL, setTarget = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BrowseMenu", BrowseMenuID, names(functionParams), functionParams, EntityID)
}
#' Create new BrowseMenu.
#'
#' This function creates a new BrowseMenu.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BrowseMenu.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowseMenu <- function(EntityID = 1, setAppendDataObjectNameToDisplayName = NULL, setBrowseID = NULL, setDescription = NULL, setDisplayInBrowse = NULL, setDisplayInDetails = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setImage = NULL, setImageCode = NULL, setImageText = NULL, setIncludeInRowMoreMenu = NULL, setIsDefault = NULL, setIsEnabled = NULL, setIsRowMenu = NULL, setIsSkywardBrowseMenu = NULL, setModule = NULL, setObject = NULL, setPostData = NULL, setPrimaryKeyBindSource = NULL, setScreen = NULL, setSkywardDescription = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setSkywardTarget = NULL, setTarget = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BrowseMenu", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BrowseMenu
#'
#' This function deletes a BrowseMenu.
#'
#' @param BrowseMenuID The id of the BrowseMenu.\cr Run \code{\link{getAllBrowseMenus}} for a list of BrowseMenus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BrowseMenu.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowseMenu <- function(BrowseMenuID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BrowseMenu", BrowseMenuID, EntityID)
}
#' Get all BrowseViews.
#'
#' This function returns a dataframe of all BrowseViews in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BrowseViews in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowseViews <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseViewID = F, returnBrowseID = F, returnBrowseType = F, returnBrowseViewIDClonedFrom = F, returnColumns = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnHasSelectAllCheckBox = F, returnIsDefault = F, returnIsEnabled = F, returnIsModifiedView = F, returnIsSkywardView = F, returnIsUserView = F, returnJsonData = F, returnModifiedTime = F, returnRowsPerPage = F, returnSearchColumns = F, returnShowFooter = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSorts = F, returnType = F, returnTypeCode = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BrowseView", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BrowseView
#'
#' This function returns fields for a BrowseView.
#'
#' @param BrowseViewID The id of the BrowseView.\cr Run \code{\link{getAllBrowseViews}} for a list of BrowseViews.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BrowseView.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowseView <- function(BrowseViewID, EntityID = 1, returnBrowseViewID = F, returnBrowseID = F, returnBrowseType = F, returnBrowseViewIDClonedFrom = F, returnColumns = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnEffectiveIsDefault = F, returnHasSelectAllCheckBox = F, returnIsDefault = F, returnIsEnabled = F, returnIsModifiedView = F, returnIsSkywardView = F, returnIsUserView = F, returnJsonData = F, returnModifiedTime = F, returnRowsPerPage = F, returnSearchColumns = F, returnShowFooter = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnSorts = F, returnType = F, returnTypeCode = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BrowseView", BrowseViewID, searchFields, EntityID)
}
#' Modify a specific BrowseView
#'
#' This function modifies fields for a BrowseView.
#'
#' @param BrowseViewID The id of the BrowseView to be modified.\cr Run \code{\link{getAllBrowseViews}} for a list of BrowseViews.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BrowseView.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowseView <- function(BrowseViewID, EntityID = 1, setBrowseID = NULL, setBrowseViewIDClonedFrom = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsDefault = NULL, setIsEnabled = NULL, setJsonData = NULL, setRowsPerPage = NULL, setShowFooter = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setType = NULL, setTypeCode = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BrowseView", BrowseViewID, names(functionParams), functionParams, EntityID)
}
#' Create new BrowseView.
#'
#' This function creates a new BrowseView.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BrowseView.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowseView <- function(EntityID = 1, setBrowseID = NULL, setBrowseViewIDClonedFrom = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsDefault = NULL, setIsEnabled = NULL, setJsonData = NULL, setRowsPerPage = NULL, setShowFooter = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL, setType = NULL, setTypeCode = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BrowseView", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BrowseView
#'
#' This function deletes a BrowseView.
#'
#' @param BrowseViewID The id of the BrowseView.\cr Run \code{\link{getAllBrowseViews}} for a list of BrowseViews.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BrowseView.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowseView <- function(BrowseViewID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BrowseView", BrowseViewID, EntityID)
}
#' Get all BrowseViewLastUseds.
#'
#' This function returns a dataframe of all BrowseViewLastUseds in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BrowseViewLastUseds in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBrowseViewLastUseds <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBrowseViewLastUsedID = F, returnBrowseID = F, returnBrowseViewID = F, returnCreatedTime = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BrowseViewLastUsed", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BrowseViewLastUsed
#'
#' This function returns fields for a BrowseViewLastUsed.
#'
#' @param BrowseViewLastUsedID The id of the BrowseViewLastUsed.\cr Run \code{\link{getAllBrowseViewLastUseds}} for a list of BrowseViewLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BrowseViewLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBrowseViewLastUsed <- function(BrowseViewLastUsedID, EntityID = 1, returnBrowseViewLastUsedID = F, returnBrowseID = F, returnBrowseViewID = F, returnCreatedTime = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BrowseViewLastUsed", BrowseViewLastUsedID, searchFields, EntityID)
}
#' Modify a specific BrowseViewLastUsed
#'
#' This function modifies fields for a BrowseViewLastUsed.
#'
#' @param BrowseViewLastUsedID The id of the BrowseViewLastUsed to be modified.\cr Run \code{\link{getAllBrowseViewLastUseds}} for a list of BrowseViewLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BrowseViewLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBrowseViewLastUsed <- function(BrowseViewLastUsedID, EntityID = 1, setBrowseViewID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BrowseViewLastUsed", BrowseViewLastUsedID, names(functionParams), functionParams, EntityID)
}
#' Create new BrowseViewLastUsed.
#'
#' This function creates a new BrowseViewLastUsed.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BrowseViewLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBrowseViewLastUsed <- function(EntityID = 1, setBrowseViewID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BrowseViewLastUsed", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BrowseViewLastUsed
#'
#' This function deletes a BrowseViewLastUsed.
#'
#' @param BrowseViewLastUsedID The id of the BrowseViewLastUsed.\cr Run \code{\link{getAllBrowseViewLastUseds}} for a list of BrowseViewLastUseds.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BrowseViewLastUsed.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBrowseViewLastUsed <- function(BrowseViewLastUsedID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BrowseViewLastUsed", BrowseViewLastUsedID, EntityID)
}
#' Get all BulkLoads.
#'
#' This function returns a dataframe of all BulkLoads in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BulkLoads in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBulkLoads <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBulkLoadID = F, returnCreatedTime = F, returnMask = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BulkLoad", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BulkLoad
#'
#' This function returns fields for a BulkLoad.
#'
#' @param BulkLoadID The id of the BulkLoad.\cr Run \code{\link{getAllBulkLoads}} for a list of BulkLoads.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BulkLoad.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBulkLoad <- function(BulkLoadID, EntityID = 1, returnBulkLoadID = F, returnCreatedTime = F, returnMask = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BulkLoad", BulkLoadID, searchFields, EntityID)
}
#' Modify a specific BulkLoad
#'
#' This function modifies fields for a BulkLoad.
#'
#' @param BulkLoadID The id of the BulkLoad to be modified.\cr Run \code{\link{getAllBulkLoads}} for a list of BulkLoads.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BulkLoad.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBulkLoad <- function(BulkLoadID, EntityID = 1, setMask = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BulkLoad", BulkLoadID, names(functionParams), functionParams, EntityID)
}
#' Create new BulkLoad.
#'
#' This function creates a new BulkLoad.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BulkLoad.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBulkLoad <- function(EntityID = 1, setMask = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BulkLoad", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BulkLoad
#'
#' This function deletes a BulkLoad.
#'
#' @param BulkLoadID The id of the BulkLoad.\cr Run \code{\link{getAllBulkLoads}} for a list of BulkLoads.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BulkLoad.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBulkLoad <- function(BulkLoadID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BulkLoad", BulkLoadID, EntityID)
}
#' Get all BusinessMigrationHistories.
#'
#' This function returns a dataframe of all BusinessMigrationHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All BusinessMigrationHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllBusinessMigrationHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnBusinessMigrationHistoryID = F, returnCreatedTime = F, returnFullClassName = F, returnHasRun = F, returnModifiedTime = F, returnOnlineInstall = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardVersion = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "BusinessMigrationHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific BusinessMigrationHistory
#'
#' This function returns fields for a BusinessMigrationHistory.
#'
#' @param BusinessMigrationHistoryID The id of the BusinessMigrationHistory.\cr Run \code{\link{getAllBusinessMigrationHistories}} for a list of BusinessMigrationHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the BusinessMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getBusinessMigrationHistory <- function(BusinessMigrationHistoryID, EntityID = 1, returnBusinessMigrationHistoryID = F, returnCreatedTime = F, returnFullClassName = F, returnHasRun = F, returnModifiedTime = F, returnOnlineInstall = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardVersion = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "BusinessMigrationHistory", BusinessMigrationHistoryID, searchFields, EntityID)
}
#' Modify a specific BusinessMigrationHistory
#'
#' This function modifies fields for a BusinessMigrationHistory.
#'
#' @param BusinessMigrationHistoryID The id of the BusinessMigrationHistory to be modified.\cr Run \code{\link{getAllBusinessMigrationHistories}} for a list of BusinessMigrationHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified BusinessMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyBusinessMigrationHistory <- function(BusinessMigrationHistoryID, EntityID = 1, setFullClassName = NULL, setHasRun = NULL, setOnlineInstall = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardVersion = NULL, setSummary = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "BusinessMigrationHistory", BusinessMigrationHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new BusinessMigrationHistory.
#'
#' This function creates a new BusinessMigrationHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created BusinessMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createBusinessMigrationHistory <- function(EntityID = 1, setFullClassName = NULL, setHasRun = NULL, setOnlineInstall = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardVersion = NULL, setSummary = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "BusinessMigrationHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific BusinessMigrationHistory
#'
#' This function deletes a BusinessMigrationHistory.
#'
#' @param BusinessMigrationHistoryID The id of the BusinessMigrationHistory.\cr Run \code{\link{getAllBusinessMigrationHistories}} for a list of BusinessMigrationHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted BusinessMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteBusinessMigrationHistory <- function(BusinessMigrationHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "BusinessMigrationHistory", BusinessMigrationHistoryID, EntityID)
}
#' Get all CacheInitializations.
#'
#' This function returns a dataframe of all CacheInitializations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All CacheInitializations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCacheInitializations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCacheInitializationID = F, returnApplication = F, returnCacheName = F, returnCacheVersionCount = F, returnCreatedTime = F, returnHostName = F, returnInitializationTimeMilliseconds = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "CacheInitialization", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CacheInitialization
#'
#' This function returns fields for a CacheInitialization.
#'
#' @param CacheInitializationID The id of the CacheInitialization.\cr Run \code{\link{getAllCacheInitializations}} for a list of CacheInitializations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the CacheInitialization.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCacheInitialization <- function(CacheInitializationID, EntityID = 1, returnCacheInitializationID = F, returnApplication = F, returnCacheName = F, returnCacheVersionCount = F, returnCreatedTime = F, returnHostName = F, returnInitializationTimeMilliseconds = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "CacheInitialization", CacheInitializationID, searchFields, EntityID)
}
#' Modify a specific CacheInitialization
#'
#' This function modifies fields for a CacheInitialization.
#'
#' @param CacheInitializationID The id of the CacheInitialization to be modified.\cr Run \code{\link{getAllCacheInitializations}} for a list of CacheInitializations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified CacheInitialization.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCacheInitialization <- function(CacheInitializationID, EntityID = 1, setApplication = NULL, setCacheName = NULL, setCacheVersionCount = NULL, setHostName = NULL, setInitializationTimeMilliseconds = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "CacheInitialization", CacheInitializationID, names(functionParams), functionParams, EntityID)
}
#' Create new CacheInitialization.
#'
#' This function creates a new CacheInitialization.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created CacheInitialization.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCacheInitialization <- function(EntityID = 1, setApplication = NULL, setCacheName = NULL, setCacheVersionCount = NULL, setHostName = NULL, setInitializationTimeMilliseconds = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "CacheInitialization", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CacheInitialization
#'
#' This function deletes a CacheInitialization.
#'
#' @param CacheInitializationID The id of the CacheInitialization.\cr Run \code{\link{getAllCacheInitializations}} for a list of CacheInitializations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted CacheInitialization.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCacheInitialization <- function(CacheInitializationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "CacheInitialization", CacheInitializationID, EntityID)
}
#' Get all CharacterLimitGroups.
#'
#' This function returns a dataframe of all CharacterLimitGroups in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All CharacterLimitGroups in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCharacterLimitGroups <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCharacterLimitGroupID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnMaxLength = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "CharacterLimitGroup", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CharacterLimitGroup
#'
#' This function returns fields for a CharacterLimitGroup.
#'
#' @param CharacterLimitGroupID The id of the CharacterLimitGroup.\cr Run \code{\link{getAllCharacterLimitGroups}} for a list of CharacterLimitGroups.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the CharacterLimitGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCharacterLimitGroup <- function(CharacterLimitGroupID, EntityID = 1, returnCharacterLimitGroupID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnMaxLength = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "CharacterLimitGroup", CharacterLimitGroupID, searchFields, EntityID)
}
#' Modify a specific CharacterLimitGroup
#'
#' This function modifies fields for a CharacterLimitGroup.
#'
#' @param CharacterLimitGroupID The id of the CharacterLimitGroup to be modified.\cr Run \code{\link{getAllCharacterLimitGroups}} for a list of CharacterLimitGroups.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified CharacterLimitGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCharacterLimitGroup <- function(CharacterLimitGroupID, EntityID = 1, setCode = NULL, setDescription = NULL, setMaxLength = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "CharacterLimitGroup", CharacterLimitGroupID, names(functionParams), functionParams, EntityID)
}
#' Create new CharacterLimitGroup.
#'
#' This function creates a new CharacterLimitGroup.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created CharacterLimitGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCharacterLimitGroup <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setMaxLength = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "CharacterLimitGroup", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CharacterLimitGroup
#'
#' This function deletes a CharacterLimitGroup.
#'
#' @param CharacterLimitGroupID The id of the CharacterLimitGroup.\cr Run \code{\link{getAllCharacterLimitGroups}} for a list of CharacterLimitGroups.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted CharacterLimitGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCharacterLimitGroup <- function(CharacterLimitGroupID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "CharacterLimitGroup", CharacterLimitGroupID, EntityID)
}
#' Get all ConfigSystems.
#'
#' This function returns a dataframe of all ConfigSystems in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ConfigSystems in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigSystemsSkySys <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigSystemID = F, returnAllowMobileAccess = F, returnBrowseTimeoutEnabled = F, returnBrowseTimeoutSeconds = F, returnBrowseTimeoutSecondsMobile = F, returnCreatedTime = F, returnCurrencyIDBase = F, returnCustomRelationshipSync = F, returnCustomRelationshipSyncPollInterval = F, returnCustomViewSync = F, returnDaysToStoreAPIUsageHistory = F, returnDaysToStoreSystemLog = F, returnDaysToStoreUsageHistory = F, returnEnvironmentPurpose = F, returnEnvironmentPurposeBarColor = F, returnFileDestinationIDSkylertExport = F, returnFileDestinationIDThirdPartyExportImportLocation = F, returnLockDelayMinutes = F, returnLockMessage = F, returnLockoutText = F, returnLockTime = F, returnLogThreshold = F, returnLogThresholdCode = F, returnMaximumAttachmentSize = F, returnMediaIDLogo = F, returnModifiedTime = F, returnProductType = F, returnProductTypeCode = F, returnSecondsToLocked = F, returnSendingEmailAddress = F, returnSendingEmailAlias = F, returnSerialNumber = F, returnSMTPPassword = F, returnSMTPUsername = F, returnStateID = F, returnStatisticsExpiresTime = F, returnSystemTimeOffset = F, returnTimeZoneCode = F, returnTrainingTimeOffset = F, returnUseLicensing = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUseStatisticInfo = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ConfigSystem", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigSystem
#'
#' This function returns fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigSystemSkySys <- function(ConfigSystemID, EntityID = 1, returnConfigSystemID = F, returnAllowMobileAccess = F, returnBrowseTimeoutEnabled = F, returnBrowseTimeoutSeconds = F, returnBrowseTimeoutSecondsMobile = F, returnCreatedTime = F, returnCurrencyIDBase = F, returnCustomRelationshipSync = F, returnCustomRelationshipSyncPollInterval = F, returnCustomViewSync = F, returnDaysToStoreAPIUsageHistory = F, returnDaysToStoreSystemLog = F, returnDaysToStoreUsageHistory = F, returnEnvironmentPurpose = F, returnEnvironmentPurposeBarColor = F, returnFileDestinationIDSkylertExport = F, returnFileDestinationIDThirdPartyExportImportLocation = F, returnLockDelayMinutes = F, returnLockMessage = F, returnLockoutText = F, returnLockTime = F, returnLogThreshold = F, returnLogThresholdCode = F, returnMaximumAttachmentSize = F, returnMediaIDLogo = F, returnModifiedTime = F, returnProductType = F, returnProductTypeCode = F, returnSecondsToLocked = F, returnSendingEmailAddress = F, returnSendingEmailAlias = F, returnSerialNumber = F, returnSMTPPassword = F, returnSMTPUsername = F, returnStateID = F, returnStatisticsExpiresTime = F, returnSystemTimeOffset = F, returnTimeZoneCode = F, returnTrainingTimeOffset = F, returnUseLicensing = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUseStatisticInfo = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ConfigSystem", ConfigSystemID, searchFields, EntityID)
}
#' Modify a specific ConfigSystem
#'
#' This function modifies fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem to be modified.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigSystemSkySys <- function(ConfigSystemID, EntityID = 1, setAllowMobileAccess = NULL, setBrowseTimeoutEnabled = NULL, setBrowseTimeoutSeconds = NULL, setBrowseTimeoutSecondsMobile = NULL, setCurrencyIDBase = NULL, setCustomRelationshipSync = NULL, setCustomRelationshipSyncPollInterval = NULL, setCustomViewSync = NULL, setDaysToStoreAPIUsageHistory = NULL, setDaysToStoreSystemLog = NULL, setDaysToStoreUsageHistory = NULL, setEnvironmentPurpose = NULL, setEnvironmentPurposeBarColor = NULL, setFileDestinationIDSkylertExport = NULL, setFileDestinationIDThirdPartyExportImportLocation = NULL, setLockDelayMinutes = NULL, setLockMessage = NULL, setLockoutText = NULL, setLockTime = NULL, setLogThreshold = NULL, setLogThresholdCode = NULL, setMaximumAttachmentSize = NULL, setMediaIDLogo = NULL, setProductType = NULL, setProductTypeCode = NULL, setSendingEmailAddress = NULL, setSendingEmailAlias = NULL, setSerialNumber = NULL, setSMTPPassword = NULL, setSMTPUsername = NULL, setStateID = NULL, setStatisticsExpiresTime = NULL, setSystemTimeOffset = NULL, setTimeZoneCode = NULL, setTrainingTimeOffset = NULL, setUseLicensing = NULL, setUseStatisticInfo = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ConfigSystem", ConfigSystemID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigSystem.
#'
#' This function creates a new ConfigSystem.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigSystemSkySys <- function(EntityID = 1, setAllowMobileAccess = NULL, setBrowseTimeoutEnabled = NULL, setBrowseTimeoutSeconds = NULL, setBrowseTimeoutSecondsMobile = NULL, setCurrencyIDBase = NULL, setCustomRelationshipSync = NULL, setCustomRelationshipSyncPollInterval = NULL, setCustomViewSync = NULL, setDaysToStoreAPIUsageHistory = NULL, setDaysToStoreSystemLog = NULL, setDaysToStoreUsageHistory = NULL, setEnvironmentPurpose = NULL, setEnvironmentPurposeBarColor = NULL, setFileDestinationIDSkylertExport = NULL, setFileDestinationIDThirdPartyExportImportLocation = NULL, setLockDelayMinutes = NULL, setLockMessage = NULL, setLockoutText = NULL, setLockTime = NULL, setLogThreshold = NULL, setLogThresholdCode = NULL, setMaximumAttachmentSize = NULL, setMediaIDLogo = NULL, setProductType = NULL, setProductTypeCode = NULL, setSendingEmailAddress = NULL, setSendingEmailAlias = NULL, setSerialNumber = NULL, setSMTPPassword = NULL, setSMTPUsername = NULL, setStateID = NULL, setStatisticsExpiresTime = NULL, setSystemTimeOffset = NULL, setTimeZoneCode = NULL, setTrainingTimeOffset = NULL, setUseLicensing = NULL, setUseStatisticInfo = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ConfigSystem", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigSystem
#'
#' This function deletes a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigSystemSkySys <- function(ConfigSystemID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ConfigSystem", ConfigSystemID, EntityID)
}
#' Get all CrossReferences.
#'
#' This function returns a dataframe of all CrossReferences in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All CrossReferences in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCrossReferences <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCrossReferenceID = F, returnCreatedTime = F, returnFileValue = F, returnImportValue = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "CrossReference", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CrossReference
#'
#' This function returns fields for a CrossReference.
#'
#' @param CrossReferenceID The id of the CrossReference.\cr Run \code{\link{getAllCrossReferences}} for a list of CrossReferences.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the CrossReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCrossReference <- function(CrossReferenceID, EntityID = 1, returnCrossReferenceID = F, returnCreatedTime = F, returnFileValue = F, returnImportValue = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "CrossReference", CrossReferenceID, searchFields, EntityID)
}
#' Modify a specific CrossReference
#'
#' This function modifies fields for a CrossReference.
#'
#' @param CrossReferenceID The id of the CrossReference to be modified.\cr Run \code{\link{getAllCrossReferences}} for a list of CrossReferences.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified CrossReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCrossReference <- function(CrossReferenceID, EntityID = 1, setFileValue = NULL, setImportValue = NULL, setValueSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "CrossReference", CrossReferenceID, names(functionParams), functionParams, EntityID)
}
#' Create new CrossReference.
#'
#' This function creates a new CrossReference.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created CrossReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCrossReference <- function(EntityID = 1, setFileValue = NULL, setImportValue = NULL, setValueSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "CrossReference", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CrossReference
#'
#' This function deletes a CrossReference.
#'
#' @param CrossReferenceID The id of the CrossReference.\cr Run \code{\link{getAllCrossReferences}} for a list of CrossReferences.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted CrossReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCrossReference <- function(CrossReferenceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "CrossReference", CrossReferenceID, EntityID)
}
#' Get all CustomScreens.
#'
#' This function returns a dataframe of all CustomScreens in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All CustomScreens in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCustomScreens <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCustomScreenID = F, returnCreatedTime = F, returnHasPendingChanges = F, returnIsProfileScreen = F, returnModifiedTime = F, returnName = F, returnObjectID = F, returnPortal = F, returnPortalCode = F, returnProfileObjectName = F, returnScreenPath = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "CustomScreen", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CustomScreen
#'
#' This function returns fields for a CustomScreen.
#'
#' @param CustomScreenID The id of the CustomScreen.\cr Run \code{\link{getAllCustomScreens}} for a list of CustomScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the CustomScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCustomScreen <- function(CustomScreenID, EntityID = 1, returnCustomScreenID = F, returnCreatedTime = F, returnHasPendingChanges = F, returnIsProfileScreen = F, returnModifiedTime = F, returnName = F, returnObjectID = F, returnPortal = F, returnPortalCode = F, returnProfileObjectName = F, returnScreenPath = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "CustomScreen", CustomScreenID, searchFields, EntityID)
}
#' Modify a specific CustomScreen
#'
#' This function modifies fields for a CustomScreen.
#'
#' @param CustomScreenID The id of the CustomScreen to be modified.\cr Run \code{\link{getAllCustomScreens}} for a list of CustomScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified CustomScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCustomScreen <- function(CustomScreenID, EntityID = 1, setHasPendingChanges = NULL, setName = NULL, setObjectID = NULL, setPortal = NULL, setPortalCode = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "CustomScreen", CustomScreenID, names(functionParams), functionParams, EntityID)
}
#' Create new CustomScreen.
#'
#' This function creates a new CustomScreen.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created CustomScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCustomScreen <- function(EntityID = 1, setHasPendingChanges = NULL, setName = NULL, setObjectID = NULL, setPortal = NULL, setPortalCode = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "CustomScreen", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CustomScreen
#'
#' This function deletes a CustomScreen.
#'
#' @param CustomScreenID The id of the CustomScreen.\cr Run \code{\link{getAllCustomScreens}} for a list of CustomScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted CustomScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCustomScreen <- function(CustomScreenID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "CustomScreen", CustomScreenID, EntityID)
}
#' Get all CustomScreenElements.
#'
#' This function returns a dataframe of all CustomScreenElements in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All CustomScreenElements in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCustomScreenElements <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCustomScreenElementID = F, returnCreatedTime = F, returnCustomScreenElementType = F, returnCustomScreenElementTypeDisplayText = F, returnCustomScreenID = F, returnData = F, returnDisplayOrder = F, returnDisplayType = F, returnGuidFieldPath = F, returnIsReadOnly = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "CustomScreenElement", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CustomScreenElement
#'
#' This function returns fields for a CustomScreenElement.
#'
#' @param CustomScreenElementID The id of the CustomScreenElement.\cr Run \code{\link{getAllCustomScreenElements}} for a list of CustomScreenElements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the CustomScreenElement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCustomScreenElement <- function(CustomScreenElementID, EntityID = 1, returnCustomScreenElementID = F, returnCreatedTime = F, returnCustomScreenElementType = F, returnCustomScreenElementTypeDisplayText = F, returnCustomScreenID = F, returnData = F, returnDisplayOrder = F, returnDisplayType = F, returnGuidFieldPath = F, returnIsReadOnly = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "CustomScreenElement", CustomScreenElementID, searchFields, EntityID)
}
#' Modify a specific CustomScreenElement
#'
#' This function modifies fields for a CustomScreenElement.
#'
#' @param CustomScreenElementID The id of the CustomScreenElement to be modified.\cr Run \code{\link{getAllCustomScreenElements}} for a list of CustomScreenElements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified CustomScreenElement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCustomScreenElement <- function(CustomScreenElementID, EntityID = 1, setCustomScreenID = NULL, setData = NULL, setDisplayOrder = NULL, setGuidFieldPath = NULL, setIsReadOnly = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "CustomScreenElement", CustomScreenElementID, names(functionParams), functionParams, EntityID)
}
#' Create new CustomScreenElement.
#'
#' This function creates a new CustomScreenElement.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created CustomScreenElement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCustomScreenElement <- function(EntityID = 1, setCustomScreenID = NULL, setData = NULL, setDisplayOrder = NULL, setGuidFieldPath = NULL, setIsReadOnly = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "CustomScreenElement", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CustomScreenElement
#'
#' This function deletes a CustomScreenElement.
#'
#' @param CustomScreenElementID The id of the CustomScreenElement.\cr Run \code{\link{getAllCustomScreenElements}} for a list of CustomScreenElements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted CustomScreenElement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCustomScreenElement <- function(CustomScreenElementID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "CustomScreenElement", CustomScreenElementID, EntityID)
}
#' Get all Dashboards.
#'
#' This function returns a dataframe of all Dashboards in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Dashboards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDashboards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDashboardID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Dashboard", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Dashboard
#'
#' This function returns fields for a Dashboard.
#'
#' @param DashboardID The id of the Dashboard.\cr Run \code{\link{getAllDashboards}} for a list of Dashboards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Dashboard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDashboard <- function(DashboardID, EntityID = 1, returnDashboardID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Dashboard", DashboardID, searchFields, EntityID)
}
#' Modify a specific Dashboard
#'
#' This function modifies fields for a Dashboard.
#'
#' @param DashboardID The id of the Dashboard to be modified.\cr Run \code{\link{getAllDashboards}} for a list of Dashboards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Dashboard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDashboard <- function(DashboardID, EntityID = 1, setName = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Dashboard", DashboardID, names(functionParams), functionParams, EntityID)
}
#' Create new Dashboard.
#'
#' This function creates a new Dashboard.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Dashboard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDashboard <- function(EntityID = 1, setName = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Dashboard", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Dashboard
#'
#' This function deletes a Dashboard.
#'
#' @param DashboardID The id of the Dashboard.\cr Run \code{\link{getAllDashboards}} for a list of Dashboards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Dashboard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDashboard <- function(DashboardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Dashboard", DashboardID, EntityID)
}
#' Get all DatabaseConnections.
#'
#' This function returns a dataframe of all DatabaseConnections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All DatabaseConnections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDatabaseConnections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConnectionID = F, returnAuthScheme = F, returnClientNetAddress = F, returnClientTcpPort = F, returnConnectTime = F, returnLastRead = F, returnLastWrite = F, returnLocalNetAddress = F, returnLocalTcpPort = F, returnMostRecentSessionID = F, returnMostRecentSqlHandle = F, returnNetPacketSize = F, returnNetTransport = F, returnNumReads = F, returnNumWrites = F, returnParentConnectionID = F, returnProtocolType = F, returnSessionID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "DatabaseConnection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DatabaseConnection
#'
#' This function returns fields for a DatabaseConnection.
#'
#' @param DatabaseConnectionID The id of the DatabaseConnection.\cr Run \code{\link{getAllDatabaseConnections}} for a list of DatabaseConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the DatabaseConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDatabaseConnection <- function(DatabaseConnectionID, EntityID = 1, returnConnectionID = F, returnAuthScheme = F, returnClientNetAddress = F, returnClientTcpPort = F, returnConnectTime = F, returnLastRead = F, returnLastWrite = F, returnLocalNetAddress = F, returnLocalTcpPort = F, returnMostRecentSessionID = F, returnMostRecentSqlHandle = F, returnNetPacketSize = F, returnNetTransport = F, returnNumReads = F, returnNumWrites = F, returnParentConnectionID = F, returnProtocolType = F, returnSessionID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "DatabaseConnection", DatabaseConnectionID, searchFields, EntityID)
}
#' Modify a specific DatabaseConnection
#'
#' This function modifies fields for a DatabaseConnection.
#'
#' @param DatabaseConnectionID The id of the DatabaseConnection to be modified.\cr Run \code{\link{getAllDatabaseConnections}} for a list of DatabaseConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified DatabaseConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDatabaseConnection <- function(DatabaseConnectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "DatabaseConnection", DatabaseConnectionID, names(functionParams), functionParams, EntityID)
}
#' Create new DatabaseConnection.
#'
#' This function creates a new DatabaseConnection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created DatabaseConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDatabaseConnection <- function(EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "DatabaseConnection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DatabaseConnection
#'
#' This function deletes a DatabaseConnection.
#'
#' @param DatabaseConnectionID The id of the DatabaseConnection.\cr Run \code{\link{getAllDatabaseConnections}} for a list of DatabaseConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted DatabaseConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDatabaseConnection <- function(DatabaseConnectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "DatabaseConnection", DatabaseConnectionID, EntityID)
}
#' Get all DatabaseRequests.
#'
#' This function returns a dataframe of all DatabaseRequests in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All DatabaseRequests in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDatabaseRequests <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSessionID = F, returnApplicationName = F, returnBlockedBySessionID = F, returnCommand = F, returnCPUTime = F, returnDatabase = F, returnDegreesOfParallelism = F, returnElapsedTime = F, returnEstimatedComplete = F, returnExecutingStatement = F, returnFullQuery = F, returnGrantedMemory = F, returnHostname = F, returnIdealMemory = F, returnLastWaitType = F, returnOpenResultSets = F, returnOpenTransactions = F, returnPercentComplete = F, returnReads = F, returnRequestID = F, returnRequiredMemory = F, returnTimeoutSeconds = F, returnUsedMemory = F, returnUser = F, returnWaitTime = F, returnWaitType = F, returnWrites = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "DatabaseRequest", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DatabaseRequest
#'
#' This function returns fields for a DatabaseRequest.
#'
#' @param DatabaseRequestID The id of the DatabaseRequest.\cr Run \code{\link{getAllDatabaseRequests}} for a list of DatabaseRequests.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the DatabaseRequest.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDatabaseRequest <- function(DatabaseRequestID, EntityID = 1, returnSessionID = F, returnApplicationName = F, returnBlockedBySessionID = F, returnCommand = F, returnCPUTime = F, returnDatabase = F, returnDegreesOfParallelism = F, returnElapsedTime = F, returnEstimatedComplete = F, returnExecutingStatement = F, returnFullQuery = F, returnGrantedMemory = F, returnHostname = F, returnIdealMemory = F, returnLastWaitType = F, returnOpenResultSets = F, returnOpenTransactions = F, returnPercentComplete = F, returnReads = F, returnRequestID = F, returnRequiredMemory = F, returnTimeoutSeconds = F, returnUsedMemory = F, returnUser = F, returnWaitTime = F, returnWaitType = F, returnWrites = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "DatabaseRequest", DatabaseRequestID, searchFields, EntityID)
}
#' Modify a specific DatabaseRequest
#'
#' This function modifies fields for a DatabaseRequest.
#'
#' @param DatabaseRequestID The id of the DatabaseRequest to be modified.\cr Run \code{\link{getAllDatabaseRequests}} for a list of DatabaseRequests.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified DatabaseRequest.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDatabaseRequest <- function(DatabaseRequestID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "DatabaseRequest", DatabaseRequestID, names(functionParams), functionParams, EntityID)
}
#' Create new DatabaseRequest.
#'
#' This function creates a new DatabaseRequest.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created DatabaseRequest.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDatabaseRequest <- function(EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "DatabaseRequest", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DatabaseRequest
#'
#' This function deletes a DatabaseRequest.
#'
#' @param DatabaseRequestID The id of the DatabaseRequest.\cr Run \code{\link{getAllDatabaseRequests}} for a list of DatabaseRequests.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted DatabaseRequest.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDatabaseRequest <- function(DatabaseRequestID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "DatabaseRequest", DatabaseRequestID, EntityID)
}
#' Get all DatabaseSessions.
#'
#' This function returns a dataframe of all DatabaseSessions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All DatabaseSessions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDatabaseSessions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSessionID = F, returnAuthenticatingDatabaseID = F, returnClientInterfaceName = F, returnClientVersion = F, returnCpuTime = F, returnDatabaseID = F, returnHostName = F, returnHostProcessID = F, returnIsUserProcess = F, returnLastRequestEndTime = F, returnLastRequestStartTime = F, returnLastSuccessfullLogon = F, returnLastUnsuccessfullLogon = F, returnLogicalReads = F, returnLoginName = F, returnLoginTime = F, returnMemoryUsage = F, returnNtDomain = F, returnNtUserName = F, returnOpenTransactionCount = F, returnOriginalLoginName = F, returnPrevError = F, returnProgramName = F, returnReads = F, returnRowCount = F, returnStatus = F, returnTotalElapsedTime = F, returnTotalScheduledTime = F, returnTransactionIsolationLevel = F, returnUnsuccessfulLogons = F, returnWrites = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "DatabaseSession", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DatabaseSession
#'
#' This function returns fields for a DatabaseSession.
#'
#' @param DatabaseSessionID The id of the DatabaseSession.\cr Run \code{\link{getAllDatabaseSessions}} for a list of DatabaseSessions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the DatabaseSession.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDatabaseSession <- function(DatabaseSessionID, EntityID = 1, returnSessionID = F, returnAuthenticatingDatabaseID = F, returnClientInterfaceName = F, returnClientVersion = F, returnCpuTime = F, returnDatabaseID = F, returnHostName = F, returnHostProcessID = F, returnIsUserProcess = F, returnLastRequestEndTime = F, returnLastRequestStartTime = F, returnLastSuccessfullLogon = F, returnLastUnsuccessfullLogon = F, returnLogicalReads = F, returnLoginName = F, returnLoginTime = F, returnMemoryUsage = F, returnNtDomain = F, returnNtUserName = F, returnOpenTransactionCount = F, returnOriginalLoginName = F, returnPrevError = F, returnProgramName = F, returnReads = F, returnRowCount = F, returnStatus = F, returnTotalElapsedTime = F, returnTotalScheduledTime = F, returnTransactionIsolationLevel = F, returnUnsuccessfulLogons = F, returnWrites = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "DatabaseSession", DatabaseSessionID, searchFields, EntityID)
}
#' Modify a specific DatabaseSession
#'
#' This function modifies fields for a DatabaseSession.
#'
#' @param DatabaseSessionID The id of the DatabaseSession to be modified.\cr Run \code{\link{getAllDatabaseSessions}} for a list of DatabaseSessions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified DatabaseSession.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDatabaseSession <- function(DatabaseSessionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "DatabaseSession", DatabaseSessionID, names(functionParams), functionParams, EntityID)
}
#' Create new DatabaseSession.
#'
#' This function creates a new DatabaseSession.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created DatabaseSession.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDatabaseSession <- function(EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "DatabaseSession", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DatabaseSession
#'
#' This function deletes a DatabaseSession.
#'
#' @param DatabaseSessionID The id of the DatabaseSession.\cr Run \code{\link{getAllDatabaseSessions}} for a list of DatabaseSessions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted DatabaseSession.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDatabaseSession <- function(DatabaseSessionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "DatabaseSession", DatabaseSessionID, EntityID)
}
#' Get all DatabaseTransactions.
#'
#' This function returns a dataframe of all DatabaseTransactions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All DatabaseTransactions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDatabaseTransactions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTransactionID = F, returnName = F, returnTransactionBeginTime = F, returnTransactionState = F, returnTransactionType = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "DatabaseTransaction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DatabaseTransaction
#'
#' This function returns fields for a DatabaseTransaction.
#'
#' @param DatabaseTransactionID The id of the DatabaseTransaction.\cr Run \code{\link{getAllDatabaseTransactions}} for a list of DatabaseTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the DatabaseTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDatabaseTransaction <- function(DatabaseTransactionID, EntityID = 1, returnTransactionID = F, returnName = F, returnTransactionBeginTime = F, returnTransactionState = F, returnTransactionType = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "DatabaseTransaction", DatabaseTransactionID, searchFields, EntityID)
}
#' Modify a specific DatabaseTransaction
#'
#' This function modifies fields for a DatabaseTransaction.
#'
#' @param DatabaseTransactionID The id of the DatabaseTransaction to be modified.\cr Run \code{\link{getAllDatabaseTransactions}} for a list of DatabaseTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified DatabaseTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDatabaseTransaction <- function(DatabaseTransactionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "DatabaseTransaction", DatabaseTransactionID, names(functionParams), functionParams, EntityID)
}
#' Create new DatabaseTransaction.
#'
#' This function creates a new DatabaseTransaction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created DatabaseTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDatabaseTransaction <- function(EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "DatabaseTransaction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DatabaseTransaction
#'
#' This function deletes a DatabaseTransaction.
#'
#' @param DatabaseTransactionID The id of the DatabaseTransaction.\cr Run \code{\link{getAllDatabaseTransactions}} for a list of DatabaseTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted DatabaseTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDatabaseTransaction <- function(DatabaseTransactionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "DatabaseTransaction", DatabaseTransactionID, EntityID)
}
#' Get all DataMigrationHistories.
#'
#' This function returns a dataframe of all DataMigrationHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All DataMigrationHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDataMigrationHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDataMigrationHistoryID = F, returnCreatedTime = F, returnMigrationNumber = F, returnModifiedTime = F, returnOnlineInstall = F, returnSkipped = F, returnSkywardVersion = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "DataMigrationHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DataMigrationHistory
#'
#' This function returns fields for a DataMigrationHistory.
#'
#' @param DataMigrationHistoryID The id of the DataMigrationHistory.\cr Run \code{\link{getAllDataMigrationHistories}} for a list of DataMigrationHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the DataMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDataMigrationHistory <- function(DataMigrationHistoryID, EntityID = 1, returnDataMigrationHistoryID = F, returnCreatedTime = F, returnMigrationNumber = F, returnModifiedTime = F, returnOnlineInstall = F, returnSkipped = F, returnSkywardVersion = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "DataMigrationHistory", DataMigrationHistoryID, searchFields, EntityID)
}
#' Modify a specific DataMigrationHistory
#'
#' This function modifies fields for a DataMigrationHistory.
#'
#' @param DataMigrationHistoryID The id of the DataMigrationHistory to be modified.\cr Run \code{\link{getAllDataMigrationHistories}} for a list of DataMigrationHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified DataMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDataMigrationHistory <- function(DataMigrationHistoryID, EntityID = 1, setMigrationNumber = NULL, setOnlineInstall = NULL, setSkipped = NULL, setSkywardVersion = NULL, setSummary = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "DataMigrationHistory", DataMigrationHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new DataMigrationHistory.
#'
#' This function creates a new DataMigrationHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created DataMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDataMigrationHistory <- function(EntityID = 1, setMigrationNumber = NULL, setOnlineInstall = NULL, setSkipped = NULL, setSkywardVersion = NULL, setSummary = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "DataMigrationHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DataMigrationHistory
#'
#' This function deletes a DataMigrationHistory.
#'
#' @param DataMigrationHistoryID The id of the DataMigrationHistory.\cr Run \code{\link{getAllDataMigrationHistories}} for a list of DataMigrationHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted DataMigrationHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDataMigrationHistory <- function(DataMigrationHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "DataMigrationHistory", DataMigrationHistoryID, EntityID)
}
#' Get all Emails.
#'
#' This function returns a dataframe of all Emails in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Emails in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEmails <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEmailID = F, returnBody = F, returnCarbonCopy = F, returnCreatedTime = F, returnEndTime = F, returnHostname = F, returnHTMLBody = F, returnMessageID = F, returnModifiedTime = F, returnPriority = F, returnPriorityCode = F, returnProcessID = F, returnRecipient = F, returnSendingAddress = F, returnSendingAlias = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnSubject = F, returnThreadName = F, returnUserIDCreatedBy = F, returnUserIDImpersonator = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Email", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Email
#'
#' This function returns fields for an Email.
#'
#' @param EmailID The id of the Email.\cr Run \code{\link{getAllEmails}} for a list of Emails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Email.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEmail <- function(EmailID, EntityID = 1, returnEmailID = F, returnBody = F, returnCarbonCopy = F, returnCreatedTime = F, returnEndTime = F, returnHostname = F, returnHTMLBody = F, returnMessageID = F, returnModifiedTime = F, returnPriority = F, returnPriorityCode = F, returnProcessID = F, returnRecipient = F, returnSendingAddress = F, returnSendingAlias = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnSubject = F, returnThreadName = F, returnUserIDCreatedBy = F, returnUserIDImpersonator = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Email", EmailID, searchFields, EntityID)
}
#' Modify a specific Email
#'
#' This function modifies fields for an Email.
#'
#' @param EmailID The id of the Email to be modified.\cr Run \code{\link{getAllEmails}} for a list of Emails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Email.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEmail <- function(EmailID, EntityID = 1, setBody = NULL, setCarbonCopy = NULL, setEndTime = NULL, setHostname = NULL, setHTMLBody = NULL, setMessageID = NULL, setPriority = NULL, setProcessID = NULL, setRecipient = NULL, setSendingAddress = NULL, setSendingAlias = NULL, setStartTime = NULL, setStatus = NULL, setSubject = NULL, setThreadName = NULL, setUserIDImpersonator = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Email", EmailID, names(functionParams), functionParams, EntityID)
}
#' Create new Email.
#'
#' This function creates a new Email.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Email.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEmail <- function(EntityID = 1, setBody = NULL, setCarbonCopy = NULL, setEndTime = NULL, setHostname = NULL, setHTMLBody = NULL, setMessageID = NULL, setPriority = NULL, setProcessID = NULL, setRecipient = NULL, setSendingAddress = NULL, setSendingAlias = NULL, setStartTime = NULL, setStatus = NULL, setSubject = NULL, setThreadName = NULL, setUserIDImpersonator = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Email", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Email
#'
#' This function deletes an Email.
#'
#' @param EmailID The id of the Email.\cr Run \code{\link{getAllEmails}} for a list of Emails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Email.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEmail <- function(EmailID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Email", EmailID, EntityID)
}
#' Get all EmailAttachments.
#'
#' This function returns a dataframe of all EmailAttachments in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All EmailAttachments in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEmailAttachments <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEmailAttachmentID = F, returnCreatedTime = F, returnEmailID = F, returnMediaID = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "EmailAttachment", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EmailAttachment
#'
#' This function returns fields for an EmailAttachment.
#'
#' @param EmailAttachmentID The id of the EmailAttachment.\cr Run \code{\link{getAllEmailAttachments}} for a list of EmailAttachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the EmailAttachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEmailAttachment <- function(EmailAttachmentID, EntityID = 1, returnEmailAttachmentID = F, returnCreatedTime = F, returnEmailID = F, returnMediaID = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "EmailAttachment", EmailAttachmentID, searchFields, EntityID)
}
#' Modify a specific EmailAttachment
#'
#' This function modifies fields for an EmailAttachment.
#'
#' @param EmailAttachmentID The id of the EmailAttachment to be modified.\cr Run \code{\link{getAllEmailAttachments}} for a list of EmailAttachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified EmailAttachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEmailAttachment <- function(EmailAttachmentID, EntityID = 1, setEmailID = NULL, setMediaID = NULL, setName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "EmailAttachment", EmailAttachmentID, names(functionParams), functionParams, EntityID)
}
#' Create new EmailAttachment.
#'
#' This function creates a new EmailAttachment.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created EmailAttachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEmailAttachment <- function(EntityID = 1, setEmailID = NULL, setMediaID = NULL, setName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "EmailAttachment", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EmailAttachment
#'
#' This function deletes an EmailAttachment.
#'
#' @param EmailAttachmentID The id of the EmailAttachment.\cr Run \code{\link{getAllEmailAttachments}} for a list of EmailAttachments.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted EmailAttachment.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEmailAttachment <- function(EmailAttachmentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "EmailAttachment", EmailAttachmentID, EntityID)
}
#' Get all ExternalLinks.
#'
#' This function returns a dataframe of all ExternalLinks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ExternalLinks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllExternalLinks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnExternalLinkID = F, returnCreatedTime = F, returnDescription = F, returnDisplayInAdministrativeAccess = F, returnDisplayInEmployeeAccess = F, returnDisplayInFamilyAccess = F, returnDisplayInNewStudentEnrollment = F, returnDisplayInStudentAccess = F, returnDisplayInStudentServicesAccess = F, returnDisplayInTeacherAccess = F, returnDistrictID = F, returnIcon = F, returnIconCode = F, returnLinkText = F, returnModifiedTime = F, returnURL = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ExternalLink", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ExternalLink
#'
#' This function returns fields for an ExternalLink.
#'
#' @param ExternalLinkID The id of the ExternalLink.\cr Run \code{\link{getAllExternalLinks}} for a list of ExternalLinks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ExternalLink.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getExternalLink <- function(ExternalLinkID, EntityID = 1, returnExternalLinkID = F, returnCreatedTime = F, returnDescription = F, returnDisplayInAdministrativeAccess = F, returnDisplayInEmployeeAccess = F, returnDisplayInFamilyAccess = F, returnDisplayInNewStudentEnrollment = F, returnDisplayInStudentAccess = F, returnDisplayInStudentServicesAccess = F, returnDisplayInTeacherAccess = F, returnDistrictID = F, returnIcon = F, returnIconCode = F, returnLinkText = F, returnModifiedTime = F, returnURL = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ExternalLink", ExternalLinkID, searchFields, EntityID)
}
#' Modify a specific ExternalLink
#'
#' This function modifies fields for an ExternalLink.
#'
#' @param ExternalLinkID The id of the ExternalLink to be modified.\cr Run \code{\link{getAllExternalLinks}} for a list of ExternalLinks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ExternalLink.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyExternalLink <- function(ExternalLinkID, EntityID = 1, setDescription = NULL, setDisplayInAdministrativeAccess = NULL, setDisplayInEmployeeAccess = NULL, setDisplayInFamilyAccess = NULL, setDisplayInNewStudentEnrollment = NULL, setDisplayInStudentAccess = NULL, setDisplayInStudentServicesAccess = NULL, setDisplayInTeacherAccess = NULL, setDistrictID = NULL, setIcon = NULL, setIconCode = NULL, setLinkText = NULL, setURL = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ExternalLink", ExternalLinkID, names(functionParams), functionParams, EntityID)
}
#' Create new ExternalLink.
#'
#' This function creates a new ExternalLink.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ExternalLink.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createExternalLink <- function(EntityID = 1, setDescription = NULL, setDisplayInAdministrativeAccess = NULL, setDisplayInEmployeeAccess = NULL, setDisplayInFamilyAccess = NULL, setDisplayInNewStudentEnrollment = NULL, setDisplayInStudentAccess = NULL, setDisplayInStudentServicesAccess = NULL, setDisplayInTeacherAccess = NULL, setDistrictID = NULL, setIcon = NULL, setIconCode = NULL, setLinkText = NULL, setURL = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ExternalLink", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ExternalLink
#'
#' This function deletes an ExternalLink.
#'
#' @param ExternalLinkID The id of the ExternalLink.\cr Run \code{\link{getAllExternalLinks}} for a list of ExternalLinks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ExternalLink.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteExternalLink <- function(ExternalLinkID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ExternalLink", ExternalLinkID, EntityID)
}
#' Get all ExternalLinkEntities.
#'
#' This function returns a dataframe of all ExternalLinkEntities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ExternalLinkEntities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllExternalLinkEntities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnExternalLinkEntityID = F, returnCreatedTime = F, returnEntityID = F, returnExternalLinkID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ExternalLinkEntity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ExternalLinkEntity
#'
#' This function returns fields for an ExternalLinkEntity.
#'
#' @param ExternalLinkEntityID The id of the ExternalLinkEntity.\cr Run \code{\link{getAllExternalLinkEntities}} for a list of ExternalLinkEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ExternalLinkEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getExternalLinkEntity <- function(ExternalLinkEntityID, EntityID = 1, returnExternalLinkEntityID = F, returnCreatedTime = F, returnEntityID = F, returnExternalLinkID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ExternalLinkEntity", ExternalLinkEntityID, searchFields, EntityID)
}
#' Modify a specific ExternalLinkEntity
#'
#' This function modifies fields for an ExternalLinkEntity.
#'
#' @param ExternalLinkEntityID The id of the ExternalLinkEntity to be modified.\cr Run \code{\link{getAllExternalLinkEntities}} for a list of ExternalLinkEntitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ExternalLinkEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyExternalLinkEntity <- function(ExternalLinkEntityID, EntityID = 1, setEntityID = NULL, setExternalLinkID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ExternalLinkEntity", ExternalLinkEntityID, names(functionParams), functionParams, EntityID)
}
#' Create new ExternalLinkEntity.
#'
#' This function creates a new ExternalLinkEntity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ExternalLinkEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createExternalLinkEntity <- function(EntityID = 1, setEntityID = NULL, setExternalLinkID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ExternalLinkEntity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ExternalLinkEntity
#'
#' This function deletes an ExternalLinkEntity.
#'
#' @param ExternalLinkEntityID The id of the ExternalLinkEntity.\cr Run \code{\link{getAllExternalLinkEntities}} for a list of ExternalLinkEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ExternalLinkEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteExternalLinkEntity <- function(ExternalLinkEntityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ExternalLinkEntity", ExternalLinkEntityID, EntityID)
}
#' Get all Feedbacks.
#'
#' This function returns a dataframe of all Feedbacks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Feedbacks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFeedbacks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFeedbackID = F, returnComment = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnSubScreen = F, returnSystemVersion = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Feedback", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Feedback
#'
#' This function returns fields for a Feedback.
#'
#' @param FeedbackID The id of the Feedback.\cr Run \code{\link{getAllFeedbacks}} for a list of Feedbacks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Feedback.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFeedback <- function(FeedbackID, EntityID = 1, returnFeedbackID = F, returnComment = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnSubScreen = F, returnSystemVersion = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Feedback", FeedbackID, searchFields, EntityID)
}
#' Modify a specific Feedback
#'
#' This function modifies fields for a Feedback.
#'
#' @param FeedbackID The id of the Feedback to be modified.\cr Run \code{\link{getAllFeedbacks}} for a list of Feedbacks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Feedback.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFeedback <- function(FeedbackID, EntityID = 1, setComment = NULL, setModule = NULL, setObject = NULL, setScreen = NULL, setSubScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Feedback", FeedbackID, names(functionParams), functionParams, EntityID)
}
#' Create new Feedback.
#'
#' This function creates a new Feedback.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Feedback.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFeedback <- function(EntityID = 1, setComment = NULL, setModule = NULL, setObject = NULL, setScreen = NULL, setSubScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Feedback", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Feedback
#'
#' This function deletes a Feedback.
#'
#' @param FeedbackID The id of the Feedback.\cr Run \code{\link{getAllFeedbacks}} for a list of Feedbacks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Feedback.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFeedback <- function(FeedbackID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Feedback", FeedbackID, EntityID)
}
#' Get all Fields.
#'
#' This function returns a dataframe of all Fields in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Fields in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFields <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFieldID = F, returnChangeType = F, returnCreatedTime = F, returnCurrentDisplayName = F, returnCurrentFieldWidth = F, returnCurrentIsRequired = F, returnCurrentName = F, returnCurrentPrecision = F, returnCurrentRelationshipOrFieldName = F, returnCurrentScale = F, returnCurrentSize = F, returnCurrentType = F, returnCurrentTypeCode = F, returnCustomizationID = F, returnFormattedFieldPath = F, returnHasChangedRelationships = F, returnIsDeniable = F, returnIsForeignKeyOfRelationship = F, returnIsInDB = F, returnIsPrimaryKey = F, returnIsSkywardField = F, returnModifiedTime = F, returnObjectID = F, returnPendingDisplayName = F, returnPendingFieldWidth = F, returnPendingIsRequired = F, returnPendingName = F, returnPendingPrecision = F, returnPendingRelationshipOrFieldName = F, returnPendingScale = F, returnPendingSize = F, returnPendingType = F, returnPendingTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUniqueIDString = F, returnUserCanEdit = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceDataTypeCode = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Field", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Field
#'
#' This function returns fields for a Field.
#'
#' @param FieldID The id of the Field.\cr Run \code{\link{getAllFields}} for a list of Fields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Field.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getField <- function(FieldID, EntityID = 1, returnFieldID = F, returnChangeType = F, returnCreatedTime = F, returnCurrentDisplayName = F, returnCurrentFieldWidth = F, returnCurrentIsRequired = F, returnCurrentName = F, returnCurrentPrecision = F, returnCurrentRelationshipOrFieldName = F, returnCurrentScale = F, returnCurrentSize = F, returnCurrentType = F, returnCurrentTypeCode = F, returnCustomizationID = F, returnFormattedFieldPath = F, returnHasChangedRelationships = F, returnIsDeniable = F, returnIsForeignKeyOfRelationship = F, returnIsInDB = F, returnIsPrimaryKey = F, returnIsSkywardField = F, returnModifiedTime = F, returnObjectID = F, returnPendingDisplayName = F, returnPendingFieldWidth = F, returnPendingIsRequired = F, returnPendingName = F, returnPendingPrecision = F, returnPendingRelationshipOrFieldName = F, returnPendingScale = F, returnPendingSize = F, returnPendingType = F, returnPendingTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUniqueIDString = F, returnUserCanEdit = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceDataTypeCode = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Field", FieldID, searchFields, EntityID)
}
#' Modify a specific Field
#'
#' This function modifies fields for a Field.
#'
#' @param FieldID The id of the Field to be modified.\cr Run \code{\link{getAllFields}} for a list of Fields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Field.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyField <- function(FieldID, EntityID = 1, setCurrentDisplayName = NULL, setCurrentFieldWidth = NULL, setCurrentIsRequired = NULL, setCurrentName = NULL, setCurrentPrecision = NULL, setCurrentRelationshipOrFieldName = NULL, setCurrentScale = NULL, setCurrentSize = NULL, setCurrentType = NULL, setCurrentTypeCode = NULL, setCustomizationID = NULL, setHasChangedRelationships = NULL, setIsDeniable = NULL, setIsForeignKeyOfRelationship = NULL, setIsInDB = NULL, setIsPrimaryKey = NULL, setIsSkywardField = NULL, setObjectID = NULL, setPendingDisplayName = NULL, setPendingFieldWidth = NULL, setPendingIsRequired = NULL, setPendingName = NULL, setPendingPrecision = NULL, setPendingRelationshipOrFieldName = NULL, setPendingScale = NULL, setPendingSize = NULL, setPendingType = NULL, setPendingTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUserCanEdit = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Field", FieldID, names(functionParams), functionParams, EntityID)
}
#' Create new Field.
#'
#' This function creates a new Field.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Field.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createField <- function(EntityID = 1, setCurrentDisplayName = NULL, setCurrentFieldWidth = NULL, setCurrentIsRequired = NULL, setCurrentName = NULL, setCurrentPrecision = NULL, setCurrentRelationshipOrFieldName = NULL, setCurrentScale = NULL, setCurrentSize = NULL, setCurrentType = NULL, setCurrentTypeCode = NULL, setCustomizationID = NULL, setHasChangedRelationships = NULL, setIsDeniable = NULL, setIsForeignKeyOfRelationship = NULL, setIsInDB = NULL, setIsPrimaryKey = NULL, setIsSkywardField = NULL, setObjectID = NULL, setPendingDisplayName = NULL, setPendingFieldWidth = NULL, setPendingIsRequired = NULL, setPendingName = NULL, setPendingPrecision = NULL, setPendingRelationshipOrFieldName = NULL, setPendingScale = NULL, setPendingSize = NULL, setPendingType = NULL, setPendingTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUserCanEdit = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Field", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Field
#'
#' This function deletes a Field.
#'
#' @param FieldID The id of the Field.\cr Run \code{\link{getAllFields}} for a list of Fields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Field.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteField <- function(FieldID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Field", FieldID, EntityID)
}
#' Get all FieldMappings.
#'
#' This function returns a dataframe of all FieldMappings in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FieldMappings in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFieldMappings <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFieldMappingID = F, returnActionIfSourceValueIsBlank = F, returnActionIfSourceValueIsBlankCode = F, returnCreatedTime = F, returnFieldID = F, returnImportDataObjectSourceID = F, returnImportDataObjectSourceIDMappedValue = F, returnMappingType = F, returnMappingTypeCode = F, returnModifiedTime = F, returnSourceDisplayName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FieldMapping", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FieldMapping
#'
#' This function returns fields for a FieldMapping.
#'
#' @param FieldMappingID The id of the FieldMapping.\cr Run \code{\link{getAllFieldMappings}} for a list of FieldMappings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FieldMapping.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFieldMapping <- function(FieldMappingID, EntityID = 1, returnFieldMappingID = F, returnActionIfSourceValueIsBlank = F, returnActionIfSourceValueIsBlankCode = F, returnCreatedTime = F, returnFieldID = F, returnImportDataObjectSourceID = F, returnImportDataObjectSourceIDMappedValue = F, returnMappingType = F, returnMappingTypeCode = F, returnModifiedTime = F, returnSourceDisplayName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValueSourceID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FieldMapping", FieldMappingID, searchFields, EntityID)
}
#' Modify a specific FieldMapping
#'
#' This function modifies fields for a FieldMapping.
#'
#' @param FieldMappingID The id of the FieldMapping to be modified.\cr Run \code{\link{getAllFieldMappings}} for a list of FieldMappings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FieldMapping.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFieldMapping <- function(FieldMappingID, EntityID = 1, setActionIfSourceValueIsBlank = NULL, setActionIfSourceValueIsBlankCode = NULL, setFieldID = NULL, setImportDataObjectSourceID = NULL, setImportDataObjectSourceIDMappedValue = NULL, setMappingType = NULL, setMappingTypeCode = NULL, setValueSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FieldMapping", FieldMappingID, names(functionParams), functionParams, EntityID)
}
#' Create new FieldMapping.
#'
#' This function creates a new FieldMapping.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FieldMapping.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFieldMapping <- function(EntityID = 1, setActionIfSourceValueIsBlank = NULL, setActionIfSourceValueIsBlankCode = NULL, setFieldID = NULL, setImportDataObjectSourceID = NULL, setImportDataObjectSourceIDMappedValue = NULL, setMappingType = NULL, setMappingTypeCode = NULL, setValueSourceID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FieldMapping", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FieldMapping
#'
#' This function deletes a FieldMapping.
#'
#' @param FieldMappingID The id of the FieldMapping.\cr Run \code{\link{getAllFieldMappings}} for a list of FieldMappings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FieldMapping.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFieldMapping <- function(FieldMappingID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FieldMapping", FieldMappingID, EntityID)
}
#' Get all FileDestinations.
#'
#' This function returns a dataframe of all FileDestinations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FileDestinations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFileDestinations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFileDestinationID = F, returnAllowRead = F, returnAllowWrite = F, returnCreatedTime = F, returnDistrictID = F, returnFTPConnectionID = F, returnIdentifyingInformation = F, returnIsFTPConnection = F, returnIsUNCPath = F, returnModifiedTime = F, returnName = F, returnUNCPathID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FileDestination", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FileDestination
#'
#' This function returns fields for a FileDestination.
#'
#' @param FileDestinationID The id of the FileDestination.\cr Run \code{\link{getAllFileDestinations}} for a list of FileDestinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FileDestination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFileDestination <- function(FileDestinationID, EntityID = 1, returnFileDestinationID = F, returnAllowRead = F, returnAllowWrite = F, returnCreatedTime = F, returnDistrictID = F, returnFTPConnectionID = F, returnIdentifyingInformation = F, returnIsFTPConnection = F, returnIsUNCPath = F, returnModifiedTime = F, returnName = F, returnUNCPathID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FileDestination", FileDestinationID, searchFields, EntityID)
}
#' Modify a specific FileDestination
#'
#' This function modifies fields for a FileDestination.
#'
#' @param FileDestinationID The id of the FileDestination to be modified.\cr Run \code{\link{getAllFileDestinations}} for a list of FileDestinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FileDestination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFileDestination <- function(FileDestinationID, EntityID = 1, setAllowRead = NULL, setAllowWrite = NULL, setDistrictID = NULL, setFTPConnectionID = NULL, setName = NULL, setUNCPathID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FileDestination", FileDestinationID, names(functionParams), functionParams, EntityID)
}
#' Create new FileDestination.
#'
#' This function creates a new FileDestination.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FileDestination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFileDestination <- function(EntityID = 1, setAllowRead = NULL, setAllowWrite = NULL, setDistrictID = NULL, setFTPConnectionID = NULL, setName = NULL, setUNCPathID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FileDestination", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FileDestination
#'
#' This function deletes a FileDestination.
#'
#' @param FileDestinationID The id of the FileDestination.\cr Run \code{\link{getAllFileDestinations}} for a list of FileDestinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FileDestination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFileDestination <- function(FileDestinationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FileDestination", FileDestinationID, EntityID)
}
#' Get all FileDestinationResults.
#'
#' This function returns a dataframe of all FileDestinationResults in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FileDestinationResults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFileDestinationResults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFileDestinationResultID = F, returnCreatedTime = F, returnFileDestinationID = F, returnFileName = F, returnLogID = F, returnMediaIDDownload = F, returnMessage = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnTransmissionType = F, returnTransmissionTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FileDestinationResult", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FileDestinationResult
#'
#' This function returns fields for a FileDestinationResult.
#'
#' @param FileDestinationResultID The id of the FileDestinationResult.\cr Run \code{\link{getAllFileDestinationResults}} for a list of FileDestinationResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FileDestinationResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFileDestinationResult <- function(FileDestinationResultID, EntityID = 1, returnFileDestinationResultID = F, returnCreatedTime = F, returnFileDestinationID = F, returnFileName = F, returnLogID = F, returnMediaIDDownload = F, returnMessage = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnTransmissionType = F, returnTransmissionTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FileDestinationResult", FileDestinationResultID, searchFields, EntityID)
}
#' Modify a specific FileDestinationResult
#'
#' This function modifies fields for a FileDestinationResult.
#'
#' @param FileDestinationResultID The id of the FileDestinationResult to be modified.\cr Run \code{\link{getAllFileDestinationResults}} for a list of FileDestinationResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FileDestinationResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFileDestinationResult <- function(FileDestinationResultID, EntityID = 1, setFileDestinationID = NULL, setFileName = NULL, setLogID = NULL, setMediaIDDownload = NULL, setMessage = NULL, setStatus = NULL, setStatusCode = NULL, setTransmissionType = NULL, setTransmissionTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FileDestinationResult", FileDestinationResultID, names(functionParams), functionParams, EntityID)
}
#' Create new FileDestinationResult.
#'
#' This function creates a new FileDestinationResult.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FileDestinationResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFileDestinationResult <- function(EntityID = 1, setFileDestinationID = NULL, setFileName = NULL, setLogID = NULL, setMediaIDDownload = NULL, setMessage = NULL, setStatus = NULL, setStatusCode = NULL, setTransmissionType = NULL, setTransmissionTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FileDestinationResult", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FileDestinationResult
#'
#' This function deletes a FileDestinationResult.
#'
#' @param FileDestinationResultID The id of the FileDestinationResult.\cr Run \code{\link{getAllFileDestinationResults}} for a list of FileDestinationResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FileDestinationResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFileDestinationResult <- function(FileDestinationResultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FileDestinationResult", FileDestinationResultID, EntityID)
}
#' Get all Filters.
#'
#' This function returns a dataframe of all Filters in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Filters in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFilters <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFilterID = F, returnComment = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnDistrictID = F, returnEntityID = F, returnFilterDataAdvanced = F, returnFilterDataAdvancedCondition = F, returnFilterDataColumn = F, returnFilterDataColumnCondition = F, returnFilterIDClonedFrom = F, returnFiscalYearID = F, returnFriendlyFilter = F, returnIsReusable = F, returnModifiedTime = F, returnName = F, returnSchoolYearID = F, returnSkywardHash = F, returnSkywardID = F, returnType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Filter", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Filter
#'
#' This function returns fields for a Filter.
#'
#' @param FilterID The id of the Filter.\cr Run \code{\link{getAllFilters}} for a list of Filters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Filter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFilter <- function(FilterID, EntityID = 1, returnFilterID = F, returnComment = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnDistrictID = F, returnEntityID = F, returnFilterDataAdvanced = F, returnFilterDataAdvancedCondition = F, returnFilterDataColumn = F, returnFilterDataColumnCondition = F, returnFilterIDClonedFrom = F, returnFiscalYearID = F, returnFriendlyFilter = F, returnIsReusable = F, returnModifiedTime = F, returnName = F, returnSchoolYearID = F, returnSkywardHash = F, returnSkywardID = F, returnType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Filter", FilterID, searchFields, EntityID)
}
#' Modify a specific Filter
#'
#' This function modifies fields for a Filter.
#'
#' @param FilterID The id of the Filter to be modified.\cr Run \code{\link{getAllFilters}} for a list of Filters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Filter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFilter <- function(FilterID, EntityID = 1, setComment = NULL, setDataModule = NULL, setDataObject = NULL, setDistrictID = NULL, setEntityID = NULL, setFilterDataAdvanced = NULL, setFilterDataColumn = NULL, setFilterIDClonedFrom = NULL, setFiscalYearID = NULL, setFriendlyFilter = NULL, setIsReusable = NULL, setName = NULL, setSchoolYearID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setType = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Filter", FilterID, names(functionParams), functionParams, EntityID)
}
#' Create new Filter.
#'
#' This function creates a new Filter.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Filter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFilter <- function(EntityID = 1, setComment = NULL, setDataModule = NULL, setDataObject = NULL, setDistrictID = NULL, setEntityID = NULL, setFilterDataAdvanced = NULL, setFilterDataColumn = NULL, setFilterIDClonedFrom = NULL, setFiscalYearID = NULL, setFriendlyFilter = NULL, setIsReusable = NULL, setName = NULL, setSchoolYearID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setType = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Filter", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Filter
#'
#' This function deletes a Filter.
#'
#' @param FilterID The id of the Filter.\cr Run \code{\link{getAllFilters}} for a list of Filters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Filter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFilter <- function(FilterID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Filter", FilterID, EntityID)
}
#' Get all FTPConnections.
#'
#' This function returns a dataframe of all FTPConnections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FTPConnections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFTPConnections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFTPConnectionID = F, returnAllowInvalidCertificate = F, returnCreatedTime = F, returnDescription = F, returnHost = F, returnMediaIDSSHKey = F, returnModifiedTime = F, returnName = F, returnPassword = F, returnPort = F, returnProtocol = F, returnProtocolCode = F, returnRemoteDirectory = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUsername = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FTPConnection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FTPConnection
#'
#' This function returns fields for a FTPConnection.
#'
#' @param FTPConnectionID The id of the FTPConnection.\cr Run \code{\link{getAllFTPConnections}} for a list of FTPConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FTPConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFTPConnection <- function(FTPConnectionID, EntityID = 1, returnFTPConnectionID = F, returnAllowInvalidCertificate = F, returnCreatedTime = F, returnDescription = F, returnHost = F, returnMediaIDSSHKey = F, returnModifiedTime = F, returnName = F, returnPassword = F, returnPort = F, returnProtocol = F, returnProtocolCode = F, returnRemoteDirectory = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUsername = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FTPConnection", FTPConnectionID, searchFields, EntityID)
}
#' Modify a specific FTPConnection
#'
#' This function modifies fields for a FTPConnection.
#'
#' @param FTPConnectionID The id of the FTPConnection to be modified.\cr Run \code{\link{getAllFTPConnections}} for a list of FTPConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FTPConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFTPConnection <- function(FTPConnectionID, EntityID = 1, setAllowInvalidCertificate = NULL, setDescription = NULL, setHost = NULL, setMediaIDSSHKey = NULL, setName = NULL, setPassword = NULL, setPort = NULL, setProtocol = NULL, setProtocolCode = NULL, setRemoteDirectory = NULL, setUsername = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FTPConnection", FTPConnectionID, names(functionParams), functionParams, EntityID)
}
#' Create new FTPConnection.
#'
#' This function creates a new FTPConnection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FTPConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFTPConnection <- function(EntityID = 1, setAllowInvalidCertificate = NULL, setDescription = NULL, setHost = NULL, setMediaIDSSHKey = NULL, setName = NULL, setPassword = NULL, setPort = NULL, setProtocol = NULL, setProtocolCode = NULL, setRemoteDirectory = NULL, setUsername = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FTPConnection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FTPConnection
#'
#' This function deletes a FTPConnection.
#'
#' @param FTPConnectionID The id of the FTPConnection.\cr Run \code{\link{getAllFTPConnections}} for a list of FTPConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FTPConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFTPConnection <- function(FTPConnectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FTPConnection", FTPConnectionID, EntityID)
}
#' Get all FTPProcessTypes.
#'
#' This function returns a dataframe of all FTPProcessTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FTPProcessTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFTPProcessTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFTPProcessTypeID = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnModuleName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FTPProcessType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FTPProcessType
#'
#' This function returns fields for a FTPProcessType.
#'
#' @param FTPProcessTypeID The id of the FTPProcessType.\cr Run \code{\link{getAllFTPProcessTypes}} for a list of FTPProcessTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FTPProcessType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFTPProcessType <- function(FTPProcessTypeID, EntityID = 1, returnFTPProcessTypeID = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnModuleName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FTPProcessType", FTPProcessTypeID, searchFields, EntityID)
}
#' Modify a specific FTPProcessType
#'
#' This function modifies fields for a FTPProcessType.
#'
#' @param FTPProcessTypeID The id of the FTPProcessType to be modified.\cr Run \code{\link{getAllFTPProcessTypes}} for a list of FTPProcessTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FTPProcessType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFTPProcessType <- function(FTPProcessTypeID, EntityID = 1, setDescription = NULL, setModuleName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FTPProcessType", FTPProcessTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new FTPProcessType.
#'
#' This function creates a new FTPProcessType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FTPProcessType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFTPProcessType <- function(EntityID = 1, setDescription = NULL, setModuleName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FTPProcessType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FTPProcessType
#'
#' This function deletes a FTPProcessType.
#'
#' @param FTPProcessTypeID The id of the FTPProcessType.\cr Run \code{\link{getAllFTPProcessTypes}} for a list of FTPProcessTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FTPProcessType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFTPProcessType <- function(FTPProcessTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FTPProcessType", FTPProcessTypeID, EntityID)
}
#' Get all FTPProcessTypeConnections.
#'
#' This function returns a dataframe of all FTPProcessTypeConnections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FTPProcessTypeConnections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFTPProcessTypeConnections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFTPProcessTypeConnectionID = F, returnCreatedTime = F, returnDistrictID = F, returnFTPConnectionID = F, returnFTPProcessTypeID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FTPProcessTypeConnection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FTPProcessTypeConnection
#'
#' This function returns fields for a FTPProcessTypeConnection.
#'
#' @param FTPProcessTypeConnectionID The id of the FTPProcessTypeConnection.\cr Run \code{\link{getAllFTPProcessTypeConnections}} for a list of FTPProcessTypeConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FTPProcessTypeConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFTPProcessTypeConnection <- function(FTPProcessTypeConnectionID, EntityID = 1, returnFTPProcessTypeConnectionID = F, returnCreatedTime = F, returnDistrictID = F, returnFTPConnectionID = F, returnFTPProcessTypeID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FTPProcessTypeConnection", FTPProcessTypeConnectionID, searchFields, EntityID)
}
#' Modify a specific FTPProcessTypeConnection
#'
#' This function modifies fields for a FTPProcessTypeConnection.
#'
#' @param FTPProcessTypeConnectionID The id of the FTPProcessTypeConnection to be modified.\cr Run \code{\link{getAllFTPProcessTypeConnections}} for a list of FTPProcessTypeConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FTPProcessTypeConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFTPProcessTypeConnection <- function(FTPProcessTypeConnectionID, EntityID = 1, setDistrictID = NULL, setFTPConnectionID = NULL, setFTPProcessTypeID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FTPProcessTypeConnection", FTPProcessTypeConnectionID, names(functionParams), functionParams, EntityID)
}
#' Create new FTPProcessTypeConnection.
#'
#' This function creates a new FTPProcessTypeConnection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FTPProcessTypeConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFTPProcessTypeConnection <- function(EntityID = 1, setDistrictID = NULL, setFTPConnectionID = NULL, setFTPProcessTypeID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FTPProcessTypeConnection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FTPProcessTypeConnection
#'
#' This function deletes a FTPProcessTypeConnection.
#'
#' @param FTPProcessTypeConnectionID The id of the FTPProcessTypeConnection.\cr Run \code{\link{getAllFTPProcessTypeConnections}} for a list of FTPProcessTypeConnections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FTPProcessTypeConnection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFTPProcessTypeConnection <- function(FTPProcessTypeConnectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FTPProcessTypeConnection", FTPProcessTypeConnectionID, EntityID)
}
#' Get all FTPResults.
#'
#' This function returns a dataframe of all FTPResults in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All FTPResults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFTPResults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFTPResultID = F, returnCreatedTime = F, returnFileName = F, returnFTPConnectionID = F, returnLogID = F, returnMediaIDDownload = F, returnMessage = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnTransmissionType = F, returnTransmissionTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "FTPResult", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FTPResult
#'
#' This function returns fields for a FTPResult.
#'
#' @param FTPResultID The id of the FTPResult.\cr Run \code{\link{getAllFTPResults}} for a list of FTPResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the FTPResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFTPResult <- function(FTPResultID, EntityID = 1, returnFTPResultID = F, returnCreatedTime = F, returnFileName = F, returnFTPConnectionID = F, returnLogID = F, returnMediaIDDownload = F, returnMessage = F, returnModifiedTime = F, returnStatus = F, returnStatusCode = F, returnTransmissionType = F, returnTransmissionTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "FTPResult", FTPResultID, searchFields, EntityID)
}
#' Modify a specific FTPResult
#'
#' This function modifies fields for a FTPResult.
#'
#' @param FTPResultID The id of the FTPResult to be modified.\cr Run \code{\link{getAllFTPResults}} for a list of FTPResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified FTPResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFTPResult <- function(FTPResultID, EntityID = 1, setFileName = NULL, setFTPConnectionID = NULL, setLogID = NULL, setMediaIDDownload = NULL, setMessage = NULL, setStatus = NULL, setStatusCode = NULL, setTransmissionType = NULL, setTransmissionTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "FTPResult", FTPResultID, names(functionParams), functionParams, EntityID)
}
#' Create new FTPResult.
#'
#' This function creates a new FTPResult.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created FTPResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFTPResult <- function(EntityID = 1, setFileName = NULL, setFTPConnectionID = NULL, setLogID = NULL, setMediaIDDownload = NULL, setMessage = NULL, setStatus = NULL, setStatusCode = NULL, setTransmissionType = NULL, setTransmissionTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "FTPResult", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FTPResult
#'
#' This function deletes a FTPResult.
#'
#' @param FTPResultID The id of the FTPResult.\cr Run \code{\link{getAllFTPResults}} for a list of FTPResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted FTPResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFTPResult <- function(FTPResultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "FTPResult", FTPResultID, EntityID)
}
#' Get all Imports.
#'
#' This function returns a dataframe of all Imports in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Imports in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImports <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportID = F, returnAcceptedFileTypes = F, returnColumnsJSON = F, returnCreatedTime = F, returnDateFormat = F, returnDateFormatCode = F, returnDefinition = F, returnDelimiter = F, returnDescription = F, returnFileHasHeaderRow = F, returnFileType = F, returnFileTypeCode = F, returnHasPromptsFromDefinition = F, returnIsFixedWidth = F, returnIsSkywardImport = F, returnModifiedTime = F, returnName = F, returnNumberOfHeaderRows = F, returnPromptList = F, returnPromptListJson = F, returnSkywardID = F, returnTextQualifier = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Import", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Import
#'
#' This function returns fields for an Import.
#'
#' @param ImportID The id of the Import.\cr Run \code{\link{getAllImports}} for a list of Imports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Import.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImport <- function(ImportID, EntityID = 1, returnImportID = F, returnAcceptedFileTypes = F, returnColumnsJSON = F, returnCreatedTime = F, returnDateFormat = F, returnDateFormatCode = F, returnDefinition = F, returnDelimiter = F, returnDescription = F, returnFileHasHeaderRow = F, returnFileType = F, returnFileTypeCode = F, returnHasPromptsFromDefinition = F, returnIsFixedWidth = F, returnIsSkywardImport = F, returnModifiedTime = F, returnName = F, returnNumberOfHeaderRows = F, returnPromptList = F, returnPromptListJson = F, returnSkywardID = F, returnTextQualifier = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Import", ImportID, searchFields, EntityID)
}
#' Modify a specific Import
#'
#' This function modifies fields for an Import.
#'
#' @param ImportID The id of the Import to be modified.\cr Run \code{\link{getAllImports}} for a list of Imports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Import.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImport <- function(ImportID, EntityID = 1, setColumnsJSON = NULL, setDateFormat = NULL, setDateFormatCode = NULL, setDescription = NULL, setFileHasHeaderRow = NULL, setFileType = NULL, setFileTypeCode = NULL, setIsFixedWidth = NULL, setName = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Import", ImportID, names(functionParams), functionParams, EntityID)
}
#' Create new Import.
#'
#' This function creates a new Import.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Import.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImport <- function(EntityID = 1, setColumnsJSON = NULL, setDateFormat = NULL, setDateFormatCode = NULL, setDescription = NULL, setFileHasHeaderRow = NULL, setFileType = NULL, setFileTypeCode = NULL, setIsFixedWidth = NULL, setName = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Import", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Import
#'
#' This function deletes an Import.
#'
#' @param ImportID The id of the Import.\cr Run \code{\link{getAllImports}} for a list of Imports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Import.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImport <- function(ImportID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Import", ImportID, EntityID)
}
#' Get all ImportDataObjectSources.
#'
#' This function returns a dataframe of all ImportDataObjectSources in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ImportDataObjectSources in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImportDataObjectSources <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportDataObjectSourceID = F, returnAction = F, returnActionCode = F, returnCanAddFieldMapping = F, returnCreatedTime = F, returnHasFieldMappings = F, returnImportID = F, returnIsPrimary = F, returnMatchAction = F, returnMatchActionCode = F, returnModifiedTime = F, returnName = F, returnNoMatchAction = F, returnNoMatchActionCode = F, returnObjectID = F, returnUniqueKey = F, returnUpdateSearchCondition = F, returnUpdateSearchXML = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ImportDataObjectSource", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ImportDataObjectSource
#'
#' This function returns fields for an ImportDataObjectSource.
#'
#' @param ImportDataObjectSourceID The id of the ImportDataObjectSource.\cr Run \code{\link{getAllImportDataObjectSources}} for a list of ImportDataObjectSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ImportDataObjectSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImportDataObjectSource <- function(ImportDataObjectSourceID, EntityID = 1, returnImportDataObjectSourceID = F, returnAction = F, returnActionCode = F, returnCanAddFieldMapping = F, returnCreatedTime = F, returnHasFieldMappings = F, returnImportID = F, returnIsPrimary = F, returnMatchAction = F, returnMatchActionCode = F, returnModifiedTime = F, returnName = F, returnNoMatchAction = F, returnNoMatchActionCode = F, returnObjectID = F, returnUniqueKey = F, returnUpdateSearchCondition = F, returnUpdateSearchXML = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ImportDataObjectSource", ImportDataObjectSourceID, searchFields, EntityID)
}
#' Modify a specific ImportDataObjectSource
#'
#' This function modifies fields for an ImportDataObjectSource.
#'
#' @param ImportDataObjectSourceID The id of the ImportDataObjectSource to be modified.\cr Run \code{\link{getAllImportDataObjectSources}} for a list of ImportDataObjectSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ImportDataObjectSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImportDataObjectSource <- function(ImportDataObjectSourceID, EntityID = 1, setAction = NULL, setActionCode = NULL, setHasFieldMappings = NULL, setImportID = NULL, setIsPrimary = NULL, setMatchAction = NULL, setMatchActionCode = NULL, setName = NULL, setNoMatchAction = NULL, setNoMatchActionCode = NULL, setObjectID = NULL, setUpdateSearchXML = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ImportDataObjectSource", ImportDataObjectSourceID, names(functionParams), functionParams, EntityID)
}
#' Create new ImportDataObjectSource.
#'
#' This function creates a new ImportDataObjectSource.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ImportDataObjectSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImportDataObjectSource <- function(EntityID = 1, setAction = NULL, setActionCode = NULL, setHasFieldMappings = NULL, setImportID = NULL, setIsPrimary = NULL, setMatchAction = NULL, setMatchActionCode = NULL, setName = NULL, setNoMatchAction = NULL, setNoMatchActionCode = NULL, setObjectID = NULL, setUpdateSearchXML = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ImportDataObjectSource", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ImportDataObjectSource
#'
#' This function deletes an ImportDataObjectSource.
#'
#' @param ImportDataObjectSourceID The id of the ImportDataObjectSource.\cr Run \code{\link{getAllImportDataObjectSources}} for a list of ImportDataObjectSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ImportDataObjectSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImportDataObjectSource <- function(ImportDataObjectSourceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ImportDataObjectSource", ImportDataObjectSourceID, EntityID)
}
#' Get all ImportModulePaths.
#'
#' This function returns a dataframe of all ImportModulePaths in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ImportModulePaths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImportModulePaths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportModulePathID = F, returnCreatedTime = F, returnImportID = F, returnModifiedTime = F, returnModulePathID = F, returnPromptDataSources = F, returnPromptDataSourcesJson = F, returnSourceSchemaObject = F, returnSourceTypeName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ImportModulePath", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ImportModulePath
#'
#' This function returns fields for an ImportModulePath.
#'
#' @param ImportModulePathID The id of the ImportModulePath.\cr Run \code{\link{getAllImportModulePaths}} for a list of ImportModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ImportModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImportModulePath <- function(ImportModulePathID, EntityID = 1, returnImportModulePathID = F, returnCreatedTime = F, returnImportID = F, returnModifiedTime = F, returnModulePathID = F, returnPromptDataSources = F, returnPromptDataSourcesJson = F, returnSourceSchemaObject = F, returnSourceTypeName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ImportModulePath", ImportModulePathID, searchFields, EntityID)
}
#' Modify a specific ImportModulePath
#'
#' This function modifies fields for an ImportModulePath.
#'
#' @param ImportModulePathID The id of the ImportModulePath to be modified.\cr Run \code{\link{getAllImportModulePaths}} for a list of ImportModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ImportModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImportModulePath <- function(ImportModulePathID, EntityID = 1, setImportID = NULL, setModulePathID = NULL, setPromptDataSourcesJson = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ImportModulePath", ImportModulePathID, names(functionParams), functionParams, EntityID)
}
#' Create new ImportModulePath.
#'
#' This function creates a new ImportModulePath.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ImportModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImportModulePath <- function(EntityID = 1, setImportID = NULL, setModulePathID = NULL, setPromptDataSourcesJson = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ImportModulePath", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ImportModulePath
#'
#' This function deletes an ImportModulePath.
#'
#' @param ImportModulePathID The id of the ImportModulePath.\cr Run \code{\link{getAllImportModulePaths}} for a list of ImportModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ImportModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImportModulePath <- function(ImportModulePathID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ImportModulePath", ImportModulePathID, EntityID)
}
#' Get all ImportResults.
#'
#' This function returns a dataframe of all ImportResults in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ImportResults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImportResults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportResultID = F, returnCanBeDeleted = F, returnCreatedTime = F, returnFailedRecordCount = F, returnHasMediaFailedRows = F, returnImportID = F, returnLastProcessedRowNumber = F, returnMediaIDFailedRows = F, returnMediaIDOriginalImportedData = F, returnModifiedTime = F, returnResultRowCount = F, returnStatus = F, returnStatusCode = F, returnSuccessfulRecordCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWarningRecordCount = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ImportResult", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ImportResult
#'
#' This function returns fields for an ImportResult.
#'
#' @param ImportResultID The id of the ImportResult.\cr Run \code{\link{getAllImportResults}} for a list of ImportResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ImportResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImportResult <- function(ImportResultID, EntityID = 1, returnImportResultID = F, returnCanBeDeleted = F, returnCreatedTime = F, returnFailedRecordCount = F, returnHasMediaFailedRows = F, returnImportID = F, returnLastProcessedRowNumber = F, returnMediaIDFailedRows = F, returnMediaIDOriginalImportedData = F, returnModifiedTime = F, returnResultRowCount = F, returnStatus = F, returnStatusCode = F, returnSuccessfulRecordCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWarningRecordCount = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ImportResult", ImportResultID, searchFields, EntityID)
}
#' Modify a specific ImportResult
#'
#' This function modifies fields for an ImportResult.
#'
#' @param ImportResultID The id of the ImportResult to be modified.\cr Run \code{\link{getAllImportResults}} for a list of ImportResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ImportResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImportResult <- function(ImportResultID, EntityID = 1, setFailedRecordCount = NULL, setImportID = NULL, setMediaIDFailedRows = NULL, setMediaIDOriginalImportedData = NULL, setStatus = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ImportResult", ImportResultID, names(functionParams), functionParams, EntityID)
}
#' Create new ImportResult.
#'
#' This function creates a new ImportResult.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ImportResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImportResult <- function(EntityID = 1, setFailedRecordCount = NULL, setImportID = NULL, setMediaIDFailedRows = NULL, setMediaIDOriginalImportedData = NULL, setStatus = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ImportResult", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ImportResult
#'
#' This function deletes an ImportResult.
#'
#' @param ImportResultID The id of the ImportResult.\cr Run \code{\link{getAllImportResults}} for a list of ImportResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ImportResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImportResult <- function(ImportResultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ImportResult", ImportResultID, EntityID)
}
#' Get all ImportResultRows.
#'
#' This function returns a dataframe of all ImportResultRows in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ImportResultRows in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImportResultRows <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportResultRowID = F, returnCreatedTime = F, returnErrorMessage = F, returnFailedRowFileRowNumber = F, returnImportFileRowNumber = F, returnImportResultID = F, returnModifiedTime = F, returnResultType = F, returnResultTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ImportResultRow", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ImportResultRow
#'
#' This function returns fields for an ImportResultRow.
#'
#' @param ImportResultRowID The id of the ImportResultRow.\cr Run \code{\link{getAllImportResultRows}} for a list of ImportResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ImportResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImportResultRow <- function(ImportResultRowID, EntityID = 1, returnImportResultRowID = F, returnCreatedTime = F, returnErrorMessage = F, returnFailedRowFileRowNumber = F, returnImportFileRowNumber = F, returnImportResultID = F, returnModifiedTime = F, returnResultType = F, returnResultTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ImportResultRow", ImportResultRowID, searchFields, EntityID)
}
#' Modify a specific ImportResultRow
#'
#' This function modifies fields for an ImportResultRow.
#'
#' @param ImportResultRowID The id of the ImportResultRow to be modified.\cr Run \code{\link{getAllImportResultRows}} for a list of ImportResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ImportResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImportResultRow <- function(ImportResultRowID, EntityID = 1, setErrorMessage = NULL, setFailedRowFileRowNumber = NULL, setImportFileRowNumber = NULL, setImportResultID = NULL, setResultType = NULL, setResultTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ImportResultRow", ImportResultRowID, names(functionParams), functionParams, EntityID)
}
#' Create new ImportResultRow.
#'
#' This function creates a new ImportResultRow.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ImportResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImportResultRow <- function(EntityID = 1, setErrorMessage = NULL, setFailedRowFileRowNumber = NULL, setImportFileRowNumber = NULL, setImportResultID = NULL, setResultType = NULL, setResultTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ImportResultRow", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ImportResultRow
#'
#' This function deletes an ImportResultRow.
#'
#' @param ImportResultRowID The id of the ImportResultRow.\cr Run \code{\link{getAllImportResultRows}} for a list of ImportResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ImportResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImportResultRow <- function(ImportResultRowID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ImportResultRow", ImportResultRowID, EntityID)
}
#' Get all ImportResultRowDetails.
#'
#' This function returns a dataframe of all ImportResultRowDetails in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ImportResultRowDetails in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllImportResultRowDetails <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnImportResultRowDetailID = F, returnActionType = F, returnActionTypeCode = F, returnBeforeImportModifiedTime = F, returnCreatedTime = F, returnImportResultRowID = F, returnModifiedTime = F, returnObjectID = F, returnObjectPrimaryKey = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ImportResultRowDetail", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ImportResultRowDetail
#'
#' This function returns fields for an ImportResultRowDetail.
#'
#' @param ImportResultRowDetailID The id of the ImportResultRowDetail.\cr Run \code{\link{getAllImportResultRowDetails}} for a list of ImportResultRowDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ImportResultRowDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getImportResultRowDetail <- function(ImportResultRowDetailID, EntityID = 1, returnImportResultRowDetailID = F, returnActionType = F, returnActionTypeCode = F, returnBeforeImportModifiedTime = F, returnCreatedTime = F, returnImportResultRowID = F, returnModifiedTime = F, returnObjectID = F, returnObjectPrimaryKey = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ImportResultRowDetail", ImportResultRowDetailID, searchFields, EntityID)
}
#' Modify a specific ImportResultRowDetail
#'
#' This function modifies fields for an ImportResultRowDetail.
#'
#' @param ImportResultRowDetailID The id of the ImportResultRowDetail to be modified.\cr Run \code{\link{getAllImportResultRowDetails}} for a list of ImportResultRowDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ImportResultRowDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyImportResultRowDetail <- function(ImportResultRowDetailID, EntityID = 1, setActionType = NULL, setActionTypeCode = NULL, setBeforeImportModifiedTime = NULL, setImportResultRowID = NULL, setObjectID = NULL, setObjectPrimaryKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ImportResultRowDetail", ImportResultRowDetailID, names(functionParams), functionParams, EntityID)
}
#' Create new ImportResultRowDetail.
#'
#' This function creates a new ImportResultRowDetail.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ImportResultRowDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createImportResultRowDetail <- function(EntityID = 1, setActionType = NULL, setActionTypeCode = NULL, setBeforeImportModifiedTime = NULL, setImportResultRowID = NULL, setObjectID = NULL, setObjectPrimaryKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ImportResultRowDetail", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ImportResultRowDetail
#'
#' This function deletes an ImportResultRowDetail.
#'
#' @param ImportResultRowDetailID The id of the ImportResultRowDetail.\cr Run \code{\link{getAllImportResultRowDetails}} for a list of ImportResultRowDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ImportResultRowDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteImportResultRowDetail <- function(ImportResultRowDetailID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ImportResultRowDetail", ImportResultRowDetailID, EntityID)
}
#' Get all IndexStatisticsAlwaysUpdates.
#'
#' This function returns a dataframe of all IndexStatisticsAlwaysUpdates in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All IndexStatisticsAlwaysUpdates in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIndexStatisticsAlwaysUpdates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIndexStatisticsAlwaysUpdateID = F, returnSchemaName = F, returnSkywardHash = F, returnSkywardID = F, returnTableName = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "IndexStatisticsAlwaysUpdate", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IndexStatisticsAlwaysUpdate
#'
#' This function returns fields for an IndexStatisticsAlwaysUpdate.
#'
#' @param IndexStatisticsAlwaysUpdateID The id of the IndexStatisticsAlwaysUpdate.\cr Run \code{\link{getAllIndexStatisticsAlwaysUpdates}} for a list of IndexStatisticsAlwaysUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the IndexStatisticsAlwaysUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIndexStatisticsAlwaysUpdate <- function(IndexStatisticsAlwaysUpdateID, EntityID = 1, returnIndexStatisticsAlwaysUpdateID = F, returnSchemaName = F, returnSkywardHash = F, returnSkywardID = F, returnTableName = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "IndexStatisticsAlwaysUpdate", IndexStatisticsAlwaysUpdateID, searchFields, EntityID)
}
#' Modify a specific IndexStatisticsAlwaysUpdate
#'
#' This function modifies fields for an IndexStatisticsAlwaysUpdate.
#'
#' @param IndexStatisticsAlwaysUpdateID The id of the IndexStatisticsAlwaysUpdate to be modified.\cr Run \code{\link{getAllIndexStatisticsAlwaysUpdates}} for a list of IndexStatisticsAlwaysUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified IndexStatisticsAlwaysUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIndexStatisticsAlwaysUpdate <- function(IndexStatisticsAlwaysUpdateID, EntityID = 1, setSchemaName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTableName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "IndexStatisticsAlwaysUpdate", IndexStatisticsAlwaysUpdateID, names(functionParams), functionParams, EntityID)
}
#' Create new IndexStatisticsAlwaysUpdate.
#'
#' This function creates a new IndexStatisticsAlwaysUpdate.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created IndexStatisticsAlwaysUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIndexStatisticsAlwaysUpdate <- function(EntityID = 1, setSchemaName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTableName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "IndexStatisticsAlwaysUpdate", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IndexStatisticsAlwaysUpdate
#'
#' This function deletes an IndexStatisticsAlwaysUpdate.
#'
#' @param IndexStatisticsAlwaysUpdateID The id of the IndexStatisticsAlwaysUpdate.\cr Run \code{\link{getAllIndexStatisticsAlwaysUpdates}} for a list of IndexStatisticsAlwaysUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted IndexStatisticsAlwaysUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIndexStatisticsAlwaysUpdate <- function(IndexStatisticsAlwaysUpdateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "IndexStatisticsAlwaysUpdate", IndexStatisticsAlwaysUpdateID, EntityID)
}
#' Get all Kiosks.
#'
#' This function returns a dataframe of all Kiosks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Kiosks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllKiosks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnKioskID = F, returnCreatedTime = F, returnIPAddress = F, returnIsTardyKiosk = F, returnModifiedTime = F, returnName = F, returnPrinterType = F, returnPrinterTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Kiosk", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Kiosk
#'
#' This function returns fields for a Kiosk.
#'
#' @param KioskID The id of the Kiosk.\cr Run \code{\link{getAllKiosks}} for a list of Kiosks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Kiosk.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getKiosk <- function(KioskID, EntityID = 1, returnKioskID = F, returnCreatedTime = F, returnIPAddress = F, returnIsTardyKiosk = F, returnModifiedTime = F, returnName = F, returnPrinterType = F, returnPrinterTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Kiosk", KioskID, searchFields, EntityID)
}
#' Modify a specific Kiosk
#'
#' This function modifies fields for a Kiosk.
#'
#' @param KioskID The id of the Kiosk to be modified.\cr Run \code{\link{getAllKiosks}} for a list of Kiosks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Kiosk.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyKiosk <- function(KioskID, EntityID = 1, setIPAddress = NULL, setIsTardyKiosk = NULL, setName = NULL, setPrinterType = NULL, setPrinterTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Kiosk", KioskID, names(functionParams), functionParams, EntityID)
}
#' Create new Kiosk.
#'
#' This function creates a new Kiosk.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Kiosk.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createKiosk <- function(EntityID = 1, setIPAddress = NULL, setIsTardyKiosk = NULL, setName = NULL, setPrinterType = NULL, setPrinterTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Kiosk", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Kiosk
#'
#' This function deletes a Kiosk.
#'
#' @param KioskID The id of the Kiosk.\cr Run \code{\link{getAllKiosks}} for a list of Kiosks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Kiosk.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteKiosk <- function(KioskID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Kiosk", KioskID, EntityID)
}
#' Get all Logs.
#'
#' This function returns a dataframe of all Logs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Logs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLogs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLogID = F, returnActivityContext = F, returnApplication = F, returnApplicationMonitoringIdentifier = F, returnBindingEscapedMessage = F, returnClassification = F, returnClassificationCode = F, returnCreatedTime = F, returnDataObjectID = F, returnDataObjectType = F, returnDetails = F, returnHostname = F, returnMessage = F, returnModifiedTime = F, returnProcessID = F, returnSeverity = F, returnSeverityCode = F, returnSourceFile = F, returnStackTrace = F, returnSystemVersion = F, returnThreadName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Log", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Log
#'
#' This function returns fields for a Log.
#'
#' @param LogID The id of the Log.\cr Run \code{\link{getAllLogs}} for a list of Logs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Log.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLog <- function(LogID, EntityID = 1, returnLogID = F, returnActivityContext = F, returnApplication = F, returnApplicationMonitoringIdentifier = F, returnBindingEscapedMessage = F, returnClassification = F, returnClassificationCode = F, returnCreatedTime = F, returnDataObjectID = F, returnDataObjectType = F, returnDetails = F, returnHostname = F, returnMessage = F, returnModifiedTime = F, returnProcessID = F, returnSeverity = F, returnSeverityCode = F, returnSourceFile = F, returnStackTrace = F, returnSystemVersion = F, returnThreadName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Log", LogID, searchFields, EntityID)
}
#' Modify a specific Log
#'
#' This function modifies fields for a Log.
#'
#' @param LogID The id of the Log to be modified.\cr Run \code{\link{getAllLogs}} for a list of Logs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Log.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLog <- function(LogID, EntityID = 1, setActivityContext = NULL, setApplication = NULL, setApplicationMonitoringIdentifier = NULL, setClassification = NULL, setClassificationCode = NULL, setDataObjectID = NULL, setDataObjectType = NULL, setDetails = NULL, setHostname = NULL, setMessage = NULL, setProcessID = NULL, setSeverity = NULL, setSeverityCode = NULL, setSourceFile = NULL, setStackTrace = NULL, setSystemVersion = NULL, setThreadName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Log", LogID, names(functionParams), functionParams, EntityID)
}
#' Create new Log.
#'
#' This function creates a new Log.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Log.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLog <- function(EntityID = 1, setActivityContext = NULL, setApplication = NULL, setApplicationMonitoringIdentifier = NULL, setClassification = NULL, setClassificationCode = NULL, setDataObjectID = NULL, setDataObjectType = NULL, setDetails = NULL, setHostname = NULL, setMessage = NULL, setProcessID = NULL, setSeverity = NULL, setSeverityCode = NULL, setSourceFile = NULL, setStackTrace = NULL, setSystemVersion = NULL, setThreadName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Log", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Log
#'
#' This function deletes a Log.
#'
#' @param LogID The id of the Log.\cr Run \code{\link{getAllLogs}} for a list of Logs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Log.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLog <- function(LogID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Log", LogID, EntityID)
}
#' Get all LoginHistories.
#'
#' This function returns a dataframe of all LoginHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All LoginHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLoginHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLoginHistoryID = F, returnBrowserType = F, returnBrowserVersion = F, returnCreatedTime = F, returnDeviceType = F, returnEnteredUserName = F, returnHostAddress = F, returnIsSuccessfulLogin = F, returnModifiedTime = F, returnOperatingSystemType = F, returnUserAgent = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "LoginHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific LoginHistory
#'
#' This function returns fields for a LoginHistory.
#'
#' @param LoginHistoryID The id of the LoginHistory.\cr Run \code{\link{getAllLoginHistories}} for a list of LoginHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the LoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLoginHistory <- function(LoginHistoryID, EntityID = 1, returnLoginHistoryID = F, returnBrowserType = F, returnBrowserVersion = F, returnCreatedTime = F, returnDeviceType = F, returnEnteredUserName = F, returnHostAddress = F, returnIsSuccessfulLogin = F, returnModifiedTime = F, returnOperatingSystemType = F, returnUserAgent = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "LoginHistory", LoginHistoryID, searchFields, EntityID)
}
#' Modify a specific LoginHistory
#'
#' This function modifies fields for a LoginHistory.
#'
#' @param LoginHistoryID The id of the LoginHistory to be modified.\cr Run \code{\link{getAllLoginHistories}} for a list of LoginHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified LoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLoginHistory <- function(LoginHistoryID, EntityID = 1, setBrowserType = NULL, setBrowserVersion = NULL, setDeviceType = NULL, setEnteredUserName = NULL, setHostAddress = NULL, setIsSuccessfulLogin = NULL, setOperatingSystemType = NULL, setUserAgent = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "LoginHistory", LoginHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new LoginHistory.
#'
#' This function creates a new LoginHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created LoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLoginHistory <- function(EntityID = 1, setBrowserType = NULL, setBrowserVersion = NULL, setDeviceType = NULL, setEnteredUserName = NULL, setHostAddress = NULL, setIsSuccessfulLogin = NULL, setOperatingSystemType = NULL, setUserAgent = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "LoginHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific LoginHistory
#'
#' This function deletes a LoginHistory.
#'
#' @param LoginHistoryID The id of the LoginHistory.\cr Run \code{\link{getAllLoginHistories}} for a list of LoginHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted LoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLoginHistory <- function(LoginHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "LoginHistory", LoginHistoryID, EntityID)
}
#' Get all Medias.
#'
#' This function returns a dataframe of all Medias in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Medias in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMedias <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMediaID = F, returnBytes = F, returnCreatedTime = F, returnHash = F, returnLibraryType = F, returnLibraryTypeCode = F, returnMediaDataID = F, returnMediaDataIDLargeThumbnail = F, returnMediaDataIDSmallThumbnail = F, returnMediaTypeID = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnStorageLocation = F, returnStorageLocationCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnXDimension = F, returnYDimension = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Media", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Media
#'
#' This function returns fields for a Media.
#'
#' @param MediaID The id of the Media.\cr Run \code{\link{getAllMedias}} for a list of Medias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Media.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMedia <- function(MediaID, EntityID = 1, returnMediaID = F, returnBytes = F, returnCreatedTime = F, returnHash = F, returnLibraryType = F, returnLibraryTypeCode = F, returnMediaDataID = F, returnMediaDataIDLargeThumbnail = F, returnMediaDataIDSmallThumbnail = F, returnMediaTypeID = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnStorageLocation = F, returnStorageLocationCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnXDimension = F, returnYDimension = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Media", MediaID, searchFields, EntityID)
}
#' Modify a specific Media
#'
#' This function modifies fields for a Media.
#'
#' @param MediaID The id of the Media to be modified.\cr Run \code{\link{getAllMedias}} for a list of Medias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Media.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMedia <- function(MediaID, EntityID = 1, setBytes = NULL, setHash = NULL, setLibraryType = NULL, setMediaDataID = NULL, setMediaDataIDLargeThumbnail = NULL, setMediaDataIDSmallThumbnail = NULL, setMediaTypeID = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStorageLocation = NULL, setXDimension = NULL, setYDimension = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Media", MediaID, names(functionParams), functionParams, EntityID)
}
#' Create new Media.
#'
#' This function creates a new Media.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Media.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMedia <- function(EntityID = 1, setBytes = NULL, setHash = NULL, setLibraryType = NULL, setMediaDataID = NULL, setMediaDataIDLargeThumbnail = NULL, setMediaDataIDSmallThumbnail = NULL, setMediaTypeID = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStorageLocation = NULL, setXDimension = NULL, setYDimension = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Media", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Media
#'
#' This function deletes a Media.
#'
#' @param MediaID The id of the Media.\cr Run \code{\link{getAllMedias}} for a list of Medias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Media.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMedia <- function(MediaID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Media", MediaID, EntityID)
}
#' Get all MediaTypes.
#'
#' This function returns a dataframe of all MediaTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All MediaTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMediaTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMediaTypeID = F, returnAllowAttachment = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnMimeType = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "MediaType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific MediaType
#'
#' This function returns fields for a MediaType.
#'
#' @param MediaTypeID The id of the MediaType.\cr Run \code{\link{getAllMediaTypes}} for a list of MediaTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the MediaType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMediaType <- function(MediaTypeID, EntityID = 1, returnMediaTypeID = F, returnAllowAttachment = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnMimeType = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "MediaType", MediaTypeID, searchFields, EntityID)
}
#' Modify a specific MediaType
#'
#' This function modifies fields for a MediaType.
#'
#' @param MediaTypeID The id of the MediaType to be modified.\cr Run \code{\link{getAllMediaTypes}} for a list of MediaTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified MediaType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMediaType <- function(MediaTypeID, EntityID = 1, setAllowAttachment = NULL, setCode = NULL, setDescription = NULL, setMimeType = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "MediaType", MediaTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new MediaType.
#'
#' This function creates a new MediaType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created MediaType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMediaType <- function(EntityID = 1, setAllowAttachment = NULL, setCode = NULL, setDescription = NULL, setMimeType = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "MediaType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific MediaType
#'
#' This function deletes a MediaType.
#'
#' @param MediaTypeID The id of the MediaType.\cr Run \code{\link{getAllMediaTypes}} for a list of MediaTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted MediaType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMediaType <- function(MediaTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "MediaType", MediaTypeID, EntityID)
}
#' Get all MenuCategories.
#'
#' This function returns a dataframe of all MenuCategories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All MenuCategories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMenuCategories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMenuCategoryID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveIsDefault = F, returnIsDefault = F, returnIsEnabled = F, returnIsSkywardMenuCategory = F, returnMenuModuleID = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "MenuCategory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific MenuCategory
#'
#' This function returns fields for a MenuCategory.
#'
#' @param MenuCategoryID The id of the MenuCategory.\cr Run \code{\link{getAllMenuCategories}} for a list of MenuCategories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the MenuCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMenuCategory <- function(MenuCategoryID, EntityID = 1, returnMenuCategoryID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveIsDefault = F, returnIsDefault = F, returnIsEnabled = F, returnIsSkywardMenuCategory = F, returnMenuModuleID = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardIsDefault = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "MenuCategory", MenuCategoryID, searchFields, EntityID)
}
#' Modify a specific MenuCategory
#'
#' This function modifies fields for a MenuCategory.
#'
#' @param MenuCategoryID The id of the MenuCategory to be modified.\cr Run \code{\link{getAllMenuCategories}} for a list of MenuCategorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified MenuCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMenuCategory <- function(MenuCategoryID, EntityID = 1, setDisplayName = NULL, setDisplayOrder = NULL, setIsDefault = NULL, setIsEnabled = NULL, setMenuModuleID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "MenuCategory", MenuCategoryID, names(functionParams), functionParams, EntityID)
}
#' Create new MenuCategory.
#'
#' This function creates a new MenuCategory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created MenuCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMenuCategory <- function(EntityID = 1, setDisplayName = NULL, setDisplayOrder = NULL, setIsDefault = NULL, setIsEnabled = NULL, setMenuModuleID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardIsDefault = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "MenuCategory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific MenuCategory
#'
#' This function deletes a MenuCategory.
#'
#' @param MenuCategoryID The id of the MenuCategory.\cr Run \code{\link{getAllMenuCategories}} for a list of MenuCategories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted MenuCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMenuCategory <- function(MenuCategoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "MenuCategory", MenuCategoryID, EntityID)
}
#' Get all MenuModules.
#'
#' This function returns a dataframe of all MenuModules in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All MenuModules in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMenuModules <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMenuModuleID = F, returnCreatedTime = F, returnDescription = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnImage = F, returnImageCode = F, returnIsEnabled = F, returnIsSkywardMenuModule = F, returnModifiedTime = F, returnModuleSkywardID = F, returnSkywardDescription = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "MenuModule", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific MenuModule
#'
#' This function returns fields for a MenuModule.
#'
#' @param MenuModuleID The id of the MenuModule.\cr Run \code{\link{getAllMenuModules}} for a list of MenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the MenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMenuModule <- function(MenuModuleID, EntityID = 1, returnMenuModuleID = F, returnCreatedTime = F, returnDescription = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnImage = F, returnImageCode = F, returnIsEnabled = F, returnIsSkywardMenuModule = F, returnModifiedTime = F, returnModuleSkywardID = F, returnSkywardDescription = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "MenuModule", MenuModuleID, searchFields, EntityID)
}
#' Modify a specific MenuModule
#'
#' This function modifies fields for a MenuModule.
#'
#' @param MenuModuleID The id of the MenuModule to be modified.\cr Run \code{\link{getAllMenuModules}} for a list of MenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified MenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMenuModule <- function(MenuModuleID, EntityID = 1, setDescription = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setImage = NULL, setImageCode = NULL, setIsEnabled = NULL, setModuleSkywardID = NULL, setSkywardDescription = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "MenuModule", MenuModuleID, names(functionParams), functionParams, EntityID)
}
#' Create new MenuModule.
#'
#' This function creates a new MenuModule.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created MenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMenuModule <- function(EntityID = 1, setDescription = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setImage = NULL, setImageCode = NULL, setIsEnabled = NULL, setModuleSkywardID = NULL, setSkywardDescription = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "MenuModule", names(functionParams), functionParams, EntityID)
}
#' Delete a specific MenuModule
#'
#' This function deletes a MenuModule.
#'
#' @param MenuModuleID The id of the MenuModule.\cr Run \code{\link{getAllMenuModules}} for a list of MenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted MenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMenuModule <- function(MenuModuleID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "MenuModule", MenuModuleID, EntityID)
}
#' Get all MenuScreens.
#'
#' This function returns a dataframe of all MenuScreens in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All MenuScreens in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMenuScreens <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMenuScreenID = F, returnCreatedTime = F, returnData = F, returnDescription = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnIsEnabled = F, returnIsForMenuSecurity = F, returnIsSkywardMenuScreen = F, returnMenuCategoryID = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnOptionType = F, returnOptionTypeCode = F, returnPostData = F, returnProfileID = F, returnScreen = F, returnShouldShowInMenu = F, returnSkywardDescription = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "MenuScreen", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific MenuScreen
#'
#' This function returns fields for a MenuScreen.
#'
#' @param MenuScreenID The id of the MenuScreen.\cr Run \code{\link{getAllMenuScreens}} for a list of MenuScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the MenuScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMenuScreen <- function(MenuScreenID, EntityID = 1, returnMenuScreenID = F, returnCreatedTime = F, returnData = F, returnDescription = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDescription = F, returnIsEnabled = F, returnIsForMenuSecurity = F, returnIsSkywardMenuScreen = F, returnMenuCategoryID = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnOptionType = F, returnOptionTypeCode = F, returnPostData = F, returnProfileID = F, returnScreen = F, returnShouldShowInMenu = F, returnSkywardDescription = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "MenuScreen", MenuScreenID, searchFields, EntityID)
}
#' Modify a specific MenuScreen
#'
#' This function modifies fields for a MenuScreen.
#'
#' @param MenuScreenID The id of the MenuScreen to be modified.\cr Run \code{\link{getAllMenuScreens}} for a list of MenuScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified MenuScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMenuScreen <- function(MenuScreenID, EntityID = 1, setDescription = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setIsForMenuSecurity = NULL, setMenuCategoryID = NULL, setModule = NULL, setObject = NULL, setOptionType = NULL, setOptionTypeCode = NULL, setPostData = NULL, setProfileID = NULL, setScreen = NULL, setSkywardDescription = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "MenuScreen", MenuScreenID, names(functionParams), functionParams, EntityID)
}
#' Create new MenuScreen.
#'
#' This function creates a new MenuScreen.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created MenuScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMenuScreen <- function(EntityID = 1, setDescription = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setIsForMenuSecurity = NULL, setMenuCategoryID = NULL, setModule = NULL, setObject = NULL, setOptionType = NULL, setOptionTypeCode = NULL, setPostData = NULL, setProfileID = NULL, setScreen = NULL, setSkywardDescription = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "MenuScreen", names(functionParams), functionParams, EntityID)
}
#' Delete a specific MenuScreen
#'
#' This function deletes a MenuScreen.
#'
#' @param MenuScreenID The id of the MenuScreen.\cr Run \code{\link{getAllMenuScreens}} for a list of MenuScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted MenuScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMenuScreen <- function(MenuScreenID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "MenuScreen", MenuScreenID, EntityID)
}
#' Get all Modules.
#'
#' This function returns a dataframe of all Modules in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Modules in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllModules <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnModuleID = F, returnChangeType = F, returnContainsAtLeastOneNonTempDataObject = F, returnCreatedTime = F, returnCurrentName = F, returnDisplayName = F, returnEffectiveName = F, returnHasChangedFields = F, returnHasChangedObjects = F, returnHasChangedRelationships = F, returnIsInDB = F, returnIsSkywardModule = F, returnModifiedTime = F, returnPendingName = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Module", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Module
#'
#' This function returns fields for a Module.
#'
#' @param ModuleID The id of the Module.\cr Run \code{\link{getAllModules}} for a list of Modules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Module.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getModule <- function(ModuleID, EntityID = 1, returnModuleID = F, returnChangeType = F, returnContainsAtLeastOneNonTempDataObject = F, returnCreatedTime = F, returnCurrentName = F, returnDisplayName = F, returnEffectiveName = F, returnHasChangedFields = F, returnHasChangedObjects = F, returnHasChangedRelationships = F, returnIsInDB = F, returnIsSkywardModule = F, returnModifiedTime = F, returnPendingName = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Module", ModuleID, searchFields, EntityID)
}
#' Modify a specific Module
#'
#' This function modifies fields for a Module.
#'
#' @param ModuleID The id of the Module to be modified.\cr Run \code{\link{getAllModules}} for a list of Modules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Module.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyModule <- function(ModuleID, EntityID = 1, setContainsAtLeastOneNonTempDataObject = NULL, setCurrentName = NULL, setHasChangedFields = NULL, setHasChangedObjects = NULL, setHasChangedRelationships = NULL, setIsInDB = NULL, setIsSkywardModule = NULL, setPendingName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Module", ModuleID, names(functionParams), functionParams, EntityID)
}
#' Create new Module.
#'
#' This function creates a new Module.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Module.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createModule <- function(EntityID = 1, setContainsAtLeastOneNonTempDataObject = NULL, setCurrentName = NULL, setHasChangedFields = NULL, setHasChangedObjects = NULL, setHasChangedRelationships = NULL, setIsInDB = NULL, setIsSkywardModule = NULL, setPendingName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Module", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Module
#'
#' This function deletes a Module.
#'
#' @param ModuleID The id of the Module.\cr Run \code{\link{getAllModules}} for a list of Modules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Module.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteModule <- function(ModuleID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Module", ModuleID, EntityID)
}
#' Get all ModulePaths.
#'
#' This function returns a dataframe of all ModulePaths in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ModulePaths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllModulePaths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnModulePathID = F, returnAliasAction = F, returnAliasIsWorkflow = F, returnAliasModule = F, returnAliasObject = F, returnAverageLoadTimeMilliseconds = F, returnController = F, returnControllerDataObjectTypeIdentifier = F, returnControllerScreen = F, returnControllerSkywardID = F, returnCreateAccess = F, returnCreateAccessCode = F, returnCreatedTime = F, returnDataObjectTypeIdentifier = F, returnDataObjectTypeName = F, returnDataObjectTypeNameObjectID = F, returnDeleteAccess = F, returnDeleteAccessCode = F, returnFullAlias = F, returnIsAnonymous = F, returnIsFullPageLoad = F, returnIsListScreen = F, returnIsProfileScreen = F, returnIsSession = F, returnIsSkywardDefined = F, returnMassCreateAccess = F, returnMassCreateAccessCode = F, returnMassDeleteAccess = F, returnMassDeleteAccessCode = F, returnMassUpdateAccess = F, returnMassUpdateAccessCode = F, returnMaximumLoadTimeMilliseconds = F, returnMinimumLoadTimeMilliseconds = F, returnMobileCreateAccess = F, returnMobileCreateAccessCode = F, returnMobileDeleteAccess = F, returnMobileDeleteAccessCode = F, returnMobileMassCreateAccess = F, returnMobileMassCreateAccessCode = F, returnMobileMassDeleteAccess = F, returnMobileMassDeleteAccessCode = F, returnMobileMassUpdateAccess = F, returnMobileMassUpdateAccessCode = F, returnMobileReadAccess = F, returnMobileReadAccessCode = F, returnMobileUpdateAccess = F, returnMobileUpdateAccessCode = F, returnModifiedTime = F, returnModule = F, returnModuleController = F, returnNonReadOnlyImpersonationBlacklist = F, returnPageLoadCount = F, returnPortal = F, returnPortalCode = F, returnProfile_Module = F, returnProfile_Object = F, returnProfileID = F, returnReadAccess = F, returnReadAccessCode = F, returnReadOnlyImpersonationWhitelist = F, returnScreen = F, returnScreenLayoutChanges = F, returnScreenXML = F, returnShowReportType = F, returnShowReportTypeCode = F, returnSkipAntiForgeryTokenCheck = F, returnSkipLicense = F, returnSkywardHash = F, returnSkywardID = F, returnUpdateAccess = F, returnUpdateAccessCode = F, returnURL = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidateSessionForFullPageLoad = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ModulePath", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ModulePath
#'
#' This function returns fields for a ModulePath.
#'
#' @param ModulePathID The id of the ModulePath.\cr Run \code{\link{getAllModulePaths}} for a list of ModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getModulePath <- function(ModulePathID, EntityID = 1, returnModulePathID = F, returnAliasAction = F, returnAliasIsWorkflow = F, returnAliasModule = F, returnAliasObject = F, returnAverageLoadTimeMilliseconds = F, returnController = F, returnControllerDataObjectTypeIdentifier = F, returnControllerScreen = F, returnControllerSkywardID = F, returnCreateAccess = F, returnCreateAccessCode = F, returnCreatedTime = F, returnDataObjectTypeIdentifier = F, returnDataObjectTypeName = F, returnDataObjectTypeNameObjectID = F, returnDeleteAccess = F, returnDeleteAccessCode = F, returnFullAlias = F, returnIsAnonymous = F, returnIsFullPageLoad = F, returnIsListScreen = F, returnIsProfileScreen = F, returnIsSession = F, returnIsSkywardDefined = F, returnMassCreateAccess = F, returnMassCreateAccessCode = F, returnMassDeleteAccess = F, returnMassDeleteAccessCode = F, returnMassUpdateAccess = F, returnMassUpdateAccessCode = F, returnMaximumLoadTimeMilliseconds = F, returnMinimumLoadTimeMilliseconds = F, returnMobileCreateAccess = F, returnMobileCreateAccessCode = F, returnMobileDeleteAccess = F, returnMobileDeleteAccessCode = F, returnMobileMassCreateAccess = F, returnMobileMassCreateAccessCode = F, returnMobileMassDeleteAccess = F, returnMobileMassDeleteAccessCode = F, returnMobileMassUpdateAccess = F, returnMobileMassUpdateAccessCode = F, returnMobileReadAccess = F, returnMobileReadAccessCode = F, returnMobileUpdateAccess = F, returnMobileUpdateAccessCode = F, returnModifiedTime = F, returnModule = F, returnModuleController = F, returnNonReadOnlyImpersonationBlacklist = F, returnPageLoadCount = F, returnPortal = F, returnPortalCode = F, returnProfile_Module = F, returnProfile_Object = F, returnProfileID = F, returnReadAccess = F, returnReadAccessCode = F, returnReadOnlyImpersonationWhitelist = F, returnScreen = F, returnScreenLayoutChanges = F, returnScreenXML = F, returnShowReportType = F, returnShowReportTypeCode = F, returnSkipAntiForgeryTokenCheck = F, returnSkipLicense = F, returnSkywardHash = F, returnSkywardID = F, returnUpdateAccess = F, returnUpdateAccessCode = F, returnURL = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidateSessionForFullPageLoad = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ModulePath", ModulePathID, searchFields, EntityID)
}
#' Modify a specific ModulePath
#'
#' This function modifies fields for a ModulePath.
#'
#' @param ModulePathID The id of the ModulePath to be modified.\cr Run \code{\link{getAllModulePaths}} for a list of ModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyModulePath <- function(ModulePathID, EntityID = 1, setAliasAction = NULL, setAliasIsWorkflow = NULL, setAliasModule = NULL, setAliasObject = NULL, setController = NULL, setControllerDataObjectTypeIdentifier = NULL, setControllerSkywardID = NULL, setCreateAccess = NULL, setCreateAccessCode = NULL, setDataObjectTypeIdentifier = NULL, setDataObjectTypeName = NULL, setDataObjectTypeNameObjectID = NULL, setDeleteAccess = NULL, setDeleteAccessCode = NULL, setIsAnonymous = NULL, setIsFullPageLoad = NULL, setIsListScreen = NULL, setIsSession = NULL, setIsSkywardDefined = NULL, setMassCreateAccess = NULL, setMassCreateAccessCode = NULL, setMassDeleteAccess = NULL, setMassDeleteAccessCode = NULL, setMassUpdateAccess = NULL, setMassUpdateAccessCode = NULL, setMobileCreateAccess = NULL, setMobileCreateAccessCode = NULL, setMobileDeleteAccess = NULL, setMobileDeleteAccessCode = NULL, setMobileMassCreateAccess = NULL, setMobileMassCreateAccessCode = NULL, setMobileMassDeleteAccess = NULL, setMobileMassDeleteAccessCode = NULL, setMobileMassUpdateAccess = NULL, setMobileMassUpdateAccessCode = NULL, setMobileReadAccess = NULL, setMobileReadAccessCode = NULL, setMobileUpdateAccess = NULL, setMobileUpdateAccessCode = NULL, setModule = NULL, setNonReadOnlyImpersonationBlacklist = NULL, setPortal = NULL, setPortalCode = NULL, setProfileID = NULL, setReadAccess = NULL, setReadAccessCode = NULL, setReadOnlyImpersonationWhitelist = NULL, setScreen = NULL, setScreenLayoutChanges = NULL, setScreenXML = NULL, setShowReportType = NULL, setShowReportTypeCode = NULL, setSkipAntiForgeryTokenCheck = NULL, setSkipLicense = NULL, setSkywardHash = NULL, setSkywardID = NULL, setUpdateAccess = NULL, setUpdateAccessCode = NULL, setValidateSessionForFullPageLoad = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ModulePath", ModulePathID, names(functionParams), functionParams, EntityID)
}
#' Create new ModulePath.
#'
#' This function creates a new ModulePath.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createModulePath <- function(EntityID = 1, setAliasAction = NULL, setAliasIsWorkflow = NULL, setAliasModule = NULL, setAliasObject = NULL, setController = NULL, setControllerDataObjectTypeIdentifier = NULL, setControllerSkywardID = NULL, setCreateAccess = NULL, setCreateAccessCode = NULL, setDataObjectTypeIdentifier = NULL, setDataObjectTypeName = NULL, setDataObjectTypeNameObjectID = NULL, setDeleteAccess = NULL, setDeleteAccessCode = NULL, setIsAnonymous = NULL, setIsFullPageLoad = NULL, setIsListScreen = NULL, setIsSession = NULL, setIsSkywardDefined = NULL, setMassCreateAccess = NULL, setMassCreateAccessCode = NULL, setMassDeleteAccess = NULL, setMassDeleteAccessCode = NULL, setMassUpdateAccess = NULL, setMassUpdateAccessCode = NULL, setMobileCreateAccess = NULL, setMobileCreateAccessCode = NULL, setMobileDeleteAccess = NULL, setMobileDeleteAccessCode = NULL, setMobileMassCreateAccess = NULL, setMobileMassCreateAccessCode = NULL, setMobileMassDeleteAccess = NULL, setMobileMassDeleteAccessCode = NULL, setMobileMassUpdateAccess = NULL, setMobileMassUpdateAccessCode = NULL, setMobileReadAccess = NULL, setMobileReadAccessCode = NULL, setMobileUpdateAccess = NULL, setMobileUpdateAccessCode = NULL, setModule = NULL, setNonReadOnlyImpersonationBlacklist = NULL, setPortal = NULL, setPortalCode = NULL, setProfileID = NULL, setReadAccess = NULL, setReadAccessCode = NULL, setReadOnlyImpersonationWhitelist = NULL, setScreen = NULL, setScreenLayoutChanges = NULL, setScreenXML = NULL, setShowReportType = NULL, setShowReportTypeCode = NULL, setSkipAntiForgeryTokenCheck = NULL, setSkipLicense = NULL, setSkywardHash = NULL, setSkywardID = NULL, setUpdateAccess = NULL, setUpdateAccessCode = NULL, setValidateSessionForFullPageLoad = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ModulePath", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ModulePath
#'
#' This function deletes a ModulePath.
#'
#' @param ModulePathID The id of the ModulePath.\cr Run \code{\link{getAllModulePaths}} for a list of ModulePaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ModulePath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteModulePath <- function(ModulePathID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ModulePath", ModulePathID, EntityID)
}
#' Get all Objects.
#'
#' This function returns a dataframe of all Objects in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Objects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllObjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnObjectID = F, returnAllowAttachments = F, returnChangeType = F, returnCodeGuidFieldPath = F, returnCreatedTime = F, returnCurrentDisplayName = F, returnCurrentName = F, returnCustomizationID = F, returnDescriptionGuidFieldPath = F, returnEffectiveDisplayName = F, returnEffectiveName = F, returnFormattedObjectPath = F, returnHasChangedFields = F, returnHasChangedRelationships = F, returnHasDefaultSortGroup = F, returnIsInDB = F, returnIsSkywardObject = F, returnIsTempDataObject = F, returnIsView = F, returnModifiedTime = F, returnModuleID = F, returnNotForDisplayInImporting = F, returnNotForDisplayInReporting = F, returnPendingDisplayName = F, returnPendingFormattedObjectPath = F, returnPendingName = F, returnScope = F, returnScopeCode = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnViewSQL = F, returnViewSQLText = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Object", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Object
#'
#' This function returns fields for an Object.
#'
#' @param ObjectID The id of the Object.\cr Run \code{\link{getAllObjects}} for a list of Objects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Object.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getObject <- function(ObjectID, EntityID = 1, returnObjectID = F, returnAllowAttachments = F, returnChangeType = F, returnCodeGuidFieldPath = F, returnCreatedTime = F, returnCurrentDisplayName = F, returnCurrentName = F, returnCustomizationID = F, returnDescriptionGuidFieldPath = F, returnEffectiveDisplayName = F, returnEffectiveName = F, returnFormattedObjectPath = F, returnHasChangedFields = F, returnHasChangedRelationships = F, returnHasDefaultSortGroup = F, returnIsInDB = F, returnIsSkywardObject = F, returnIsTempDataObject = F, returnIsView = F, returnModifiedTime = F, returnModuleID = F, returnNotForDisplayInImporting = F, returnNotForDisplayInReporting = F, returnPendingDisplayName = F, returnPendingFormattedObjectPath = F, returnPendingName = F, returnScope = F, returnScopeCode = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnViewSQL = F, returnViewSQLText = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Object", ObjectID, searchFields, EntityID)
}
#' Modify a specific Object
#'
#' This function modifies fields for an Object.
#'
#' @param ObjectID The id of the Object to be modified.\cr Run \code{\link{getAllObjects}} for a list of Objects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Object.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyObject <- function(ObjectID, EntityID = 1, setAllowAttachments = NULL, setCodeGuidFieldPath = NULL, setCurrentDisplayName = NULL, setCurrentName = NULL, setCustomizationID = NULL, setDescriptionGuidFieldPath = NULL, setHasChangedFields = NULL, setHasChangedRelationships = NULL, setHasDefaultSortGroup = NULL, setIsInDB = NULL, setIsSkywardObject = NULL, setIsTempDataObject = NULL, setIsView = NULL, setModuleID = NULL, setNotForDisplayInImporting = NULL, setNotForDisplayInReporting = NULL, setPendingDisplayName = NULL, setPendingName = NULL, setScope = NULL, setScopeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUniqueID = NULL, setViewSQL = NULL, setViewSQLText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Object", ObjectID, names(functionParams), functionParams, EntityID)
}
#' Create new Object.
#'
#' This function creates a new Object.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Object.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createObject <- function(EntityID = 1, setAllowAttachments = NULL, setCodeGuidFieldPath = NULL, setCurrentDisplayName = NULL, setCurrentName = NULL, setCustomizationID = NULL, setDescriptionGuidFieldPath = NULL, setHasChangedFields = NULL, setHasChangedRelationships = NULL, setHasDefaultSortGroup = NULL, setIsInDB = NULL, setIsSkywardObject = NULL, setIsTempDataObject = NULL, setIsView = NULL, setModuleID = NULL, setNotForDisplayInImporting = NULL, setNotForDisplayInReporting = NULL, setPendingDisplayName = NULL, setPendingName = NULL, setScope = NULL, setScopeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUniqueID = NULL, setViewSQL = NULL, setViewSQLText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Object", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Object
#'
#' This function deletes an Object.
#'
#' @param ObjectID The id of the Object.\cr Run \code{\link{getAllObjects}} for a list of Objects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Object.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteObject <- function(ObjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Object", ObjectID, EntityID)
}
#' Get all OnlinePaymentLogs.
#'
#' This function returns a dataframe of all OnlinePaymentLogs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All OnlinePaymentLogs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlinePaymentLogs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlinePaymentLogID = F, returnCreatedTime = F, returnEndpoint = F, returnEndpointCode = F, returnModifiedTime = F, returnRequestXML = F, returnResponseXML = F, returnUserAccessID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "OnlinePaymentLog", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlinePaymentLog
#'
#' This function returns fields for an OnlinePaymentLog.
#'
#' @param OnlinePaymentLogID The id of the OnlinePaymentLog.\cr Run \code{\link{getAllOnlinePaymentLogs}} for a list of OnlinePaymentLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the OnlinePaymentLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlinePaymentLog <- function(OnlinePaymentLogID, EntityID = 1, returnOnlinePaymentLogID = F, returnCreatedTime = F, returnEndpoint = F, returnEndpointCode = F, returnModifiedTime = F, returnRequestXML = F, returnResponseXML = F, returnUserAccessID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "OnlinePaymentLog", OnlinePaymentLogID, searchFields, EntityID)
}
#' Modify a specific OnlinePaymentLog
#'
#' This function modifies fields for an OnlinePaymentLog.
#'
#' @param OnlinePaymentLogID The id of the OnlinePaymentLog to be modified.\cr Run \code{\link{getAllOnlinePaymentLogs}} for a list of OnlinePaymentLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified OnlinePaymentLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlinePaymentLog <- function(OnlinePaymentLogID, EntityID = 1, setEndpoint = NULL, setEndpointCode = NULL, setRequestXML = NULL, setResponseXML = NULL, setUserAccessID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "OnlinePaymentLog", OnlinePaymentLogID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlinePaymentLog.
#'
#' This function creates a new OnlinePaymentLog.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created OnlinePaymentLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlinePaymentLog <- function(EntityID = 1, setEndpoint = NULL, setEndpointCode = NULL, setRequestXML = NULL, setResponseXML = NULL, setUserAccessID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "OnlinePaymentLog", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlinePaymentLog
#'
#' This function deletes an OnlinePaymentLog.
#'
#' @param OnlinePaymentLogID The id of the OnlinePaymentLog.\cr Run \code{\link{getAllOnlinePaymentLogs}} for a list of OnlinePaymentLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted OnlinePaymentLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlinePaymentLog <- function(OnlinePaymentLogID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "OnlinePaymentLog", OnlinePaymentLogID, EntityID)
}
#' Get all OnlinePaymentVendors.
#'
#' This function returns a dataframe of all OnlinePaymentVendors in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All OnlinePaymentVendors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlinePaymentVendors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlinePaymentVendorID = F, returnCreatedTime = F, returnEntitySummary = F, returnFeeManagementOnlinePaymentCodeDefault = F, returnModifiedTime = F, returnModule = F, returnModuleCode = F, returnName = F, returnURL = F, returnURLDisplayText = F, returnUserAccessID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "OnlinePaymentVendor", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlinePaymentVendor
#'
#' This function returns fields for an OnlinePaymentVendor.
#'
#' @param OnlinePaymentVendorID The id of the OnlinePaymentVendor.\cr Run \code{\link{getAllOnlinePaymentVendors}} for a list of OnlinePaymentVendors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the OnlinePaymentVendor.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlinePaymentVendor <- function(OnlinePaymentVendorID, EntityID = 1, returnOnlinePaymentVendorID = F, returnCreatedTime = F, returnEntitySummary = F, returnFeeManagementOnlinePaymentCodeDefault = F, returnModifiedTime = F, returnModule = F, returnModuleCode = F, returnName = F, returnURL = F, returnURLDisplayText = F, returnUserAccessID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "OnlinePaymentVendor", OnlinePaymentVendorID, searchFields, EntityID)
}
#' Modify a specific OnlinePaymentVendor
#'
#' This function modifies fields for an OnlinePaymentVendor.
#'
#' @param OnlinePaymentVendorID The id of the OnlinePaymentVendor to be modified.\cr Run \code{\link{getAllOnlinePaymentVendors}} for a list of OnlinePaymentVendors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified OnlinePaymentVendor.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlinePaymentVendor <- function(OnlinePaymentVendorID, EntityID = 1, setFeeManagementOnlinePaymentCodeDefault = NULL, setModule = NULL, setModuleCode = NULL, setName = NULL, setURL = NULL, setURLDisplayText = NULL, setUserAccessID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "OnlinePaymentVendor", OnlinePaymentVendorID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlinePaymentVendor.
#'
#' This function creates a new OnlinePaymentVendor.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created OnlinePaymentVendor.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlinePaymentVendor <- function(EntityID = 1, setFeeManagementOnlinePaymentCodeDefault = NULL, setModule = NULL, setModuleCode = NULL, setName = NULL, setURL = NULL, setURLDisplayText = NULL, setUserAccessID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "OnlinePaymentVendor", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlinePaymentVendor
#'
#' This function deletes an OnlinePaymentVendor.
#'
#' @param OnlinePaymentVendorID The id of the OnlinePaymentVendor.\cr Run \code{\link{getAllOnlinePaymentVendors}} for a list of OnlinePaymentVendors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted OnlinePaymentVendor.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlinePaymentVendor <- function(OnlinePaymentVendorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "OnlinePaymentVendor", OnlinePaymentVendorID, EntityID)
}
#' Get all OnlinePaymentVendorEntities.
#'
#' This function returns a dataframe of all OnlinePaymentVendorEntities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All OnlinePaymentVendorEntities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlinePaymentVendorEntities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlinePaymentVendorEntityID = F, returnCreatedTime = F, returnEntityID = F, returnModifiedTime = F, returnOnlinePaymentVendorID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "OnlinePaymentVendorEntity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlinePaymentVendorEntity
#'
#' This function returns fields for an OnlinePaymentVendorEntity.
#'
#' @param OnlinePaymentVendorEntityID The id of the OnlinePaymentVendorEntity.\cr Run \code{\link{getAllOnlinePaymentVendorEntities}} for a list of OnlinePaymentVendorEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the OnlinePaymentVendorEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlinePaymentVendorEntity <- function(OnlinePaymentVendorEntityID, EntityID = 1, returnOnlinePaymentVendorEntityID = F, returnCreatedTime = F, returnEntityID = F, returnModifiedTime = F, returnOnlinePaymentVendorID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "OnlinePaymentVendorEntity", OnlinePaymentVendorEntityID, searchFields, EntityID)
}
#' Modify a specific OnlinePaymentVendorEntity
#'
#' This function modifies fields for an OnlinePaymentVendorEntity.
#'
#' @param OnlinePaymentVendorEntityID The id of the OnlinePaymentVendorEntity to be modified.\cr Run \code{\link{getAllOnlinePaymentVendorEntities}} for a list of OnlinePaymentVendorEntitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified OnlinePaymentVendorEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlinePaymentVendorEntity <- function(OnlinePaymentVendorEntityID, EntityID = 1, setEntityID = NULL, setOnlinePaymentVendorID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "OnlinePaymentVendorEntity", OnlinePaymentVendorEntityID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlinePaymentVendorEntity.
#'
#' This function creates a new OnlinePaymentVendorEntity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created OnlinePaymentVendorEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlinePaymentVendorEntity <- function(EntityID = 1, setEntityID = NULL, setOnlinePaymentVendorID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "OnlinePaymentVendorEntity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlinePaymentVendorEntity
#'
#' This function deletes an OnlinePaymentVendorEntity.
#'
#' @param OnlinePaymentVendorEntityID The id of the OnlinePaymentVendorEntity.\cr Run \code{\link{getAllOnlinePaymentVendorEntities}} for a list of OnlinePaymentVendorEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted OnlinePaymentVendorEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlinePaymentVendorEntity <- function(OnlinePaymentVendorEntityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "OnlinePaymentVendorEntity", OnlinePaymentVendorEntityID, EntityID)
}
#' Get all PaymentNoticeLogs.
#'
#' This function returns a dataframe of all PaymentNoticeLogs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All PaymentNoticeLogs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPaymentNoticeLogs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPaymentNoticeLogID = F, returnComponentConfirmationNumber = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnOnlinePaymentLogID = F, returnPaymentDetailIDFeeManagement = F, returnPaymentDetailIDFoodService = F, returnSuccess = F, returnTransactionConfirmationNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDPaidBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "PaymentNoticeLog", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific PaymentNoticeLog
#'
#' This function returns fields for a PaymentNoticeLog.
#'
#' @param PaymentNoticeLogID The id of the PaymentNoticeLog.\cr Run \code{\link{getAllPaymentNoticeLogs}} for a list of PaymentNoticeLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the PaymentNoticeLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPaymentNoticeLog <- function(PaymentNoticeLogID, EntityID = 1, returnPaymentNoticeLogID = F, returnComponentConfirmationNumber = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnOnlinePaymentLogID = F, returnPaymentDetailIDFeeManagement = F, returnPaymentDetailIDFoodService = F, returnSuccess = F, returnTransactionConfirmationNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDPaidBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "PaymentNoticeLog", PaymentNoticeLogID, searchFields, EntityID)
}
#' Modify a specific PaymentNoticeLog
#'
#' This function modifies fields for a PaymentNoticeLog.
#'
#' @param PaymentNoticeLogID The id of the PaymentNoticeLog to be modified.\cr Run \code{\link{getAllPaymentNoticeLogs}} for a list of PaymentNoticeLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified PaymentNoticeLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPaymentNoticeLog <- function(PaymentNoticeLogID, EntityID = 1, setComponentConfirmationNumber = NULL, setFailureReason = NULL, setOnlinePaymentLogID = NULL, setPaymentDetailIDFeeManagement = NULL, setPaymentDetailIDFoodService = NULL, setTransactionConfirmationNumber = NULL, setUserIDPaidBy = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "PaymentNoticeLog", PaymentNoticeLogID, names(functionParams), functionParams, EntityID)
}
#' Create new PaymentNoticeLog.
#'
#' This function creates a new PaymentNoticeLog.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created PaymentNoticeLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPaymentNoticeLog <- function(EntityID = 1, setComponentConfirmationNumber = NULL, setFailureReason = NULL, setOnlinePaymentLogID = NULL, setPaymentDetailIDFeeManagement = NULL, setPaymentDetailIDFoodService = NULL, setTransactionConfirmationNumber = NULL, setUserIDPaidBy = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "PaymentNoticeLog", names(functionParams), functionParams, EntityID)
}
#' Delete a specific PaymentNoticeLog
#'
#' This function deletes a PaymentNoticeLog.
#'
#' @param PaymentNoticeLogID The id of the PaymentNoticeLog.\cr Run \code{\link{getAllPaymentNoticeLogs}} for a list of PaymentNoticeLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted PaymentNoticeLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePaymentNoticeLog <- function(PaymentNoticeLogID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "PaymentNoticeLog", PaymentNoticeLogID, EntityID)
}
#' Get all Profiles.
#'
#' This function returns a dataframe of all Profiles in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Profiles in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllProfiles <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnProfileID = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Profile", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Profile
#'
#' This function returns fields for a Profile.
#'
#' @param ProfileID The id of the Profile.\cr Run \code{\link{getAllProfiles}} for a list of Profiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Profile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getProfile <- function(ProfileID, EntityID = 1, returnProfileID = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Profile", ProfileID, searchFields, EntityID)
}
#' Modify a specific Profile
#'
#' This function modifies fields for a Profile.
#'
#' @param ProfileID The id of the Profile to be modified.\cr Run \code{\link{getAllProfiles}} for a list of Profiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Profile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyProfile <- function(ProfileID, EntityID = 1, setModule = NULL, setObject = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Profile", ProfileID, names(functionParams), functionParams, EntityID)
}
#' Create new Profile.
#'
#' This function creates a new Profile.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Profile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createProfile <- function(EntityID = 1, setModule = NULL, setObject = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Profile", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Profile
#'
#' This function deletes a Profile.
#'
#' @param ProfileID The id of the Profile.\cr Run \code{\link{getAllProfiles}} for a list of Profiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Profile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteProfile <- function(ProfileID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Profile", ProfileID, EntityID)
}
#' Get all ProfileModules.
#'
#' This function returns a dataframe of all ProfileModules in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ProfileModules in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllProfileModules <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnProfileModuleID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnIsEnabled = F, returnIsSkywardDefined = F, returnModifiedTime = F, returnProfileID = F, returnSkywardDisplayName = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ProfileModule", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ProfileModule
#'
#' This function returns fields for a ProfileModule.
#'
#' @param ProfileModuleID The id of the ProfileModule.\cr Run \code{\link{getAllProfileModules}} for a list of ProfileModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ProfileModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getProfileModule <- function(ProfileModuleID, EntityID = 1, returnProfileModuleID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnIsEnabled = F, returnIsSkywardDefined = F, returnModifiedTime = F, returnProfileID = F, returnSkywardDisplayName = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ProfileModule", ProfileModuleID, searchFields, EntityID)
}
#' Modify a specific ProfileModule
#'
#' This function modifies fields for a ProfileModule.
#'
#' @param ProfileModuleID The id of the ProfileModule to be modified.\cr Run \code{\link{getAllProfileModules}} for a list of ProfileModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ProfileModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyProfileModule <- function(ProfileModuleID, EntityID = 1, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setProfileID = NULL, setSkywardDisplayName = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ProfileModule", ProfileModuleID, names(functionParams), functionParams, EntityID)
}
#' Create new ProfileModule.
#'
#' This function creates a new ProfileModule.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ProfileModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createProfileModule <- function(EntityID = 1, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setProfileID = NULL, setSkywardDisplayName = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ProfileModule", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ProfileModule
#'
#' This function deletes a ProfileModule.
#'
#' @param ProfileModuleID The id of the ProfileModule.\cr Run \code{\link{getAllProfileModules}} for a list of ProfileModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ProfileModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteProfileModule <- function(ProfileModuleID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ProfileModule", ProfileModuleID, EntityID)
}
#' Get all ProfileScreens.
#'
#' This function returns a dataframe of all ProfileScreens in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ProfileScreens in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllProfileScreens <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnProfileScreenID = F, returnAttachmentTypeGUID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnIsEnabled = F, returnIsSkywardDefined = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnProfileModuleID = F, returnRender = F, returnScreen = F, returnSkywardDisplayName = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ProfileScreen", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ProfileScreen
#'
#' This function returns fields for a ProfileScreen.
#'
#' @param ProfileScreenID The id of the ProfileScreen.\cr Run \code{\link{getAllProfileScreens}} for a list of ProfileScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ProfileScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getProfileScreen <- function(ProfileScreenID, EntityID = 1, returnProfileScreenID = F, returnAttachmentTypeGUID = F, returnCreatedTime = F, returnDisplayName = F, returnDisplayOrder = F, returnEffectiveDisplayName = F, returnEffectiveDisplayOrder = F, returnIsEnabled = F, returnIsSkywardDefined = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnProfileModuleID = F, returnRender = F, returnScreen = F, returnSkywardDisplayName = F, returnSkywardDisplayOrder = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ProfileScreen", ProfileScreenID, searchFields, EntityID)
}
#' Modify a specific ProfileScreen
#'
#' This function modifies fields for a ProfileScreen.
#'
#' @param ProfileScreenID The id of the ProfileScreen to be modified.\cr Run \code{\link{getAllProfileScreens}} for a list of ProfileScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ProfileScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyProfileScreen <- function(ProfileScreenID, EntityID = 1, setAttachmentTypeGUID = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setModule = NULL, setObject = NULL, setProfileModuleID = NULL, setRender = NULL, setScreen = NULL, setSkywardDisplayName = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ProfileScreen", ProfileScreenID, names(functionParams), functionParams, EntityID)
}
#' Create new ProfileScreen.
#'
#' This function creates a new ProfileScreen.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ProfileScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createProfileScreen <- function(EntityID = 1, setAttachmentTypeGUID = NULL, setDisplayName = NULL, setDisplayOrder = NULL, setIsEnabled = NULL, setModule = NULL, setObject = NULL, setProfileModuleID = NULL, setRender = NULL, setScreen = NULL, setSkywardDisplayName = NULL, setSkywardDisplayOrder = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ProfileScreen", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ProfileScreen
#'
#' This function deletes a ProfileScreen.
#'
#' @param ProfileScreenID The id of the ProfileScreen.\cr Run \code{\link{getAllProfileScreens}} for a list of ProfileScreens.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ProfileScreen.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteProfileScreen <- function(ProfileScreenID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ProfileScreen", ProfileScreenID, EntityID)
}
#' Get all Prompts.
#'
#' This function returns a dataframe of all Prompts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Prompts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPrompts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPromptID = F, returnColumns = F, returnCreatedTime = F, returnDataObjectFieldPathID = F, returnDisplayOrder = F, returnFieldPath = F, returnFilter = F, returnFilterCondition = F, returnInputType = F, returnIsSkywardPrompt = F, returnLabel = F, returnLinkedPromptGuid = F, returnModifiedTime = F, returnPresenceType = F, returnPresenceTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnSorts = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Prompt", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Prompt
#'
#' This function returns fields for a Prompt.
#'
#' @param PromptID The id of the Prompt.\cr Run \code{\link{getAllPrompts}} for a list of Prompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Prompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPrompt <- function(PromptID, EntityID = 1, returnPromptID = F, returnColumns = F, returnCreatedTime = F, returnDataObjectFieldPathID = F, returnDisplayOrder = F, returnFieldPath = F, returnFilter = F, returnFilterCondition = F, returnInputType = F, returnIsSkywardPrompt = F, returnLabel = F, returnLinkedPromptGuid = F, returnModifiedTime = F, returnPresenceType = F, returnPresenceTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnSorts = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Prompt", PromptID, searchFields, EntityID)
}
#' Modify a specific Prompt
#'
#' This function modifies fields for a Prompt.
#'
#' @param PromptID The id of the Prompt to be modified.\cr Run \code{\link{getAllPrompts}} for a list of Prompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Prompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPrompt <- function(PromptID, EntityID = 1, setDataObjectFieldPathID = NULL, setDisplayOrder = NULL, setFilter = NULL, setInputType = NULL, setLabel = NULL, setLinkedPromptGuid = NULL, setPresenceType = NULL, setPresenceTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setType = NULL, setTypeCode = NULL, setValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Prompt", PromptID, names(functionParams), functionParams, EntityID)
}
#' Create new Prompt.
#'
#' This function creates a new Prompt.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Prompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPrompt <- function(EntityID = 1, setDataObjectFieldPathID = NULL, setDisplayOrder = NULL, setFilter = NULL, setInputType = NULL, setLabel = NULL, setLinkedPromptGuid = NULL, setPresenceType = NULL, setPresenceTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setType = NULL, setTypeCode = NULL, setValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Prompt", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Prompt
#'
#' This function deletes a Prompt.
#'
#' @param PromptID The id of the Prompt.\cr Run \code{\link{getAllPrompts}} for a list of Prompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Prompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePrompt <- function(PromptID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Prompt", PromptID, EntityID)
}
#' Get all QuickEntryTexts.
#'
#' This function returns a dataframe of all QuickEntryTexts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All QuickEntryTexts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllQuickEntryTexts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnQuickEntryTextID = F, returnCreatedTime = F, returnEntry = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "QuickEntryText", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific QuickEntryText
#'
#' This function returns fields for a QuickEntryText.
#'
#' @param QuickEntryTextID The id of the QuickEntryText.\cr Run \code{\link{getAllQuickEntryTexts}} for a list of QuickEntryTexts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the QuickEntryText.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getQuickEntryText <- function(QuickEntryTextID, EntityID = 1, returnQuickEntryTextID = F, returnCreatedTime = F, returnEntry = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDOwner = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "QuickEntryText", QuickEntryTextID, searchFields, EntityID)
}
#' Modify a specific QuickEntryText
#'
#' This function modifies fields for a QuickEntryText.
#'
#' @param QuickEntryTextID The id of the QuickEntryText to be modified.\cr Run \code{\link{getAllQuickEntryTexts}} for a list of QuickEntryTexts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified QuickEntryText.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyQuickEntryText <- function(QuickEntryTextID, EntityID = 1, setEntry = NULL, setType = NULL, setTypeCode = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "QuickEntryText", QuickEntryTextID, names(functionParams), functionParams, EntityID)
}
#' Create new QuickEntryText.
#'
#' This function creates a new QuickEntryText.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created QuickEntryText.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createQuickEntryText <- function(EntityID = 1, setEntry = NULL, setType = NULL, setTypeCode = NULL, setUserIDOwner = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "QuickEntryText", names(functionParams), functionParams, EntityID)
}
#' Delete a specific QuickEntryText
#'
#' This function deletes a QuickEntryText.
#'
#' @param QuickEntryTextID The id of the QuickEntryText.\cr Run \code{\link{getAllQuickEntryTexts}} for a list of QuickEntryTexts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted QuickEntryText.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteQuickEntryText <- function(QuickEntryTextID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "QuickEntryText", QuickEntryTextID, EntityID)
}
#' Get all Relationships.
#'
#' This function returns a dataframe of all Relationships in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Relationships in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllRelationshipsSkySys <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnRelationshipID = F, returnChangeType = F, returnCreatedTime = F, returnCurrentCondition = F, returnCurrentConditionXML = F, returnCurrentDeleteBehavior = F, returnCurrentDeleteBehaviorCode = F, returnCurrentDisplayName = F, returnCurrentName = F, returnCurrentType = F, returnCurrentTypeCode = F, returnCustomizationID = F, returnFieldIDForeignKeyCurrent = F, returnFieldIDForeignKeyPending = F, returnIsInDB = F, returnIsSkywardRelationship = F, returnModifiedTime = F, returnObjectIDForeignCurrent = F, returnObjectIDForeignPending = F, returnObjectIDPrimary = F, returnPendingCondition = F, returnPendingConditionXML = F, returnPendingDeleteBehavior = F, returnPendingDeleteBehaviorCode = F, returnPendingDisplayName = F, returnPendingName = F, returnPendingType = F, returnPendingTypeCode = F, returnRelationshipIDRelated = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Relationship", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Relationship
#'
#' This function returns fields for a Relationship.
#'
#' @param RelationshipID The id of the Relationship.\cr Run \code{\link{getAllRelationships}} for a list of Relationships.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Relationship.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getRelationshipSkySys <- function(RelationshipID, EntityID = 1, returnRelationshipID = F, returnChangeType = F, returnCreatedTime = F, returnCurrentCondition = F, returnCurrentConditionXML = F, returnCurrentDeleteBehavior = F, returnCurrentDeleteBehaviorCode = F, returnCurrentDisplayName = F, returnCurrentName = F, returnCurrentType = F, returnCurrentTypeCode = F, returnCustomizationID = F, returnFieldIDForeignKeyCurrent = F, returnFieldIDForeignKeyPending = F, returnIsInDB = F, returnIsSkywardRelationship = F, returnModifiedTime = F, returnObjectIDForeignCurrent = F, returnObjectIDForeignPending = F, returnObjectIDPrimary = F, returnPendingCondition = F, returnPendingConditionXML = F, returnPendingDeleteBehavior = F, returnPendingDeleteBehaviorCode = F, returnPendingDisplayName = F, returnPendingName = F, returnPendingType = F, returnPendingTypeCode = F, returnRelationshipIDRelated = F, returnSkywardHash = F, returnSkywardID = F, returnStatus = F, returnStatusCode = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Relationship", RelationshipID, searchFields, EntityID)
}
#' Modify a specific Relationship
#'
#' This function modifies fields for a Relationship.
#'
#' @param RelationshipID The id of the Relationship to be modified.\cr Run \code{\link{getAllRelationships}} for a list of Relationships.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Relationship.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyRelationshipSkySys <- function(RelationshipID, EntityID = 1, setCurrentCondition = NULL, setCurrentConditionXML = NULL, setCurrentDeleteBehavior = NULL, setCurrentDeleteBehaviorCode = NULL, setCurrentDisplayName = NULL, setCurrentName = NULL, setCurrentType = NULL, setCurrentTypeCode = NULL, setCustomizationID = NULL, setFieldIDForeignKeyCurrent = NULL, setFieldIDForeignKeyPending = NULL, setIsInDB = NULL, setIsSkywardRelationship = NULL, setObjectIDForeignCurrent = NULL, setObjectIDForeignPending = NULL, setObjectIDPrimary = NULL, setPendingCondition = NULL, setPendingConditionXML = NULL, setPendingDeleteBehavior = NULL, setPendingDeleteBehaviorCode = NULL, setPendingDisplayName = NULL, setPendingName = NULL, setPendingType = NULL, setPendingTypeCode = NULL, setRelationshipIDRelated = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUniqueID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Relationship", RelationshipID, names(functionParams), functionParams, EntityID)
}
#' Create new Relationship.
#'
#' This function creates a new Relationship.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Relationship.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createRelationshipSkySys <- function(EntityID = 1, setCurrentCondition = NULL, setCurrentConditionXML = NULL, setCurrentDeleteBehavior = NULL, setCurrentDeleteBehaviorCode = NULL, setCurrentDisplayName = NULL, setCurrentName = NULL, setCurrentType = NULL, setCurrentTypeCode = NULL, setCustomizationID = NULL, setFieldIDForeignKeyCurrent = NULL, setFieldIDForeignKeyPending = NULL, setIsInDB = NULL, setIsSkywardRelationship = NULL, setObjectIDForeignCurrent = NULL, setObjectIDForeignPending = NULL, setObjectIDPrimary = NULL, setPendingCondition = NULL, setPendingConditionXML = NULL, setPendingDeleteBehavior = NULL, setPendingDeleteBehaviorCode = NULL, setPendingDisplayName = NULL, setPendingName = NULL, setPendingType = NULL, setPendingTypeCode = NULL, setRelationshipIDRelated = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStatus = NULL, setStatusCode = NULL, setUniqueID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Relationship", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Relationship
#'
#' This function deletes a Relationship.
#'
#' @param RelationshipID The id of the Relationship.\cr Run \code{\link{getAllRelationships}} for a list of Relationships.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Relationship.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteRelationshipSkySys <- function(RelationshipID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Relationship", RelationshipID, EntityID)
}
#' Get all ScheduledImports.
#'
#' This function returns a dataframe of all ScheduledImports in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ScheduledImports in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllScheduledImports <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnScheduledImportID = F, returnCachedEntity = F, returnCachedFiscalYear = F, returnCachedSchoolYear = F, returnCreatedTime = F, returnEntityID = F, returnEntityIDList = F, returnFileHasHeaderRow = F, returnFiscalYearID = F, returnImportID = F, returnModifiedTime = F, returnName = F, returnNetworkFilePath = F, returnPromptBoundValues = F, returnPromptBoundValuesXML = F, returnPromptsAreUpToDate = F, returnScheduledTaskID = F, returnSchoolYearID = F, returnSchoolYearNumericYearOrCurrent = F, returnSectionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ScheduledImport", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ScheduledImport
#'
#' This function returns fields for a ScheduledImport.
#'
#' @param ScheduledImportID The id of the ScheduledImport.\cr Run \code{\link{getAllScheduledImports}} for a list of ScheduledImports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ScheduledImport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getScheduledImport <- function(ScheduledImportID, EntityID = 1, returnScheduledImportID = F, returnCachedEntity = F, returnCachedFiscalYear = F, returnCachedSchoolYear = F, returnCreatedTime = F, returnEntityID = F, returnEntityIDList = F, returnFileHasHeaderRow = F, returnFiscalYearID = F, returnImportID = F, returnModifiedTime = F, returnName = F, returnNetworkFilePath = F, returnPromptBoundValues = F, returnPromptBoundValuesXML = F, returnPromptsAreUpToDate = F, returnScheduledTaskID = F, returnSchoolYearID = F, returnSchoolYearNumericYearOrCurrent = F, returnSectionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ScheduledImport", ScheduledImportID, searchFields, EntityID)
}
#' Modify a specific ScheduledImport
#'
#' This function modifies fields for a ScheduledImport.
#'
#' @param ScheduledImportID The id of the ScheduledImport to be modified.\cr Run \code{\link{getAllScheduledImports}} for a list of ScheduledImports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ScheduledImport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyScheduledImport <- function(ScheduledImportID, EntityID = 1, setEntityID = NULL, setFileHasHeaderRow = NULL, setImportID = NULL, setName = NULL, setNetworkFilePath = NULL, setPromptBoundValuesXML = NULL, setPromptsAreUpToDate = NULL, setScheduledTaskID = NULL, setSectionID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ScheduledImport", ScheduledImportID, names(functionParams), functionParams, EntityID)
}
#' Create new ScheduledImport.
#'
#' This function creates a new ScheduledImport.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ScheduledImport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createScheduledImport <- function(EntityID = 1, setEntityID = NULL, setFileHasHeaderRow = NULL, setImportID = NULL, setName = NULL, setNetworkFilePath = NULL, setPromptBoundValuesXML = NULL, setPromptsAreUpToDate = NULL, setScheduledTaskID = NULL, setSectionID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ScheduledImport", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ScheduledImport
#'
#' This function deletes a ScheduledImport.
#'
#' @param ScheduledImportID The id of the ScheduledImport.\cr Run \code{\link{getAllScheduledImports}} for a list of ScheduledImports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ScheduledImport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteScheduledImport <- function(ScheduledImportID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ScheduledImport", ScheduledImportID, EntityID)
}
#' Get all ScheduledTasks.
#'
#' This function returns a dataframe of all ScheduledTasks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ScheduledTasks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllScheduledTasks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnScheduledTaskID = F, returnCreatedTime = F, returnDayOfTheMonth = F, returnEffectiveStartTime = F, returnEndDate = F, returnFrequency = F, returnFrequencyCode = F, returnFriday = F, returnIsActive = F, returnIsMonthly = F, returnIsProductionOnly = F, returnIsSelfGeneratedFromWorkflow = F, returnIsWeekly = F, returnModifiedTime = F, returnMonday = F, returnName = F, returnParameters = F, returnParametersDictionary = F, returnRepeatInterval = F, returnRepeats = F, returnRepeatUntil = F, returnSaturday = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardStartTime = F, returnStartDate = F, returnStartTime = F, returnSunday = F, returnThursday = F, returnTuesday = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWednesday = F, returnWeekOfTheMonth = F, returnWorkflowID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ScheduledTask", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ScheduledTask
#'
#' This function returns fields for a ScheduledTask.
#'
#' @param ScheduledTaskID The id of the ScheduledTask.\cr Run \code{\link{getAllScheduledTasks}} for a list of ScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getScheduledTask <- function(ScheduledTaskID, EntityID = 1, returnScheduledTaskID = F, returnCreatedTime = F, returnDayOfTheMonth = F, returnEffectiveStartTime = F, returnEndDate = F, returnFrequency = F, returnFrequencyCode = F, returnFriday = F, returnIsActive = F, returnIsMonthly = F, returnIsProductionOnly = F, returnIsSelfGeneratedFromWorkflow = F, returnIsWeekly = F, returnModifiedTime = F, returnMonday = F, returnName = F, returnParameters = F, returnParametersDictionary = F, returnRepeatInterval = F, returnRepeats = F, returnRepeatUntil = F, returnSaturday = F, returnSkywardHash = F, returnSkywardID = F, returnSkywardStartTime = F, returnStartDate = F, returnStartTime = F, returnSunday = F, returnThursday = F, returnTuesday = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWednesday = F, returnWeekOfTheMonth = F, returnWorkflowID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ScheduledTask", ScheduledTaskID, searchFields, EntityID)
}
#' Modify a specific ScheduledTask
#'
#' This function modifies fields for a ScheduledTask.
#'
#' @param ScheduledTaskID The id of the ScheduledTask to be modified.\cr Run \code{\link{getAllScheduledTasks}} for a list of ScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyScheduledTask <- function(ScheduledTaskID, EntityID = 1, setDayOfTheMonth = NULL, setEndDate = NULL, setFrequency = NULL, setFrequencyCode = NULL, setFriday = NULL, setIsActive = NULL, setIsMonthly = NULL, setIsProductionOnly = NULL, setIsSelfGeneratedFromWorkflow = NULL, setIsWeekly = NULL, setMonday = NULL, setName = NULL, setParameters = NULL, setParametersDictionary = NULL, setRepeatInterval = NULL, setRepeats = NULL, setRepeatUntil = NULL, setSaturday = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardStartTime = NULL, setStartDate = NULL, setStartTime = NULL, setSunday = NULL, setThursday = NULL, setTuesday = NULL, setWednesday = NULL, setWeekOfTheMonth = NULL, setWorkflowID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ScheduledTask", ScheduledTaskID, names(functionParams), functionParams, EntityID)
}
#' Create new ScheduledTask.
#'
#' This function creates a new ScheduledTask.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createScheduledTask <- function(EntityID = 1, setDayOfTheMonth = NULL, setEndDate = NULL, setFrequency = NULL, setFrequencyCode = NULL, setFriday = NULL, setIsActive = NULL, setIsMonthly = NULL, setIsProductionOnly = NULL, setIsSelfGeneratedFromWorkflow = NULL, setIsWeekly = NULL, setMonday = NULL, setName = NULL, setParameters = NULL, setParametersDictionary = NULL, setRepeatInterval = NULL, setRepeats = NULL, setRepeatUntil = NULL, setSaturday = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSkywardStartTime = NULL, setStartDate = NULL, setStartTime = NULL, setSunday = NULL, setThursday = NULL, setTuesday = NULL, setWednesday = NULL, setWeekOfTheMonth = NULL, setWorkflowID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ScheduledTask", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ScheduledTask
#'
#' This function deletes a ScheduledTask.
#'
#' @param ScheduledTaskID The id of the ScheduledTask.\cr Run \code{\link{getAllScheduledTasks}} for a list of ScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteScheduledTask <- function(ScheduledTaskID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ScheduledTask", ScheduledTaskID, EntityID)
}
#' Get all ScheduledTaskInstances.
#'
#' This function returns a dataframe of all ScheduledTaskInstances in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ScheduledTaskInstances in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllScheduledTaskInstances <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnScheduledTaskInstanceID = F, returnCreatedTime = F, returnExecutionTime = F, returnIsPaused = F, returnModifiedTime = F, returnName = F, returnScheduledTaskID = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ScheduledTaskInstance", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ScheduledTaskInstance
#'
#' This function returns fields for a ScheduledTaskInstance.
#'
#' @param ScheduledTaskInstanceID The id of the ScheduledTaskInstance.\cr Run \code{\link{getAllScheduledTaskInstances}} for a list of ScheduledTaskInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ScheduledTaskInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getScheduledTaskInstance <- function(ScheduledTaskInstanceID, EntityID = 1, returnScheduledTaskInstanceID = F, returnCreatedTime = F, returnExecutionTime = F, returnIsPaused = F, returnModifiedTime = F, returnName = F, returnScheduledTaskID = F, returnStatus = F, returnStatusCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ScheduledTaskInstance", ScheduledTaskInstanceID, searchFields, EntityID)
}
#' Modify a specific ScheduledTaskInstance
#'
#' This function modifies fields for a ScheduledTaskInstance.
#'
#' @param ScheduledTaskInstanceID The id of the ScheduledTaskInstance to be modified.\cr Run \code{\link{getAllScheduledTaskInstances}} for a list of ScheduledTaskInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ScheduledTaskInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyScheduledTaskInstance <- function(ScheduledTaskInstanceID, EntityID = 1, setExecutionTime = NULL, setIsPaused = NULL, setName = NULL, setScheduledTaskID = NULL, setStatus = NULL, setStatusCode = NULL, setWorkflowID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ScheduledTaskInstance", ScheduledTaskInstanceID, names(functionParams), functionParams, EntityID)
}
#' Create new ScheduledTaskInstance.
#'
#' This function creates a new ScheduledTaskInstance.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ScheduledTaskInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createScheduledTaskInstance <- function(EntityID = 1, setExecutionTime = NULL, setIsPaused = NULL, setName = NULL, setScheduledTaskID = NULL, setStatus = NULL, setStatusCode = NULL, setWorkflowID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ScheduledTaskInstance", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ScheduledTaskInstance
#'
#' This function deletes a ScheduledTaskInstance.
#'
#' @param ScheduledTaskInstanceID The id of the ScheduledTaskInstance.\cr Run \code{\link{getAllScheduledTaskInstances}} for a list of ScheduledTaskInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ScheduledTaskInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteScheduledTaskInstance <- function(ScheduledTaskInstanceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ScheduledTaskInstance", ScheduledTaskInstanceID, EntityID)
}
#' Get all ScheduledTaskParameterDatas.
#'
#' This function returns a dataframe of all ScheduledTaskParameterDatas in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ScheduledTaskParameterDatas in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllScheduledTaskParameterDatas <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnScheduledTaskParameterDataID = F, returnCalendarYearID = F, returnCreatedTime = F, returnDistrictID = F, returnEntityID = F, returnFiscalYearID = F, returnModifiedTime = F, returnScheduledTaskID = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowVersionIDAsOfScheduling = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ScheduledTaskParameterData", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ScheduledTaskParameterData
#'
#' This function returns fields for a ScheduledTaskParameterData.
#'
#' @param ScheduledTaskParameterDataID The id of the ScheduledTaskParameterData.\cr Run \code{\link{getAllScheduledTaskParameterDatas}} for a list of ScheduledTaskParameterDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ScheduledTaskParameterData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getScheduledTaskParameterData <- function(ScheduledTaskParameterDataID, EntityID = 1, returnScheduledTaskParameterDataID = F, returnCalendarYearID = F, returnCreatedTime = F, returnDistrictID = F, returnEntityID = F, returnFiscalYearID = F, returnModifiedTime = F, returnScheduledTaskID = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowVersionIDAsOfScheduling = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ScheduledTaskParameterData", ScheduledTaskParameterDataID, searchFields, EntityID)
}
#' Modify a specific ScheduledTaskParameterData
#'
#' This function modifies fields for a ScheduledTaskParameterData.
#'
#' @param ScheduledTaskParameterDataID The id of the ScheduledTaskParameterData to be modified.\cr Run \code{\link{getAllScheduledTaskParameterDatas}} for a list of ScheduledTaskParameterDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ScheduledTaskParameterData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyScheduledTaskParameterData <- function(ScheduledTaskParameterDataID, EntityID = 1, setCalendarYearID = NULL, setDistrictID = NULL, setEntityID = NULL, setFiscalYearID = NULL, setScheduledTaskID = NULL, setSchoolYearID = NULL, setWorkflowVersionIDAsOfScheduling = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ScheduledTaskParameterData", ScheduledTaskParameterDataID, names(functionParams), functionParams, EntityID)
}
#' Create new ScheduledTaskParameterData.
#'
#' This function creates a new ScheduledTaskParameterData.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ScheduledTaskParameterData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createScheduledTaskParameterData <- function(EntityID = 1, setCalendarYearID = NULL, setDistrictID = NULL, setEntityID = NULL, setFiscalYearID = NULL, setScheduledTaskID = NULL, setSchoolYearID = NULL, setWorkflowVersionIDAsOfScheduling = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ScheduledTaskParameterData", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ScheduledTaskParameterData
#'
#' This function deletes a ScheduledTaskParameterData.
#'
#' @param ScheduledTaskParameterDataID The id of the ScheduledTaskParameterData.\cr Run \code{\link{getAllScheduledTaskParameterDatas}} for a list of ScheduledTaskParameterDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ScheduledTaskParameterData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteScheduledTaskParameterData <- function(ScheduledTaskParameterDataID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ScheduledTaskParameterData", ScheduledTaskParameterDataID, EntityID)
}
#' Get all SchemaHistories.
#'
#' This function returns a dataframe of all SchemaHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SchemaHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchemaHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchemaHistoryID = F, returnChangeType = F, returnChangeTypeCode = F, returnCreatedTime = F, returnField = F, returnIndex = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnPreviousField = F, returnPreviousIndex = F, returnPreviousModule = F, returnPreviousObject = F, returnReleaseVersion = F, returnScope = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SchemaHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchemaHistory
#'
#' This function returns fields for a SchemaHistory.
#'
#' @param SchemaHistoryID The id of the SchemaHistory.\cr Run \code{\link{getAllSchemaHistories}} for a list of SchemaHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SchemaHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchemaHistory <- function(SchemaHistoryID, EntityID = 1, returnSchemaHistoryID = F, returnChangeType = F, returnChangeTypeCode = F, returnCreatedTime = F, returnField = F, returnIndex = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnPreviousField = F, returnPreviousIndex = F, returnPreviousModule = F, returnPreviousObject = F, returnReleaseVersion = F, returnScope = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SchemaHistory", SchemaHistoryID, searchFields, EntityID)
}
#' Modify a specific SchemaHistory
#'
#' This function modifies fields for a SchemaHistory.
#'
#' @param SchemaHistoryID The id of the SchemaHistory to be modified.\cr Run \code{\link{getAllSchemaHistories}} for a list of SchemaHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SchemaHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchemaHistory <- function(SchemaHistoryID, EntityID = 1, setChangeType = NULL, setChangeTypeCode = NULL, setField = NULL, setIndex = NULL, setModule = NULL, setObject = NULL, setPreviousField = NULL, setPreviousIndex = NULL, setPreviousModule = NULL, setPreviousObject = NULL, setReleaseVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SchemaHistory", SchemaHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new SchemaHistory.
#'
#' This function creates a new SchemaHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SchemaHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchemaHistory <- function(EntityID = 1, setChangeType = NULL, setChangeTypeCode = NULL, setField = NULL, setIndex = NULL, setModule = NULL, setObject = NULL, setPreviousField = NULL, setPreviousIndex = NULL, setPreviousModule = NULL, setPreviousObject = NULL, setReleaseVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SchemaHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchemaHistory
#'
#' This function deletes a SchemaHistory.
#'
#' @param SchemaHistoryID The id of the SchemaHistory.\cr Run \code{\link{getAllSchemaHistories}} for a list of SchemaHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SchemaHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchemaHistory <- function(SchemaHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SchemaHistory", SchemaHistoryID, EntityID)
}
#' Get all SkywardConfigurations.
#'
#' This function returns a dataframe of all SkywardConfigurations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SkywardConfigurations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSkywardConfigurations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSkywardConfigurationID = F, returnAppPoolDecryptionKey = F, returnAppPoolValidationKey = F, returnCreatedTime = F, returnEncryptionKey = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SkywardConfiguration", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SkywardConfiguration
#'
#' This function returns fields for a SkywardConfiguration.
#'
#' @param SkywardConfigurationID The id of the SkywardConfiguration.\cr Run \code{\link{getAllSkywardConfigurations}} for a list of SkywardConfigurations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SkywardConfiguration.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSkywardConfiguration <- function(SkywardConfigurationID, EntityID = 1, returnSkywardConfigurationID = F, returnAppPoolDecryptionKey = F, returnAppPoolValidationKey = F, returnCreatedTime = F, returnEncryptionKey = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SkywardConfiguration", SkywardConfigurationID, searchFields, EntityID)
}
#' Modify a specific SkywardConfiguration
#'
#' This function modifies fields for a SkywardConfiguration.
#'
#' @param SkywardConfigurationID The id of the SkywardConfiguration to be modified.\cr Run \code{\link{getAllSkywardConfigurations}} for a list of SkywardConfigurations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SkywardConfiguration.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySkywardConfiguration <- function(SkywardConfigurationID, EntityID = 1, setAppPoolDecryptionKey = NULL, setAppPoolValidationKey = NULL, setEncryptionKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SkywardConfiguration", SkywardConfigurationID, names(functionParams), functionParams, EntityID)
}
#' Create new SkywardConfiguration.
#'
#' This function creates a new SkywardConfiguration.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SkywardConfiguration.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSkywardConfiguration <- function(EntityID = 1, setAppPoolDecryptionKey = NULL, setAppPoolValidationKey = NULL, setEncryptionKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SkywardConfiguration", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SkywardConfiguration
#'
#' This function deletes a SkywardConfiguration.
#'
#' @param SkywardConfigurationID The id of the SkywardConfiguration.\cr Run \code{\link{getAllSkywardConfigurations}} for a list of SkywardConfigurations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SkywardConfiguration.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSkywardConfiguration <- function(SkywardConfigurationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SkywardConfiguration", SkywardConfigurationID, EntityID)
}
#' Get all StandardFilters.
#'
#' This function returns a dataframe of all StandardFilters in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All StandardFilters in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStandardFilters <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStandardFilterID = F, returnButtonText = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnDisplayName = F, returnFilter = F, returnFilterCondition = F, returnIsSkywardFilter = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "StandardFilter", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StandardFilter
#'
#' This function returns fields for a StandardFilter.
#'
#' @param StandardFilterID The id of the StandardFilter.\cr Run \code{\link{getAllStandardFilters}} for a list of StandardFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the StandardFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStandardFilter <- function(StandardFilterID, EntityID = 1, returnStandardFilterID = F, returnButtonText = F, returnCreatedTime = F, returnDataModule = F, returnDataObject = F, returnDisplayName = F, returnFilter = F, returnFilterCondition = F, returnIsSkywardFilter = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "StandardFilter", StandardFilterID, searchFields, EntityID)
}
#' Modify a specific StandardFilter
#'
#' This function modifies fields for a StandardFilter.
#'
#' @param StandardFilterID The id of the StandardFilter to be modified.\cr Run \code{\link{getAllStandardFilters}} for a list of StandardFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified StandardFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStandardFilter <- function(StandardFilterID, EntityID = 1, setDataModule = NULL, setDataObject = NULL, setFilter = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "StandardFilter", StandardFilterID, names(functionParams), functionParams, EntityID)
}
#' Create new StandardFilter.
#'
#' This function creates a new StandardFilter.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created StandardFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStandardFilter <- function(EntityID = 1, setDataModule = NULL, setDataObject = NULL, setFilter = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "StandardFilter", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StandardFilter
#'
#' This function deletes a StandardFilter.
#'
#' @param StandardFilterID The id of the StandardFilter.\cr Run \code{\link{getAllStandardFilters}} for a list of StandardFilters.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted StandardFilter.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStandardFilter <- function(StandardFilterID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "StandardFilter", StandardFilterID, EntityID)
}
#' Get all StandardFilterPrompts.
#'
#' This function returns a dataframe of all StandardFilterPrompts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All StandardFilterPrompts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStandardFilterPrompts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStandardFilterPromptID = F, returnCreatedTime = F, returnModifiedTime = F, returnPromptID = F, returnSkywardHash = F, returnSkywardID = F, returnStandardFilterID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "StandardFilterPrompt", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StandardFilterPrompt
#'
#' This function returns fields for a StandardFilterPrompt.
#'
#' @param StandardFilterPromptID The id of the StandardFilterPrompt.\cr Run \code{\link{getAllStandardFilterPrompts}} for a list of StandardFilterPrompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the StandardFilterPrompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStandardFilterPrompt <- function(StandardFilterPromptID, EntityID = 1, returnStandardFilterPromptID = F, returnCreatedTime = F, returnModifiedTime = F, returnPromptID = F, returnSkywardHash = F, returnSkywardID = F, returnStandardFilterID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "StandardFilterPrompt", StandardFilterPromptID, searchFields, EntityID)
}
#' Modify a specific StandardFilterPrompt
#'
#' This function modifies fields for a StandardFilterPrompt.
#'
#' @param StandardFilterPromptID The id of the StandardFilterPrompt to be modified.\cr Run \code{\link{getAllStandardFilterPrompts}} for a list of StandardFilterPrompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified StandardFilterPrompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStandardFilterPrompt <- function(StandardFilterPromptID, EntityID = 1, setPromptID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStandardFilterID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "StandardFilterPrompt", StandardFilterPromptID, names(functionParams), functionParams, EntityID)
}
#' Create new StandardFilterPrompt.
#'
#' This function creates a new StandardFilterPrompt.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created StandardFilterPrompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStandardFilterPrompt <- function(EntityID = 1, setPromptID = NULL, setSkywardHash = NULL, setSkywardID = NULL, setStandardFilterID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "StandardFilterPrompt", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StandardFilterPrompt
#'
#' This function deletes a StandardFilterPrompt.
#'
#' @param StandardFilterPromptID The id of the StandardFilterPrompt.\cr Run \code{\link{getAllStandardFilterPrompts}} for a list of StandardFilterPrompts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted StandardFilterPrompt.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStandardFilterPrompt <- function(StandardFilterPromptID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "StandardFilterPrompt", StandardFilterPromptID, EntityID)
}
#' Get all StandardNormalDistributions.
#'
#' This function returns a dataframe of all StandardNormalDistributions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All StandardNormalDistributions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStandardNormalDistributions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStandardNormalDistributionID = F, returnCreatedTime = F, returnModifiedTime = F, returnProbability = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnZScore = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "StandardNormalDistribution", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StandardNormalDistribution
#'
#' This function returns fields for a StandardNormalDistribution.
#'
#' @param StandardNormalDistributionID The id of the StandardNormalDistribution.\cr Run \code{\link{getAllStandardNormalDistributions}} for a list of StandardNormalDistributions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the StandardNormalDistribution.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStandardNormalDistribution <- function(StandardNormalDistributionID, EntityID = 1, returnStandardNormalDistributionID = F, returnCreatedTime = F, returnModifiedTime = F, returnProbability = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnZScore = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "StandardNormalDistribution", StandardNormalDistributionID, searchFields, EntityID)
}
#' Modify a specific StandardNormalDistribution
#'
#' This function modifies fields for a StandardNormalDistribution.
#'
#' @param StandardNormalDistributionID The id of the StandardNormalDistribution to be modified.\cr Run \code{\link{getAllStandardNormalDistributions}} for a list of StandardNormalDistributions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified StandardNormalDistribution.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStandardNormalDistribution <- function(StandardNormalDistributionID, EntityID = 1, setProbability = NULL, setSkywardHash = NULL, setSkywardID = NULL, setZScore = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "StandardNormalDistribution", StandardNormalDistributionID, names(functionParams), functionParams, EntityID)
}
#' Create new StandardNormalDistribution.
#'
#' This function creates a new StandardNormalDistribution.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created StandardNormalDistribution.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStandardNormalDistribution <- function(EntityID = 1, setProbability = NULL, setSkywardHash = NULL, setSkywardID = NULL, setZScore = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "StandardNormalDistribution", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StandardNormalDistribution
#'
#' This function deletes a StandardNormalDistribution.
#'
#' @param StandardNormalDistributionID The id of the StandardNormalDistribution.\cr Run \code{\link{getAllStandardNormalDistributions}} for a list of StandardNormalDistributions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted StandardNormalDistribution.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStandardNormalDistribution <- function(StandardNormalDistributionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "StandardNormalDistribution", StandardNormalDistributionID, EntityID)
}
#' Get all States.
#'
#' This function returns a dataframe of all States in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All States in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStateID = F, returnCode = F, returnCountryCode = F, returnCreatedTime = F, returnDisplayName = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "State", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific State
#'
#' This function returns fields for a State.
#'
#' @param StateID The id of the State.\cr Run \code{\link{getAllStates}} for a list of States.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the State.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getState <- function(StateID, EntityID = 1, returnStateID = F, returnCode = F, returnCountryCode = F, returnCreatedTime = F, returnDisplayName = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "State", StateID, searchFields, EntityID)
}
#' Modify a specific State
#'
#' This function modifies fields for a State.
#'
#' @param StateID The id of the State to be modified.\cr Run \code{\link{getAllStates}} for a list of States.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified State.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyState <- function(StateID, EntityID = 1, setCode = NULL, setCountryCode = NULL, setDisplayName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "State", StateID, names(functionParams), functionParams, EntityID)
}
#' Create new State.
#'
#' This function creates a new State.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created State.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createState <- function(EntityID = 1, setCode = NULL, setCountryCode = NULL, setDisplayName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "State", names(functionParams), functionParams, EntityID)
}
#' Delete a specific State
#'
#' This function deletes a State.
#'
#' @param StateID The id of the State.\cr Run \code{\link{getAllStates}} for a list of States.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted State.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteState <- function(StateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "State", StateID, EntityID)
}
#' Get all Surveies.
#'
#' This function returns a dataframe of all Surveies in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Surveies in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSurveies <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Survey", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Survey
#'
#' This function returns fields for a Survey.
#'
#' @param SurveyID The id of the Survey.\cr Run \code{\link{getAllSurveies}} for a list of Surveies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Survey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSurvey <- function(SurveyID, EntityID = 1, returnSurveyID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Survey", SurveyID, searchFields, EntityID)
}
#' Modify a specific Survey
#'
#' This function modifies fields for a Survey.
#'
#' @param SurveyID The id of the Survey to be modified.\cr Run \code{\link{getAllSurveies}} for a list of Surveys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Survey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySurvey <- function(SurveyID, EntityID = 1, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Survey", SurveyID, names(functionParams), functionParams, EntityID)
}
#' Create new Survey.
#'
#' This function creates a new Survey.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Survey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSurvey <- function(EntityID = 1, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Survey", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Survey
#'
#' This function deletes a Survey.
#'
#' @param SurveyID The id of the Survey.\cr Run \code{\link{getAllSurveies}} for a list of Surveies.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Survey.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSurvey <- function(SurveyID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Survey", SurveyID, EntityID)
}
#' Get all SurveyAnswers.
#'
#' This function returns a dataframe of all SurveyAnswers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SurveyAnswers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSurveyAnswers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSurveyAnswerID = F, returnCreatedTime = F, returnModifiedTime = F, returnSurveyInstanceID = F, returnSurveyQuestionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SurveyAnswer", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SurveyAnswer
#'
#' This function returns fields for a SurveyAnswer.
#'
#' @param SurveyAnswerID The id of the SurveyAnswer.\cr Run \code{\link{getAllSurveyAnswers}} for a list of SurveyAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSurveyAnswer <- function(SurveyAnswerID, EntityID = 1, returnSurveyAnswerID = F, returnCreatedTime = F, returnModifiedTime = F, returnSurveyInstanceID = F, returnSurveyQuestionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SurveyAnswer", SurveyAnswerID, searchFields, EntityID)
}
#' Modify a specific SurveyAnswer
#'
#' This function modifies fields for a SurveyAnswer.
#'
#' @param SurveyAnswerID The id of the SurveyAnswer to be modified.\cr Run \code{\link{getAllSurveyAnswers}} for a list of SurveyAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySurveyAnswer <- function(SurveyAnswerID, EntityID = 1, setSurveyInstanceID = NULL, setSurveyQuestionID = NULL, setValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SurveyAnswer", SurveyAnswerID, names(functionParams), functionParams, EntityID)
}
#' Create new SurveyAnswer.
#'
#' This function creates a new SurveyAnswer.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSurveyAnswer <- function(EntityID = 1, setSurveyInstanceID = NULL, setSurveyQuestionID = NULL, setValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SurveyAnswer", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SurveyAnswer
#'
#' This function deletes a SurveyAnswer.
#'
#' @param SurveyAnswerID The id of the SurveyAnswer.\cr Run \code{\link{getAllSurveyAnswers}} for a list of SurveyAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSurveyAnswer <- function(SurveyAnswerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SurveyAnswer", SurveyAnswerID, EntityID)
}
#' Get all SurveyInstances.
#'
#' This function returns a dataframe of all SurveyInstances in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SurveyInstances in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSurveyInstances <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSurveyInstanceID = F, returnCreatedTime = F, returnModifiedTime = F, returnSurveyID = F, returnSystemVersion = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SurveyInstance", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SurveyInstance
#'
#' This function returns fields for a SurveyInstance.
#'
#' @param SurveyInstanceID The id of the SurveyInstance.\cr Run \code{\link{getAllSurveyInstances}} for a list of SurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSurveyInstance <- function(SurveyInstanceID, EntityID = 1, returnSurveyInstanceID = F, returnCreatedTime = F, returnModifiedTime = F, returnSurveyID = F, returnSystemVersion = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SurveyInstance", SurveyInstanceID, searchFields, EntityID)
}
#' Modify a specific SurveyInstance
#'
#' This function modifies fields for a SurveyInstance.
#'
#' @param SurveyInstanceID The id of the SurveyInstance to be modified.\cr Run \code{\link{getAllSurveyInstances}} for a list of SurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySurveyInstance <- function(SurveyInstanceID, EntityID = 1, setSurveyID = NULL, setSystemVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SurveyInstance", SurveyInstanceID, names(functionParams), functionParams, EntityID)
}
#' Create new SurveyInstance.
#'
#' This function creates a new SurveyInstance.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSurveyInstance <- function(EntityID = 1, setSurveyID = NULL, setSystemVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SurveyInstance", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SurveyInstance
#'
#' This function deletes a SurveyInstance.
#'
#' @param SurveyInstanceID The id of the SurveyInstance.\cr Run \code{\link{getAllSurveyInstances}} for a list of SurveyInstances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SurveyInstance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSurveyInstance <- function(SurveyInstanceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SurveyInstance", SurveyInstanceID, EntityID)
}
#' Get all SurveyQuestions.
#'
#' This function returns a dataframe of all SurveyQuestions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SurveyQuestions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSurveyQuestions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSurveyQuestionID = F, returnCreatedTime = F, returnInverse = F, returnModifiedTime = F, returnQuestion = F, returnSkywardHash = F, returnSkywardID = F, returnSortNumber = F, returnSurveyID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SurveyQuestion", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SurveyQuestion
#'
#' This function returns fields for a SurveyQuestion.
#'
#' @param SurveyQuestionID The id of the SurveyQuestion.\cr Run \code{\link{getAllSurveyQuestions}} for a list of SurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSurveyQuestion <- function(SurveyQuestionID, EntityID = 1, returnSurveyQuestionID = F, returnCreatedTime = F, returnInverse = F, returnModifiedTime = F, returnQuestion = F, returnSkywardHash = F, returnSkywardID = F, returnSortNumber = F, returnSurveyID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SurveyQuestion", SurveyQuestionID, searchFields, EntityID)
}
#' Modify a specific SurveyQuestion
#'
#' This function modifies fields for a SurveyQuestion.
#'
#' @param SurveyQuestionID The id of the SurveyQuestion to be modified.\cr Run \code{\link{getAllSurveyQuestions}} for a list of SurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySurveyQuestion <- function(SurveyQuestionID, EntityID = 1, setInverse = NULL, setQuestion = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSortNumber = NULL, setSurveyID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SurveyQuestion", SurveyQuestionID, names(functionParams), functionParams, EntityID)
}
#' Create new SurveyQuestion.
#'
#' This function creates a new SurveyQuestion.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSurveyQuestion <- function(EntityID = 1, setInverse = NULL, setQuestion = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSortNumber = NULL, setSurveyID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SurveyQuestion", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SurveyQuestion
#'
#' This function deletes a SurveyQuestion.
#'
#' @param SurveyQuestionID The id of the SurveyQuestion.\cr Run \code{\link{getAllSurveyQuestions}} for a list of SurveyQuestions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SurveyQuestion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSurveyQuestion <- function(SurveyQuestionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SurveyQuestion", SurveyQuestionID, EntityID)
}
#' Get all SystemVersions.
#'
#' This function returns a dataframe of all SystemVersions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All SystemVersions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSystemVersions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSystemVersionID = F, returnBuild = F, returnCreatedTime = F, returnMajor = F, returnMinor = F, returnModifiedTime = F, returnRevision = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVersion = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "SystemVersion", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SystemVersion
#'
#' This function returns fields for a SystemVersion.
#'
#' @param SystemVersionID The id of the SystemVersion.\cr Run \code{\link{getAllSystemVersions}} for a list of SystemVersions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the SystemVersion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSystemVersion <- function(SystemVersionID, EntityID = 1, returnSystemVersionID = F, returnBuild = F, returnCreatedTime = F, returnMajor = F, returnMinor = F, returnModifiedTime = F, returnRevision = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVersion = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "SystemVersion", SystemVersionID, searchFields, EntityID)
}
#' Modify a specific SystemVersion
#'
#' This function modifies fields for a SystemVersion.
#'
#' @param SystemVersionID The id of the SystemVersion to be modified.\cr Run \code{\link{getAllSystemVersions}} for a list of SystemVersions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified SystemVersion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySystemVersion <- function(SystemVersionID, EntityID = 1, setBuild = NULL, setMajor = NULL, setMinor = NULL, setRevision = NULL, setVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "SystemVersion", SystemVersionID, names(functionParams), functionParams, EntityID)
}
#' Create new SystemVersion.
#'
#' This function creates a new SystemVersion.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created SystemVersion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSystemVersion <- function(EntityID = 1, setBuild = NULL, setMajor = NULL, setMinor = NULL, setRevision = NULL, setVersion = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "SystemVersion", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SystemVersion
#'
#' This function deletes a SystemVersion.
#'
#' @param SystemVersionID The id of the SystemVersion.\cr Run \code{\link{getAllSystemVersions}} for a list of SystemVersions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted SystemVersion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSystemVersion <- function(SystemVersionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "SystemVersion", SystemVersionID, EntityID)
}
#' Get all TempAttachmentErrors.
#'
#' This function returns a dataframe of all TempAttachmentErrors in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempAttachmentErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAttachmentErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAttachmentErrorID = F, returnCreatedTime = F, returnErrorMessage = F, returnMediaID = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempAttachmentError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAttachmentError
#'
#' This function returns fields for a TempAttachmentError.
#'
#' @param TempAttachmentErrorID The id of the TempAttachmentError.\cr Run \code{\link{getAllTempAttachmentErrors}} for a list of TempAttachmentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempAttachmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAttachmentError <- function(TempAttachmentErrorID, EntityID = 1, returnTempAttachmentErrorID = F, returnCreatedTime = F, returnErrorMessage = F, returnMediaID = F, returnModifiedTime = F, returnName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempAttachmentError", TempAttachmentErrorID, searchFields, EntityID)
}
#' Modify a specific TempAttachmentError
#'
#' This function modifies fields for a TempAttachmentError.
#'
#' @param TempAttachmentErrorID The id of the TempAttachmentError to be modified.\cr Run \code{\link{getAllTempAttachmentErrors}} for a list of TempAttachmentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempAttachmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAttachmentError <- function(TempAttachmentErrorID, EntityID = 1, setErrorMessage = NULL, setMediaID = NULL, setName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempAttachmentError", TempAttachmentErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAttachmentError.
#'
#' This function creates a new TempAttachmentError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempAttachmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAttachmentError <- function(EntityID = 1, setErrorMessage = NULL, setMediaID = NULL, setName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempAttachmentError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAttachmentError
#'
#' This function deletes a TempAttachmentError.
#'
#' @param TempAttachmentErrorID The id of the TempAttachmentError.\cr Run \code{\link{getAllTempAttachmentErrors}} for a list of TempAttachmentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempAttachmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAttachmentError <- function(TempAttachmentErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempAttachmentError", TempAttachmentErrorID, EntityID)
}
#' Get all TempBrowseViewColumns.
#'
#' This function returns a dataframe of all TempBrowseViewColumns in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempBrowseViewColumns in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempBrowseViewColumns <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempBrowseViewColumnID = F, returnColumnHeaderText = F, returnColumnIndex = F, returnCreatedTime = F, returnFieldName = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempBrowseViewColumn", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempBrowseViewColumn
#'
#' This function returns fields for a TempBrowseViewColumn.
#'
#' @param TempBrowseViewColumnID The id of the TempBrowseViewColumn.\cr Run \code{\link{getAllTempBrowseViewColumns}} for a list of TempBrowseViewColumns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempBrowseViewColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempBrowseViewColumn <- function(TempBrowseViewColumnID, EntityID = 1, returnTempBrowseViewColumnID = F, returnColumnHeaderText = F, returnColumnIndex = F, returnCreatedTime = F, returnFieldName = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempBrowseViewColumn", TempBrowseViewColumnID, searchFields, EntityID)
}
#' Modify a specific TempBrowseViewColumn
#'
#' This function modifies fields for a TempBrowseViewColumn.
#'
#' @param TempBrowseViewColumnID The id of the TempBrowseViewColumn to be modified.\cr Run \code{\link{getAllTempBrowseViewColumns}} for a list of TempBrowseViewColumns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempBrowseViewColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempBrowseViewColumn <- function(TempBrowseViewColumnID, EntityID = 1, setColumnHeaderText = NULL, setColumnIndex = NULL, setFieldName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempBrowseViewColumn", TempBrowseViewColumnID, names(functionParams), functionParams, EntityID)
}
#' Create new TempBrowseViewColumn.
#'
#' This function creates a new TempBrowseViewColumn.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempBrowseViewColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempBrowseViewColumn <- function(EntityID = 1, setColumnHeaderText = NULL, setColumnIndex = NULL, setFieldName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempBrowseViewColumn", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempBrowseViewColumn
#'
#' This function deletes a TempBrowseViewColumn.
#'
#' @param TempBrowseViewColumnID The id of the TempBrowseViewColumn.\cr Run \code{\link{getAllTempBrowseViewColumns}} for a list of TempBrowseViewColumns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempBrowseViewColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempBrowseViewColumn <- function(TempBrowseViewColumnID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempBrowseViewColumn", TempBrowseViewColumnID, EntityID)
}
#' Get all TempDiagnostics.
#'
#' This function returns a dataframe of all TempDiagnostics in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempDiagnostics in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempDiagnostics <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempDiagnosticID = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempDiagnostic", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempDiagnostic
#'
#' This function returns fields for a TempDiagnostic.
#'
#' @param TempDiagnosticID The id of the TempDiagnostic.\cr Run \code{\link{getAllTempDiagnostics}} for a list of TempDiagnostics.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempDiagnostic.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempDiagnostic <- function(TempDiagnosticID, EntityID = 1, returnTempDiagnosticID = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempDiagnostic", TempDiagnosticID, searchFields, EntityID)
}
#' Modify a specific TempDiagnostic
#'
#' This function modifies fields for a TempDiagnostic.
#'
#' @param TempDiagnosticID The id of the TempDiagnostic to be modified.\cr Run \code{\link{getAllTempDiagnostics}} for a list of TempDiagnostics.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempDiagnostic.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempDiagnostic <- function(TempDiagnosticID, EntityID = 1, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempDiagnostic", TempDiagnosticID, names(functionParams), functionParams, EntityID)
}
#' Create new TempDiagnostic.
#'
#' This function creates a new TempDiagnostic.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempDiagnostic.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempDiagnostic <- function(EntityID = 1, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempDiagnostic", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempDiagnostic
#'
#' This function deletes a TempDiagnostic.
#'
#' @param TempDiagnosticID The id of the TempDiagnostic.\cr Run \code{\link{getAllTempDiagnostics}} for a list of TempDiagnostics.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempDiagnostic.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempDiagnostic <- function(TempDiagnosticID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempDiagnostic", TempDiagnosticID, EntityID)
}
#' Get all TempFailedTileYearUpdates.
#'
#' This function returns a dataframe of all TempFailedTileYearUpdates in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempFailedTileYearUpdates in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempFailedTileYearUpdates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempFailedTileYearUpdateID = F, returnCreatedTime = F, returnFailedMessage = F, returnModifiedTime = F, returnTileID = F, returnTileName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserName = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempFailedTileYearUpdate", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempFailedTileYearUpdate
#'
#' This function returns fields for a TempFailedTileYearUpdate.
#'
#' @param TempFailedTileYearUpdateID The id of the TempFailedTileYearUpdate.\cr Run \code{\link{getAllTempFailedTileYearUpdates}} for a list of TempFailedTileYearUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempFailedTileYearUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempFailedTileYearUpdate <- function(TempFailedTileYearUpdateID, EntityID = 1, returnTempFailedTileYearUpdateID = F, returnCreatedTime = F, returnFailedMessage = F, returnModifiedTime = F, returnTileID = F, returnTileName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserName = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempFailedTileYearUpdate", TempFailedTileYearUpdateID, searchFields, EntityID)
}
#' Modify a specific TempFailedTileYearUpdate
#'
#' This function modifies fields for a TempFailedTileYearUpdate.
#'
#' @param TempFailedTileYearUpdateID The id of the TempFailedTileYearUpdate to be modified.\cr Run \code{\link{getAllTempFailedTileYearUpdates}} for a list of TempFailedTileYearUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempFailedTileYearUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempFailedTileYearUpdate <- function(TempFailedTileYearUpdateID, EntityID = 1, setFailedMessage = NULL, setTileID = NULL, setTileName = NULL, setUserName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempFailedTileYearUpdate", TempFailedTileYearUpdateID, names(functionParams), functionParams, EntityID)
}
#' Create new TempFailedTileYearUpdate.
#'
#' This function creates a new TempFailedTileYearUpdate.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempFailedTileYearUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempFailedTileYearUpdate <- function(EntityID = 1, setFailedMessage = NULL, setTileID = NULL, setTileName = NULL, setUserName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempFailedTileYearUpdate", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempFailedTileYearUpdate
#'
#' This function deletes a TempFailedTileYearUpdate.
#'
#' @param TempFailedTileYearUpdateID The id of the TempFailedTileYearUpdate.\cr Run \code{\link{getAllTempFailedTileYearUpdates}} for a list of TempFailedTileYearUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempFailedTileYearUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempFailedTileYearUpdate <- function(TempFailedTileYearUpdateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempFailedTileYearUpdate", TempFailedTileYearUpdateID, EntityID)
}
#' Get all TempFieldSelections.
#'
#' This function returns a dataframe of all TempFieldSelections in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempFieldSelections in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempFieldSelections <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempFieldSelectionID = F, returnCreatedTime = F, returnFieldID = F, returnFieldName = F, returnModifiedTime = F, returnModuleName = F, returnObjectName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempFieldSelection", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempFieldSelection
#'
#' This function returns fields for a TempFieldSelection.
#'
#' @param TempFieldSelectionID The id of the TempFieldSelection.\cr Run \code{\link{getAllTempFieldSelections}} for a list of TempFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempFieldSelection <- function(TempFieldSelectionID, EntityID = 1, returnTempFieldSelectionID = F, returnCreatedTime = F, returnFieldID = F, returnFieldName = F, returnModifiedTime = F, returnModuleName = F, returnObjectName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempFieldSelection", TempFieldSelectionID, searchFields, EntityID)
}
#' Modify a specific TempFieldSelection
#'
#' This function modifies fields for a TempFieldSelection.
#'
#' @param TempFieldSelectionID The id of the TempFieldSelection to be modified.\cr Run \code{\link{getAllTempFieldSelections}} for a list of TempFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempFieldSelection <- function(TempFieldSelectionID, EntityID = 1, setFieldID = NULL, setFieldName = NULL, setModuleName = NULL, setObjectName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempFieldSelection", TempFieldSelectionID, names(functionParams), functionParams, EntityID)
}
#' Create new TempFieldSelection.
#'
#' This function creates a new TempFieldSelection.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempFieldSelection <- function(EntityID = 1, setFieldID = NULL, setFieldName = NULL, setModuleName = NULL, setObjectName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempFieldSelection", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempFieldSelection
#'
#' This function deletes a TempFieldSelection.
#'
#' @param TempFieldSelectionID The id of the TempFieldSelection.\cr Run \code{\link{getAllTempFieldSelections}} for a list of TempFieldSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempFieldSelection.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempFieldSelection <- function(TempFieldSelectionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempFieldSelection", TempFieldSelectionID, EntityID)
}
#' Get all TempImportPreviewResultRows.
#'
#' This function returns a dataframe of all TempImportPreviewResultRows in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempImportPreviewResultRows in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempImportPreviewResultRows <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempImportPreviewResultRowID = F, returnCreatedTime = F, returnErrorMessage = F, returnImportFileRowNumber = F, returnModifiedTime = F, returnPreviewData = F, returnResultType = F, returnResultTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempImportPreviewResultRow", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempImportPreviewResultRow
#'
#' This function returns fields for a TempImportPreviewResultRow.
#'
#' @param TempImportPreviewResultRowID The id of the TempImportPreviewResultRow.\cr Run \code{\link{getAllTempImportPreviewResultRows}} for a list of TempImportPreviewResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempImportPreviewResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempImportPreviewResultRow <- function(TempImportPreviewResultRowID, EntityID = 1, returnTempImportPreviewResultRowID = F, returnCreatedTime = F, returnErrorMessage = F, returnImportFileRowNumber = F, returnModifiedTime = F, returnPreviewData = F, returnResultType = F, returnResultTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempImportPreviewResultRow", TempImportPreviewResultRowID, searchFields, EntityID)
}
#' Modify a specific TempImportPreviewResultRow
#'
#' This function modifies fields for a TempImportPreviewResultRow.
#'
#' @param TempImportPreviewResultRowID The id of the TempImportPreviewResultRow to be modified.\cr Run \code{\link{getAllTempImportPreviewResultRows}} for a list of TempImportPreviewResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempImportPreviewResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempImportPreviewResultRow <- function(TempImportPreviewResultRowID, EntityID = 1, setErrorMessage = NULL, setImportFileRowNumber = NULL, setPreviewData = NULL, setResultType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempImportPreviewResultRow", TempImportPreviewResultRowID, names(functionParams), functionParams, EntityID)
}
#' Create new TempImportPreviewResultRow.
#'
#' This function creates a new TempImportPreviewResultRow.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempImportPreviewResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempImportPreviewResultRow <- function(EntityID = 1, setErrorMessage = NULL, setImportFileRowNumber = NULL, setPreviewData = NULL, setResultType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempImportPreviewResultRow", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempImportPreviewResultRow
#'
#' This function deletes a TempImportPreviewResultRow.
#'
#' @param TempImportPreviewResultRowID The id of the TempImportPreviewResultRow.\cr Run \code{\link{getAllTempImportPreviewResultRows}} for a list of TempImportPreviewResultRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempImportPreviewResultRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempImportPreviewResultRow <- function(TempImportPreviewResultRowID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempImportPreviewResultRow", TempImportPreviewResultRowID, EntityID)
}
#' Get all TempLoginHistories.
#'
#' This function returns a dataframe of all TempLoginHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempLoginHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempLoginHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempLoginHistoryID = F, returnBrowserType = F, returnCreatedTime = F, returnDeviceType = F, returnModifiedTime = F, returnOperatingSystemType = F, returnSuccesfulNumberOfLogins = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempLoginHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempLoginHistory
#'
#' This function returns fields for a TempLoginHistory.
#'
#' @param TempLoginHistoryID The id of the TempLoginHistory.\cr Run \code{\link{getAllTempLoginHistories}} for a list of TempLoginHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempLoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempLoginHistory <- function(TempLoginHistoryID, EntityID = 1, returnTempLoginHistoryID = F, returnBrowserType = F, returnCreatedTime = F, returnDeviceType = F, returnModifiedTime = F, returnOperatingSystemType = F, returnSuccesfulNumberOfLogins = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempLoginHistory", TempLoginHistoryID, searchFields, EntityID)
}
#' Modify a specific TempLoginHistory
#'
#' This function modifies fields for a TempLoginHistory.
#'
#' @param TempLoginHistoryID The id of the TempLoginHistory to be modified.\cr Run \code{\link{getAllTempLoginHistories}} for a list of TempLoginHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempLoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempLoginHistory <- function(TempLoginHistoryID, EntityID = 1, setBrowserType = NULL, setDeviceType = NULL, setOperatingSystemType = NULL, setSuccesfulNumberOfLogins = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempLoginHistory", TempLoginHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new TempLoginHistory.
#'
#' This function creates a new TempLoginHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempLoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempLoginHistory <- function(EntityID = 1, setBrowserType = NULL, setDeviceType = NULL, setOperatingSystemType = NULL, setSuccesfulNumberOfLogins = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempLoginHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempLoginHistory
#'
#' This function deletes a TempLoginHistory.
#'
#' @param TempLoginHistoryID The id of the TempLoginHistory.\cr Run \code{\link{getAllTempLoginHistories}} for a list of TempLoginHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempLoginHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempLoginHistory <- function(TempLoginHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempLoginHistory", TempLoginHistoryID, EntityID)
}
#' Get all TempMassChangeResults.
#'
#' This function returns a dataframe of all TempMassChangeResults in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempMassChangeResults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempMassChangeResults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempMassChangeResultID = F, returnCreatedTime = F, returnMessage = F, returnModifiedTime = F, returnObjectIdentifier = F, returnResult = F, returnResultCode = F, returnType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempMassChangeResult", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempMassChangeResult
#'
#' This function returns fields for a TempMassChangeResult.
#'
#' @param TempMassChangeResultID The id of the TempMassChangeResult.\cr Run \code{\link{getAllTempMassChangeResults}} for a list of TempMassChangeResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempMassChangeResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempMassChangeResult <- function(TempMassChangeResultID, EntityID = 1, returnTempMassChangeResultID = F, returnCreatedTime = F, returnMessage = F, returnModifiedTime = F, returnObjectIdentifier = F, returnResult = F, returnResultCode = F, returnType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempMassChangeResult", TempMassChangeResultID, searchFields, EntityID)
}
#' Modify a specific TempMassChangeResult
#'
#' This function modifies fields for a TempMassChangeResult.
#'
#' @param TempMassChangeResultID The id of the TempMassChangeResult to be modified.\cr Run \code{\link{getAllTempMassChangeResults}} for a list of TempMassChangeResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempMassChangeResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempMassChangeResult <- function(TempMassChangeResultID, EntityID = 1, setMessage = NULL, setObjectIdentifier = NULL, setResult = NULL, setResultCode = NULL, setType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempMassChangeResult", TempMassChangeResultID, names(functionParams), functionParams, EntityID)
}
#' Create new TempMassChangeResult.
#'
#' This function creates a new TempMassChangeResult.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempMassChangeResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempMassChangeResult <- function(EntityID = 1, setMessage = NULL, setObjectIdentifier = NULL, setResult = NULL, setResultCode = NULL, setType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempMassChangeResult", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempMassChangeResult
#'
#' This function deletes a TempMassChangeResult.
#'
#' @param TempMassChangeResultID The id of the TempMassChangeResult.\cr Run \code{\link{getAllTempMassChangeResults}} for a list of TempMassChangeResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempMassChangeResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempMassChangeResult <- function(TempMassChangeResultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempMassChangeResult", TempMassChangeResultID, EntityID)
}
#' Get all TempMedias.
#'
#' This function returns a dataframe of all TempMedias in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempMedias in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempMedias <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempMediaID = F, returnCreatedTime = F, returnMediaID = F, returnModifiedTime = F, returnModuleID = F, returnObjectID = F, returnProcessID = F, returnProcessIndicator = F, returnProcessIndicatorCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempMedia", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempMedia
#'
#' This function returns fields for a TempMedia.
#'
#' @param TempMediaID The id of the TempMedia.\cr Run \code{\link{getAllTempMedias}} for a list of TempMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempMedia <- function(TempMediaID, EntityID = 1, returnTempMediaID = F, returnCreatedTime = F, returnMediaID = F, returnModifiedTime = F, returnModuleID = F, returnObjectID = F, returnProcessID = F, returnProcessIndicator = F, returnProcessIndicatorCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempMedia", TempMediaID, searchFields, EntityID)
}
#' Modify a specific TempMedia
#'
#' This function modifies fields for a TempMedia.
#'
#' @param TempMediaID The id of the TempMedia to be modified.\cr Run \code{\link{getAllTempMedias}} for a list of TempMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempMedia <- function(TempMediaID, EntityID = 1, setMediaID = NULL, setModuleID = NULL, setObjectID = NULL, setProcessID = NULL, setProcessIndicator = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempMedia", TempMediaID, names(functionParams), functionParams, EntityID)
}
#' Create new TempMedia.
#'
#' This function creates a new TempMedia.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempMedia <- function(EntityID = 1, setMediaID = NULL, setModuleID = NULL, setObjectID = NULL, setProcessID = NULL, setProcessIndicator = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempMedia", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempMedia
#'
#' This function deletes a TempMedia.
#'
#' @param TempMediaID The id of the TempMedia.\cr Run \code{\link{getAllTempMedias}} for a list of TempMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempMedia <- function(TempMediaID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempMedia", TempMediaID, EntityID)
}
#' Get all TempUploadImportLogs.
#'
#' This function returns a dataframe of all TempUploadImportLogs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempUploadImportLogs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempUploadImportLogs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempUploadImportLogID = F, returnCreatedTime = F, returnFileName = F, returnLogID = F, returnMessage = F, returnModifiedTime = F, returnResult = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempUploadImportLog", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempUploadImportLog
#'
#' This function returns fields for a TempUploadImportLog.
#'
#' @param TempUploadImportLogID The id of the TempUploadImportLog.\cr Run \code{\link{getAllTempUploadImportLogs}} for a list of TempUploadImportLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempUploadImportLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempUploadImportLog <- function(TempUploadImportLogID, EntityID = 1, returnTempUploadImportLogID = F, returnCreatedTime = F, returnFileName = F, returnLogID = F, returnMessage = F, returnModifiedTime = F, returnResult = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempUploadImportLog", TempUploadImportLogID, searchFields, EntityID)
}
#' Modify a specific TempUploadImportLog
#'
#' This function modifies fields for a TempUploadImportLog.
#'
#' @param TempUploadImportLogID The id of the TempUploadImportLog to be modified.\cr Run \code{\link{getAllTempUploadImportLogs}} for a list of TempUploadImportLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempUploadImportLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempUploadImportLog <- function(TempUploadImportLogID, EntityID = 1, setFileName = NULL, setLogID = NULL, setMessage = NULL, setResult = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempUploadImportLog", TempUploadImportLogID, names(functionParams), functionParams, EntityID)
}
#' Create new TempUploadImportLog.
#'
#' This function creates a new TempUploadImportLog.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempUploadImportLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempUploadImportLog <- function(EntityID = 1, setFileName = NULL, setLogID = NULL, setMessage = NULL, setResult = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempUploadImportLog", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempUploadImportLog
#'
#' This function deletes a TempUploadImportLog.
#'
#' @param TempUploadImportLogID The id of the TempUploadImportLog.\cr Run \code{\link{getAllTempUploadImportLogs}} for a list of TempUploadImportLogs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempUploadImportLog.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempUploadImportLog <- function(TempUploadImportLogID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempUploadImportLog", TempUploadImportLogID, EntityID)
}
#' Get all TempUsageHistories.
#'
#' This function returns a dataframe of all TempUsageHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempUsageHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempUsageHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempUsageHistoryID = F, returnAverageServerResponseTime = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUsageHistoryRecordTotal = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempUsageHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempUsageHistory
#'
#' This function returns fields for a TempUsageHistory.
#'
#' @param TempUsageHistoryID The id of the TempUsageHistory.\cr Run \code{\link{getAllTempUsageHistories}} for a list of TempUsageHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempUsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempUsageHistory <- function(TempUsageHistoryID, EntityID = 1, returnTempUsageHistoryID = F, returnAverageServerResponseTime = F, returnCreatedTime = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUsageHistoryRecordTotal = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempUsageHistory", TempUsageHistoryID, searchFields, EntityID)
}
#' Modify a specific TempUsageHistory
#'
#' This function modifies fields for a TempUsageHistory.
#'
#' @param TempUsageHistoryID The id of the TempUsageHistory to be modified.\cr Run \code{\link{getAllTempUsageHistories}} for a list of TempUsageHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempUsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempUsageHistory <- function(TempUsageHistoryID, EntityID = 1, setAverageServerResponseTime = NULL, setModule = NULL, setObject = NULL, setScreen = NULL, setUsageHistoryRecordTotal = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempUsageHistory", TempUsageHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new TempUsageHistory.
#'
#' This function creates a new TempUsageHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempUsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempUsageHistory <- function(EntityID = 1, setAverageServerResponseTime = NULL, setModule = NULL, setObject = NULL, setScreen = NULL, setUsageHistoryRecordTotal = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempUsageHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempUsageHistory
#'
#' This function deletes a TempUsageHistory.
#'
#' @param TempUsageHistoryID The id of the TempUsageHistory.\cr Run \code{\link{getAllTempUsageHistories}} for a list of TempUsageHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempUsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempUsageHistory <- function(TempUsageHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempUsageHistory", TempUsageHistoryID, EntityID)
}
#' Get all TempValidateBusinessObjects.
#'
#' This function returns a dataframe of all TempValidateBusinessObjects in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All TempValidateBusinessObjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempValidateBusinessObjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempValidateBusinessObjectID = F, returnCreatedTime = F, returnModifiedTime = F, returnObjectName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "TempValidateBusinessObject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempValidateBusinessObject
#'
#' This function returns fields for a TempValidateBusinessObject.
#'
#' @param TempValidateBusinessObjectID The id of the TempValidateBusinessObject.\cr Run \code{\link{getAllTempValidateBusinessObjects}} for a list of TempValidateBusinessObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the TempValidateBusinessObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempValidateBusinessObject <- function(TempValidateBusinessObjectID, EntityID = 1, returnTempValidateBusinessObjectID = F, returnCreatedTime = F, returnModifiedTime = F, returnObjectName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "TempValidateBusinessObject", TempValidateBusinessObjectID, searchFields, EntityID)
}
#' Modify a specific TempValidateBusinessObject
#'
#' This function modifies fields for a TempValidateBusinessObject.
#'
#' @param TempValidateBusinessObjectID The id of the TempValidateBusinessObject to be modified.\cr Run \code{\link{getAllTempValidateBusinessObjects}} for a list of TempValidateBusinessObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified TempValidateBusinessObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempValidateBusinessObject <- function(TempValidateBusinessObjectID, EntityID = 1, setObjectName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "TempValidateBusinessObject", TempValidateBusinessObjectID, names(functionParams), functionParams, EntityID)
}
#' Create new TempValidateBusinessObject.
#'
#' This function creates a new TempValidateBusinessObject.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created TempValidateBusinessObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempValidateBusinessObject <- function(EntityID = 1, setObjectName = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "TempValidateBusinessObject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempValidateBusinessObject
#'
#' This function deletes a TempValidateBusinessObject.
#'
#' @param TempValidateBusinessObjectID The id of the TempValidateBusinessObject.\cr Run \code{\link{getAllTempValidateBusinessObjects}} for a list of TempValidateBusinessObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted TempValidateBusinessObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempValidateBusinessObject <- function(TempValidateBusinessObjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "TempValidateBusinessObject", TempValidateBusinessObjectID, EntityID)
}
#' Get all Themes.
#'
#' This function returns a dataframe of all Themes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Themes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllThemes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnThemeID = F, returnCreatedTime = F, returnImageName = F, returnIsDefault = F, returnIsSkywardTheme = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnThemeColors = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Theme", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Theme
#'
#' This function returns fields for a Theme.
#'
#' @param ThemeID The id of the Theme.\cr Run \code{\link{getAllThemes}} for a list of Themes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Theme.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTheme <- function(ThemeID, EntityID = 1, returnThemeID = F, returnCreatedTime = F, returnImageName = F, returnIsDefault = F, returnIsSkywardTheme = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnThemeColors = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Theme", ThemeID, searchFields, EntityID)
}
#' Modify a specific Theme
#'
#' This function modifies fields for a Theme.
#'
#' @param ThemeID The id of the Theme to be modified.\cr Run \code{\link{getAllThemes}} for a list of Themes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Theme.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTheme <- function(ThemeID, EntityID = 1, setImageName = NULL, setIsDefault = NULL, setIsSkywardTheme = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Theme", ThemeID, names(functionParams), functionParams, EntityID)
}
#' Create new Theme.
#'
#' This function creates a new Theme.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Theme.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTheme <- function(EntityID = 1, setImageName = NULL, setIsDefault = NULL, setIsSkywardTheme = NULL, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Theme", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Theme
#'
#' This function deletes a Theme.
#'
#' @param ThemeID The id of the Theme.\cr Run \code{\link{getAllThemes}} for a list of Themes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Theme.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTheme <- function(ThemeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Theme", ThemeID, EntityID)
}
#' Get all ThreadActivities.
#'
#' This function returns a dataframe of all ThreadActivities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ThreadActivities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllThreadActivities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnThreadActivityID = F, returnCreatedTime = F, returnLastSuccess = F, returnLastSuccessTime = F, returnModifiedTime = F, returnServerName = F, returnServiceName = F, returnStartTime = F, returnThreadName = F, returnThreadQueue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ThreadActivity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ThreadActivity
#'
#' This function returns fields for a ThreadActivity.
#'
#' @param ThreadActivityID The id of the ThreadActivity.\cr Run \code{\link{getAllThreadActivities}} for a list of ThreadActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ThreadActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getThreadActivity <- function(ThreadActivityID, EntityID = 1, returnThreadActivityID = F, returnCreatedTime = F, returnLastSuccess = F, returnLastSuccessTime = F, returnModifiedTime = F, returnServerName = F, returnServiceName = F, returnStartTime = F, returnThreadName = F, returnThreadQueue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ThreadActivity", ThreadActivityID, searchFields, EntityID)
}
#' Modify a specific ThreadActivity
#'
#' This function modifies fields for a ThreadActivity.
#'
#' @param ThreadActivityID The id of the ThreadActivity to be modified.\cr Run \code{\link{getAllThreadActivities}} for a list of ThreadActivitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ThreadActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyThreadActivity <- function(ThreadActivityID, EntityID = 1, setLastSuccess = NULL, setServerName = NULL, setServiceName = NULL, setStartTime = NULL, setThreadName = NULL, setThreadQueue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ThreadActivity", ThreadActivityID, names(functionParams), functionParams, EntityID)
}
#' Create new ThreadActivity.
#'
#' This function creates a new ThreadActivity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ThreadActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createThreadActivity <- function(EntityID = 1, setLastSuccess = NULL, setServerName = NULL, setServiceName = NULL, setStartTime = NULL, setThreadName = NULL, setThreadQueue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ThreadActivity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ThreadActivity
#'
#' This function deletes a ThreadActivity.
#'
#' @param ThreadActivityID The id of the ThreadActivity.\cr Run \code{\link{getAllThreadActivities}} for a list of ThreadActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ThreadActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteThreadActivity <- function(ThreadActivityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ThreadActivity", ThreadActivityID, EntityID)
}
#' Get all Tiles.
#'
#' This function returns a dataframe of all Tiles in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All Tiles in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTiles <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTileID = F, returnAggregationType = F, returnAggregationTypeCode = F, returnAnimate = F, returnAnimateClockwise = F, returnAxisLabelColor = F, returnBackgroundColor = F, returnBackgroundColorHex = F, returnBackgroundColorRgba = F, returnChartTileOptions = F, returnChartTitle = F, returnChartType = F, returnChartTypeCode = F, returnCreatedTime = F, returnDashboardID = F, returnDisplayOrder = F, returnDisplayText = F, returnHeight = F, returnIconColor = F, returnIconColorHex = F, returnIconColorRgba = F, returnIsMulticolor = F, returnLabelDisplayType = F, returnLabelDisplayTypeCode = F, returnModifiedTime = F, returnNumberPrefix = F, returnNumberSuffix = F, returnParameters = F, returnPlotHoverEffect = F, returnRotateValues = F, returnShowAlternateHGridColor = F, returnShowAlternateVGridColor = F, returnShowPercentValues = F, returnShowValues = F, returnSizeType = F, returnSizeTypeCode = F, returnTextColor = F, returnTextColorHex = F, returnTextColorRgba = F, returnTileColorType = F, returnTileColorTypeCode = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUseRoundEdges = F, returnWidth = F, returnXAxisLabel = F, returnXAxisVariable = F, returnYAxisLabel = F, returnYAxisVariable = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "Tile", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Tile
#'
#' This function returns fields for a Tile.
#'
#' @param TileID The id of the Tile.\cr Run \code{\link{getAllTiles}} for a list of Tiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the Tile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTile <- function(TileID, EntityID = 1, returnTileID = F, returnAggregationType = F, returnAggregationTypeCode = F, returnAnimate = F, returnAnimateClockwise = F, returnAxisLabelColor = F, returnBackgroundColor = F, returnBackgroundColorHex = F, returnBackgroundColorRgba = F, returnChartTileOptions = F, returnChartTitle = F, returnChartType = F, returnChartTypeCode = F, returnCreatedTime = F, returnDashboardID = F, returnDisplayOrder = F, returnDisplayText = F, returnHeight = F, returnIconColor = F, returnIconColorHex = F, returnIconColorRgba = F, returnIsMulticolor = F, returnLabelDisplayType = F, returnLabelDisplayTypeCode = F, returnModifiedTime = F, returnNumberPrefix = F, returnNumberSuffix = F, returnParameters = F, returnPlotHoverEffect = F, returnRotateValues = F, returnShowAlternateHGridColor = F, returnShowAlternateVGridColor = F, returnShowPercentValues = F, returnShowValues = F, returnSizeType = F, returnSizeTypeCode = F, returnTextColor = F, returnTextColorHex = F, returnTextColorRgba = F, returnTileColorType = F, returnTileColorTypeCode = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUseRoundEdges = F, returnWidth = F, returnXAxisLabel = F, returnXAxisVariable = F, returnYAxisLabel = F, returnYAxisVariable = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "Tile", TileID, searchFields, EntityID)
}
#' Modify a specific Tile
#'
#' This function modifies fields for a Tile.
#'
#' @param TileID The id of the Tile to be modified.\cr Run \code{\link{getAllTiles}} for a list of Tiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified Tile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTile <- function(TileID, EntityID = 1, setAggregationType = NULL, setAggregationTypeCode = NULL, setAnimate = NULL, setAnimateClockwise = NULL, setAxisLabelColor = NULL, setBackgroundColor = NULL, setBackgroundColorHex = NULL, setBackgroundColorRgba = NULL, setChartTileOptions = NULL, setChartTitle = NULL, setChartType = NULL, setChartTypeCode = NULL, setDashboardID = NULL, setDisplayOrder = NULL, setDisplayText = NULL, setHeight = NULL, setIconColor = NULL, setIconColorHex = NULL, setIconColorRgba = NULL, setIsMulticolor = NULL, setLabelDisplayType = NULL, setLabelDisplayTypeCode = NULL, setNumberPrefix = NULL, setNumberSuffix = NULL, setParameters = NULL, setPlotHoverEffect = NULL, setRotateValues = NULL, setShowAlternateHGridColor = NULL, setShowAlternateVGridColor = NULL, setShowPercentValues = NULL, setShowValues = NULL, setSizeType = NULL, setSizeTypeCode = NULL, setTextColor = NULL, setTextColorHex = NULL, setTextColorRgba = NULL, setTileColorType = NULL, setTileColorTypeCode = NULL, setType = NULL, setTypeCode = NULL, setUseRoundEdges = NULL, setWidth = NULL, setXAxisLabel = NULL, setXAxisVariable = NULL, setYAxisLabel = NULL, setYAxisVariable = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "Tile", TileID, names(functionParams), functionParams, EntityID)
}
#' Create new Tile.
#'
#' This function creates a new Tile.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created Tile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTile <- function(EntityID = 1, setAggregationType = NULL, setAggregationTypeCode = NULL, setAnimate = NULL, setAnimateClockwise = NULL, setAxisLabelColor = NULL, setBackgroundColor = NULL, setBackgroundColorHex = NULL, setBackgroundColorRgba = NULL, setChartTileOptions = NULL, setChartTitle = NULL, setChartType = NULL, setChartTypeCode = NULL, setDashboardID = NULL, setDisplayOrder = NULL, setDisplayText = NULL, setHeight = NULL, setIconColor = NULL, setIconColorHex = NULL, setIconColorRgba = NULL, setIsMulticolor = NULL, setLabelDisplayType = NULL, setLabelDisplayTypeCode = NULL, setNumberPrefix = NULL, setNumberSuffix = NULL, setParameters = NULL, setPlotHoverEffect = NULL, setRotateValues = NULL, setShowAlternateHGridColor = NULL, setShowAlternateVGridColor = NULL, setShowPercentValues = NULL, setShowValues = NULL, setSizeType = NULL, setSizeTypeCode = NULL, setTextColor = NULL, setTextColorHex = NULL, setTextColorRgba = NULL, setTileColorType = NULL, setTileColorTypeCode = NULL, setType = NULL, setTypeCode = NULL, setUseRoundEdges = NULL, setWidth = NULL, setXAxisLabel = NULL, setXAxisVariable = NULL, setYAxisLabel = NULL, setYAxisVariable = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "Tile", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Tile
#'
#' This function deletes a Tile.
#'
#' @param TileID The id of the Tile.\cr Run \code{\link{getAllTiles}} for a list of Tiles.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted Tile.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTile <- function(TileID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "Tile", TileID, EntityID)
}
#' Get all UNCPaths.
#'
#' This function returns a dataframe of all UNCPaths in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UNCPaths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUNCPaths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUNCPathID = F, returnCreatedTime = F, returnDomain = F, returnLocation = F, returnModifiedTime = F, returnPassword = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUsername = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UNCPath", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UNCPath
#'
#' This function returns fields for an UNCPath.
#'
#' @param UNCPathID The id of the UNCPath.\cr Run \code{\link{getAllUNCPaths}} for a list of UNCPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UNCPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUNCPath <- function(UNCPathID, EntityID = 1, returnUNCPathID = F, returnCreatedTime = F, returnDomain = F, returnLocation = F, returnModifiedTime = F, returnPassword = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUsername = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UNCPath", UNCPathID, searchFields, EntityID)
}
#' Modify a specific UNCPath
#'
#' This function modifies fields for an UNCPath.
#'
#' @param UNCPathID The id of the UNCPath to be modified.\cr Run \code{\link{getAllUNCPaths}} for a list of UNCPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UNCPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUNCPath <- function(UNCPathID, EntityID = 1, setDomain = NULL, setLocation = NULL, setPassword = NULL, setUsername = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UNCPath", UNCPathID, names(functionParams), functionParams, EntityID)
}
#' Create new UNCPath.
#'
#' This function creates a new UNCPath.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UNCPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUNCPath <- function(EntityID = 1, setDomain = NULL, setLocation = NULL, setPassword = NULL, setUsername = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UNCPath", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UNCPath
#'
#' This function deletes an UNCPath.
#'
#' @param UNCPathID The id of the UNCPath.\cr Run \code{\link{getAllUNCPaths}} for a list of UNCPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UNCPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUNCPath <- function(UNCPathID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UNCPath", UNCPathID, EntityID)
}
#' Get all UpdateTrackers.
#'
#' This function returns a dataframe of all UpdateTrackers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UpdateTrackers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUpdateTrackers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUpdateTrackerID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnHasBeenProcessed = F, returnModifiedTime = F, returnUpdateType = F, returnUpdateTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UpdateTracker", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UpdateTracker
#'
#' This function returns fields for an UpdateTracker.
#'
#' @param UpdateTrackerID The id of the UpdateTracker.\cr Run \code{\link{getAllUpdateTrackers}} for a list of UpdateTrackers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UpdateTracker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUpdateTracker <- function(UpdateTrackerID, EntityID = 1, returnUpdateTrackerID = F, returnApplySchemaChangeRunID = F, returnCreatedTime = F, returnHasBeenProcessed = F, returnModifiedTime = F, returnUpdateType = F, returnUpdateTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UpdateTracker", UpdateTrackerID, searchFields, EntityID)
}
#' Modify a specific UpdateTracker
#'
#' This function modifies fields for an UpdateTracker.
#'
#' @param UpdateTrackerID The id of the UpdateTracker to be modified.\cr Run \code{\link{getAllUpdateTrackers}} for a list of UpdateTrackers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UpdateTracker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUpdateTracker <- function(UpdateTrackerID, EntityID = 1, setApplySchemaChangeRunID = NULL, setHasBeenProcessed = NULL, setUpdateType = NULL, setUpdateTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UpdateTracker", UpdateTrackerID, names(functionParams), functionParams, EntityID)
}
#' Create new UpdateTracker.
#'
#' This function creates a new UpdateTracker.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UpdateTracker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUpdateTracker <- function(EntityID = 1, setApplySchemaChangeRunID = NULL, setHasBeenProcessed = NULL, setUpdateType = NULL, setUpdateTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UpdateTracker", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UpdateTracker
#'
#' This function deletes an UpdateTracker.
#'
#' @param UpdateTrackerID The id of the UpdateTracker.\cr Run \code{\link{getAllUpdateTrackers}} for a list of UpdateTrackers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UpdateTracker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUpdateTracker <- function(UpdateTrackerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UpdateTracker", UpdateTrackerID, EntityID)
}
#' Get all UsageHistories.
#'
#' This function returns a dataframe of all UsageHistories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UsageHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUsageHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUsageHistoryID = F, returnBrowseFilterID = F, returnBrowseViewID = F, returnCreatedTime = F, returnDataObjectID = F, returnEntityID = F, returnFiscalYearID = F, returnFriendlyName = F, returnHostAddress = F, returnHostname = F, returnImpersonationID = F, returnIsFullPageLoad = F, returnModifiedTime = F, returnModule = F, returnModulePath = F, returnNetworkTimeMilliseconds = F, returnObject = F, returnPageGUID = F, returnResponseSize = F, returnSchoolYearID = F, returnScreen = F, returnServerResponseTimeMilliseconds = F, returnSessionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWindowGUID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UsageHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UsageHistory
#'
#' This function returns fields for an UsageHistory.
#'
#' @param UsageHistoryID The id of the UsageHistory.\cr Run \code{\link{getAllUsageHistories}} for a list of UsageHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUsageHistory <- function(UsageHistoryID, EntityID = 1, returnUsageHistoryID = F, returnBrowseFilterID = F, returnBrowseViewID = F, returnCreatedTime = F, returnDataObjectID = F, returnEntityID = F, returnFiscalYearID = F, returnFriendlyName = F, returnHostAddress = F, returnHostname = F, returnImpersonationID = F, returnIsFullPageLoad = F, returnModifiedTime = F, returnModule = F, returnModulePath = F, returnNetworkTimeMilliseconds = F, returnObject = F, returnPageGUID = F, returnResponseSize = F, returnSchoolYearID = F, returnScreen = F, returnServerResponseTimeMilliseconds = F, returnSessionID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWindowGUID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UsageHistory", UsageHistoryID, searchFields, EntityID)
}
#' Modify a specific UsageHistory
#'
#' This function modifies fields for an UsageHistory.
#'
#' @param UsageHistoryID The id of the UsageHistory to be modified.\cr Run \code{\link{getAllUsageHistories}} for a list of UsageHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUsageHistory <- function(UsageHistoryID, EntityID = 1, setBrowseFilterID = NULL, setBrowseViewID = NULL, setDataObjectID = NULL, setEntityID = NULL, setFiscalYearID = NULL, setHostAddress = NULL, setHostname = NULL, setImpersonationID = NULL, setIsFullPageLoad = NULL, setModule = NULL, setNetworkTimeMilliseconds = NULL, setObject = NULL, setPageGUID = NULL, setResponseSize = NULL, setSchoolYearID = NULL, setScreen = NULL, setServerResponseTimeMilliseconds = NULL, setSessionID = NULL, setWindowGUID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UsageHistory", UsageHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new UsageHistory.
#'
#' This function creates a new UsageHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUsageHistory <- function(EntityID = 1, setBrowseFilterID = NULL, setBrowseViewID = NULL, setDataObjectID = NULL, setEntityID = NULL, setFiscalYearID = NULL, setHostAddress = NULL, setHostname = NULL, setImpersonationID = NULL, setIsFullPageLoad = NULL, setModule = NULL, setNetworkTimeMilliseconds = NULL, setObject = NULL, setPageGUID = NULL, setResponseSize = NULL, setSchoolYearID = NULL, setScreen = NULL, setServerResponseTimeMilliseconds = NULL, setSessionID = NULL, setWindowGUID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UsageHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UsageHistory
#'
#' This function deletes an UsageHistory.
#'
#' @param UsageHistoryID The id of the UsageHistory.\cr Run \code{\link{getAllUsageHistories}} for a list of UsageHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UsageHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUsageHistory <- function(UsageHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UsageHistory", UsageHistoryID, EntityID)
}
#' Get all UserDocks.
#'
#' This function returns a dataframe of all UserDocks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UserDocks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUserDocks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUserDockID = F, returnCreatedTime = F, returnDescription = F, returnDisplayOrder = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UserDock", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UserDock
#'
#' This function returns fields for an UserDock.
#'
#' @param UserDockID The id of the UserDock.\cr Run \code{\link{getAllUserDocks}} for a list of UserDocks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UserDock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUserDock <- function(UserDockID, EntityID = 1, returnUserDockID = F, returnCreatedTime = F, returnDescription = F, returnDisplayOrder = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UserDock", UserDockID, searchFields, EntityID)
}
#' Modify a specific UserDock
#'
#' This function modifies fields for an UserDock.
#'
#' @param UserDockID The id of the UserDock to be modified.\cr Run \code{\link{getAllUserDocks}} for a list of UserDocks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UserDock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUserDock <- function(UserDockID, EntityID = 1, setDescription = NULL, setDisplayOrder = NULL, setModule = NULL, setObject = NULL, setScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UserDock", UserDockID, names(functionParams), functionParams, EntityID)
}
#' Create new UserDock.
#'
#' This function creates a new UserDock.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UserDock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUserDock <- function(EntityID = 1, setDescription = NULL, setDisplayOrder = NULL, setModule = NULL, setObject = NULL, setScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UserDock", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UserDock
#'
#' This function deletes an UserDock.
#'
#' @param UserDockID The id of the UserDock.\cr Run \code{\link{getAllUserDocks}} for a list of UserDocks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UserDock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUserDock <- function(UserDockID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UserDock", UserDockID, EntityID)
}
#' Get all UserFavorites.
#'
#' This function returns a dataframe of all UserFavorites in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UserFavorites in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUserFavorites <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUserFavoriteID = F, returnCreatedTime = F, returnDisplayOrder = F, returnFriendlyName = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UserFavorite", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UserFavorite
#'
#' This function returns fields for an UserFavorite.
#'
#' @param UserFavoriteID The id of the UserFavorite.\cr Run \code{\link{getAllUserFavorites}} for a list of UserFavorites.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UserFavorite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUserFavorite <- function(UserFavoriteID, EntityID = 1, returnUserFavoriteID = F, returnCreatedTime = F, returnDisplayOrder = F, returnFriendlyName = F, returnModifiedTime = F, returnModule = F, returnObject = F, returnScreen = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UserFavorite", UserFavoriteID, searchFields, EntityID)
}
#' Modify a specific UserFavorite
#'
#' This function modifies fields for an UserFavorite.
#'
#' @param UserFavoriteID The id of the UserFavorite to be modified.\cr Run \code{\link{getAllUserFavorites}} for a list of UserFavorites.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UserFavorite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUserFavorite <- function(UserFavoriteID, EntityID = 1, setDisplayOrder = NULL, setFriendlyName = NULL, setModule = NULL, setObject = NULL, setScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UserFavorite", UserFavoriteID, names(functionParams), functionParams, EntityID)
}
#' Create new UserFavorite.
#'
#' This function creates a new UserFavorite.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UserFavorite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUserFavorite <- function(EntityID = 1, setDisplayOrder = NULL, setFriendlyName = NULL, setModule = NULL, setObject = NULL, setScreen = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UserFavorite", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UserFavorite
#'
#' This function deletes an UserFavorite.
#'
#' @param UserFavoriteID The id of the UserFavorite.\cr Run \code{\link{getAllUserFavorites}} for a list of UserFavorites.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UserFavorite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUserFavorite <- function(UserFavoriteID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UserFavorite", UserFavoriteID, EntityID)
}
#' Get all UserImportApprovals.
#'
#' This function returns a dataframe of all UserImportApprovals in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UserImportApprovals in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUserImportApprovals <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUserImportApprovalID = F, returnApprovalDate = F, returnCreatedTime = F, returnIsExpired = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UserImportApproval", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UserImportApproval
#'
#' This function returns fields for an UserImportApproval.
#'
#' @param UserImportApprovalID The id of the UserImportApproval.\cr Run \code{\link{getAllUserImportApprovals}} for a list of UserImportApprovals.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UserImportApproval.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUserImportApproval <- function(UserImportApprovalID, EntityID = 1, returnUserImportApprovalID = F, returnApprovalDate = F, returnCreatedTime = F, returnIsExpired = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UserImportApproval", UserImportApprovalID, searchFields, EntityID)
}
#' Modify a specific UserImportApproval
#'
#' This function modifies fields for an UserImportApproval.
#'
#' @param UserImportApprovalID The id of the UserImportApproval to be modified.\cr Run \code{\link{getAllUserImportApprovals}} for a list of UserImportApprovals.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UserImportApproval.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUserImportApproval <- function(UserImportApprovalID, EntityID = 1, setApprovalDate = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UserImportApproval", UserImportApprovalID, names(functionParams), functionParams, EntityID)
}
#' Create new UserImportApproval.
#'
#' This function creates a new UserImportApproval.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UserImportApproval.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUserImportApproval <- function(EntityID = 1, setApprovalDate = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UserImportApproval", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UserImportApproval
#'
#' This function deletes an UserImportApproval.
#'
#' @param UserImportApprovalID The id of the UserImportApproval.\cr Run \code{\link{getAllUserImportApprovals}} for a list of UserImportApprovals.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UserImportApproval.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUserImportApproval <- function(UserImportApprovalID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UserImportApproval", UserImportApprovalID, EntityID)
}
#' Get all UserMenuModules.
#'
#' This function returns a dataframe of all UserMenuModules in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UserMenuModules in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUserMenuModules <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUserMenuModuleID = F, returnCreatedTime = F, returnDisplayOrder = F, returnMenuModuleID = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UserMenuModule", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UserMenuModule
#'
#' This function returns fields for an UserMenuModule.
#'
#' @param UserMenuModuleID The id of the UserMenuModule.\cr Run \code{\link{getAllUserMenuModules}} for a list of UserMenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UserMenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUserMenuModule <- function(UserMenuModuleID, EntityID = 1, returnUserMenuModuleID = F, returnCreatedTime = F, returnDisplayOrder = F, returnMenuModuleID = F, returnModifiedTime = F, returnUserID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UserMenuModule", UserMenuModuleID, searchFields, EntityID)
}
#' Modify a specific UserMenuModule
#'
#' This function modifies fields for an UserMenuModule.
#'
#' @param UserMenuModuleID The id of the UserMenuModule to be modified.\cr Run \code{\link{getAllUserMenuModules}} for a list of UserMenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UserMenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUserMenuModule <- function(UserMenuModuleID, EntityID = 1, setDisplayOrder = NULL, setMenuModuleID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UserMenuModule", UserMenuModuleID, names(functionParams), functionParams, EntityID)
}
#' Create new UserMenuModule.
#'
#' This function creates a new UserMenuModule.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UserMenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUserMenuModule <- function(EntityID = 1, setDisplayOrder = NULL, setMenuModuleID = NULL, setUserID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UserMenuModule", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UserMenuModule
#'
#' This function deletes an UserMenuModule.
#'
#' @param UserMenuModuleID The id of the UserMenuModule.\cr Run \code{\link{getAllUserMenuModules}} for a list of UserMenuModules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UserMenuModule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUserMenuModule <- function(UserMenuModuleID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UserMenuModule", UserMenuModuleID, EntityID)
}
#' Get all UsernameStructures.
#'
#' This function returns a dataframe of all UsernameStructures in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All UsernameStructures in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllUsernameStructures <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnUsernameStructureID = F, returnCharacterLimitGroupID = F, returnCreatedTime = F, returnGroupTruncationOrder = F, returnIsEmployeeEmail = F, returnIsEmployeeUser = F, returnIsGuardianUser = F, returnIsStaffUser = F, returnIsStudentEmail = F, returnIsStudentUser = F, returnLimitCharacterNumber = F, returnLimitCharacterType = F, returnLimitCharacterTypeCode = F, returnMinimumLength = F, returnMinimumTiebreakerLength = F, returnModifiedTime = F, returnPartType = F, returnPartTypeCode = F, returnRank = F, returnText = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "UsernameStructure", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific UsernameStructure
#'
#' This function returns fields for an UsernameStructure.
#'
#' @param UsernameStructureID The id of the UsernameStructure.\cr Run \code{\link{getAllUsernameStructures}} for a list of UsernameStructures.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the UsernameStructure.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getUsernameStructure <- function(UsernameStructureID, EntityID = 1, returnUsernameStructureID = F, returnCharacterLimitGroupID = F, returnCreatedTime = F, returnGroupTruncationOrder = F, returnIsEmployeeEmail = F, returnIsEmployeeUser = F, returnIsGuardianUser = F, returnIsStaffUser = F, returnIsStudentEmail = F, returnIsStudentUser = F, returnLimitCharacterNumber = F, returnLimitCharacterType = F, returnLimitCharacterTypeCode = F, returnMinimumLength = F, returnMinimumTiebreakerLength = F, returnModifiedTime = F, returnPartType = F, returnPartTypeCode = F, returnRank = F, returnText = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "UsernameStructure", UsernameStructureID, searchFields, EntityID)
}
#' Modify a specific UsernameStructure
#'
#' This function modifies fields for an UsernameStructure.
#'
#' @param UsernameStructureID The id of the UsernameStructure to be modified.\cr Run \code{\link{getAllUsernameStructures}} for a list of UsernameStructures.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified UsernameStructure.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyUsernameStructure <- function(UsernameStructureID, EntityID = 1, setCharacterLimitGroupID = NULL, setGroupTruncationOrder = NULL, setIsEmployeeEmail = NULL, setIsEmployeeUser = NULL, setIsGuardianUser = NULL, setIsStaffUser = NULL, setIsStudentEmail = NULL, setIsStudentUser = NULL, setLimitCharacterNumber = NULL, setLimitCharacterType = NULL, setLimitCharacterTypeCode = NULL, setMinimumLength = NULL, setMinimumTiebreakerLength = NULL, setPartType = NULL, setPartTypeCode = NULL, setRank = NULL, setText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "UsernameStructure", UsernameStructureID, names(functionParams), functionParams, EntityID)
}
#' Create new UsernameStructure.
#'
#' This function creates a new UsernameStructure.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created UsernameStructure.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createUsernameStructure <- function(EntityID = 1, setCharacterLimitGroupID = NULL, setGroupTruncationOrder = NULL, setIsEmployeeEmail = NULL, setIsEmployeeUser = NULL, setIsGuardianUser = NULL, setIsStaffUser = NULL, setIsStudentEmail = NULL, setIsStudentUser = NULL, setLimitCharacterNumber = NULL, setLimitCharacterType = NULL, setLimitCharacterTypeCode = NULL, setMinimumLength = NULL, setMinimumTiebreakerLength = NULL, setPartType = NULL, setPartTypeCode = NULL, setRank = NULL, setText = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "UsernameStructure", names(functionParams), functionParams, EntityID)
}
#' Delete a specific UsernameStructure
#'
#' This function deletes an UsernameStructure.
#'
#' @param UsernameStructureID The id of the UsernameStructure.\cr Run \code{\link{getAllUsernameStructures}} for a list of UsernameStructures.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted UsernameStructure.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteUsernameStructure <- function(UsernameStructureID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "UsernameStructure", UsernameStructureID, EntityID)
}
#' Get all ValidationRules.
#'
#' This function returns a dataframe of all ValidationRules in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ValidationRules in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllValidationRules <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnValidationRuleID = F, returnApplyOnDelete = F, returnApplyOnInsert = F, returnApplyOnUpdate = F, returnCondition = F, returnConditionData = F, returnCreatedTime = F, returnField = F, returnIgnoreOnAutoDeleteRelationship = F, returnIsActive = F, returnIsRequiredField = F, returnIsSkywardValidationRule = F, returnMessage = F, returnModifiedTime = F, returnModule = F, returnNullRelationshipBehavior = F, returnNullRelationshipBehaviorCode = F, returnObject = F, returnScreen = F, returnSeverityType = F, returnSeverityTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnTask = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ValidationRule", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ValidationRule
#'
#' This function returns fields for a ValidationRule.
#'
#' @param ValidationRuleID The id of the ValidationRule.\cr Run \code{\link{getAllValidationRules}} for a list of ValidationRules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ValidationRule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getValidationRule <- function(ValidationRuleID, EntityID = 1, returnValidationRuleID = F, returnApplyOnDelete = F, returnApplyOnInsert = F, returnApplyOnUpdate = F, returnCondition = F, returnConditionData = F, returnCreatedTime = F, returnField = F, returnIgnoreOnAutoDeleteRelationship = F, returnIsActive = F, returnIsRequiredField = F, returnIsSkywardValidationRule = F, returnMessage = F, returnModifiedTime = F, returnModule = F, returnNullRelationshipBehavior = F, returnNullRelationshipBehaviorCode = F, returnObject = F, returnScreen = F, returnSeverityType = F, returnSeverityTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnTask = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ValidationRule", ValidationRuleID, searchFields, EntityID)
}
#' Modify a specific ValidationRule
#'
#' This function modifies fields for a ValidationRule.
#'
#' @param ValidationRuleID The id of the ValidationRule to be modified.\cr Run \code{\link{getAllValidationRules}} for a list of ValidationRules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ValidationRule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyValidationRule <- function(ValidationRuleID, EntityID = 1, setApplyOnDelete = NULL, setApplyOnInsert = NULL, setApplyOnUpdate = NULL, setConditionData = NULL, setField = NULL, setIgnoreOnAutoDeleteRelationship = NULL, setIsActive = NULL, setIsRequiredField = NULL, setMessage = NULL, setModule = NULL, setNullRelationshipBehavior = NULL, setNullRelationshipBehaviorCode = NULL, setObject = NULL, setScreen = NULL, setSeverityType = NULL, setSeverityTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTask = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ValidationRule", ValidationRuleID, names(functionParams), functionParams, EntityID)
}
#' Create new ValidationRule.
#'
#' This function creates a new ValidationRule.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ValidationRule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createValidationRule <- function(EntityID = 1, setApplyOnDelete = NULL, setApplyOnInsert = NULL, setApplyOnUpdate = NULL, setConditionData = NULL, setField = NULL, setIgnoreOnAutoDeleteRelationship = NULL, setIsActive = NULL, setIsRequiredField = NULL, setMessage = NULL, setModule = NULL, setNullRelationshipBehavior = NULL, setNullRelationshipBehaviorCode = NULL, setObject = NULL, setScreen = NULL, setSeverityType = NULL, setSeverityTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setTask = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ValidationRule", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ValidationRule
#'
#' This function deletes a ValidationRule.
#'
#' @param ValidationRuleID The id of the ValidationRule.\cr Run \code{\link{getAllValidationRules}} for a list of ValidationRules.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ValidationRule.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteValidationRule <- function(ValidationRuleID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ValidationRule", ValidationRuleID, EntityID)
}
#' Get all ValueSources.
#'
#' This function returns a dataframe of all ValueSources in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return All ValueSources in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllValueSources <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnValueSourceID = F, returnBooleanValue = F, returnColumn = F, returnColumnIndex = F, returnCreatedTime = F, returnDataObjectFieldPathIDDisplay = F, returnDataType = F, returnDataTypeCode = F, returnDateTimeDateValue = F, returnDateTimeTimeValue = F, returnDecimalValue = F, returnFieldIDKey = F, returnFilterSearchCondition = F, returnFilterXML = F, returnImportID = F, returnMissingCrossReferenceAction = F, returnModifiedTime = F, returnName = F, returnNumberValue = F, returnPositionStart = F, returnPromptType = F, returnPromptTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnSourceType = F, returnSourceTypeCode = F, returnSourceTypeInstance = F, returnTextValue = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F, returnWidth = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("SkySys", "ValueSource", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ValueSource
#'
#' This function returns fields for a ValueSource.
#'
#' @param ValueSourceID The id of the ValueSource.\cr Run \code{\link{getAllValueSources}} for a list of ValueSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept SkySys
#' @return Details for the ValueSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getValueSource <- function(ValueSourceID, EntityID = 1, returnValueSourceID = F, returnBooleanValue = F, returnColumn = F, returnColumnIndex = F, returnCreatedTime = F, returnDataObjectFieldPathIDDisplay = F, returnDataType = F, returnDataTypeCode = F, returnDateTimeDateValue = F, returnDateTimeTimeValue = F, returnDecimalValue = F, returnFieldIDKey = F, returnFilterSearchCondition = F, returnFilterXML = F, returnImportID = F, returnMissingCrossReferenceAction = F, returnModifiedTime = F, returnName = F, returnNumberValue = F, returnPositionStart = F, returnPromptType = F, returnPromptTypeCode = F, returnSkywardHash = F, returnSkywardID = F, returnSourceType = F, returnSourceTypeCode = F, returnSourceTypeInstance = F, returnTextValue = F, returnUniqueID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = F, returnWidth = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("SkySys", "ValueSource", ValueSourceID, searchFields, EntityID)
}
#' Modify a specific ValueSource
#'
#' This function modifies fields for a ValueSource.
#'
#' @param ValueSourceID The id of the ValueSource to be modified.\cr Run \code{\link{getAllValueSources}} for a list of ValueSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return Details of the modified ValueSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyValueSource <- function(ValueSourceID, EntityID = 1, setBooleanValue = NULL, setColumn = NULL, setDataObjectFieldPathIDDisplay = NULL, setDataType = NULL, setDataTypeCode = NULL, setDateTimeDateValue = NULL, setDateTimeTimeValue = NULL, setDecimalValue = NULL, setFieldIDKey = NULL, setFilterXML = NULL, setImportID = NULL, setMissingCrossReferenceAction = NULL, setName = NULL, setNumberValue = NULL, setPositionStart = NULL, setPromptType = NULL, setPromptTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSourceType = NULL, setSourceTypeCode = NULL, setTextValue = NULL, setUniqueID = NULL, setValue = NULL, setWidth = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("SkySys", "ValueSource", ValueSourceID, names(functionParams), functionParams, EntityID)
}
#' Create new ValueSource.
#'
#' This function creates a new ValueSource.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept SkySys
#' @return The fields used to define the newly created ValueSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createValueSource <- function(EntityID = 1, setBooleanValue = NULL, setColumn = NULL, setDataObjectFieldPathIDDisplay = NULL, setDataType = NULL, setDataTypeCode = NULL, setDateTimeDateValue = NULL, setDateTimeTimeValue = NULL, setDecimalValue = NULL, setFieldIDKey = NULL, setFilterXML = NULL, setImportID = NULL, setMissingCrossReferenceAction = NULL, setName = NULL, setNumberValue = NULL, setPositionStart = NULL, setPromptType = NULL, setPromptTypeCode = NULL, setSkywardHash = NULL, setSkywardID = NULL, setSourceType = NULL, setSourceTypeCode = NULL, setTextValue = NULL, setUniqueID = NULL, setValue = NULL, setWidth = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("SkySys", "ValueSource", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ValueSource
#'
#' This function deletes a ValueSource.
#'
#' @param ValueSourceID The id of the ValueSource.\cr Run \code{\link{getAllValueSources}} for a list of ValueSources.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept SkySys
#' @return The id of the deleted ValueSource.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteValueSource <- function(ValueSourceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("SkySys", "ValueSource", ValueSourceID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.