createField: Create a Field

In samterfa/rqmlativ: Creates R Functions for Skyward Qmlativ's Generic API

Description

This function creates a Field

Usage

createField(
  CurrentDisplayName = NULL,
  CurrentFieldWidth = NULL,
  CurrentIsRequired = NULL,
  CurrentName = NULL,
  CurrentPrecision = NULL,
  CurrentScale = NULL,
  CurrentSize = NULL,
  CurrentType = NULL,
  CustomizationID = NULL,
  Description = NULL,
  IsDeniable = NULL,
  IsPrimaryKey = NULL,
  ObjectID = NULL,
  PendingDisplayName = NULL,
  PendingFieldWidth = NULL,
  PendingIsRequired = NULL,
  PendingName = NULL,
  PendingPrecision = NULL,
  PendingScale = NULL,
  PendingSize = NULL,
  PendingType = NULL,
  Status = NULL,
  UserCanEdit = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

Arguments

entityId	The id of the entity (school). Run listEntities for a list of entities. Defaults to 1 (district).
query	Queries to be added to the request. Ex. list(SchoolYearID = 1). Defaults to NULL.
flatten	Whether to flatten result into a dataframe or return the json object. Default is TRUE (flatten to dataframe).
returnResponse	Whether to return the server response instead of the results. Useful for debugging. Default is FALSE.
fieldNames	The field values to give the created Field. Each defaults to NULL.

Value

A newly created Field Skyward's Knowledge Hub

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