getChangeRequest: Get a specific ChangeRequest

Description Usage Arguments Value References

View source: R/FamilyFunctions.R

Description

This function returns fields for a ChangeRequest.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
getChangeRequest(
  ChangeRequestID,
  EntityID = 1,
  returnChangeRequestID = F,
  returnArea = F,
  returnAreaCode = F,
  returnCreatedTime = F,
  returnEntityID = F,
  returnModifiedTime = F,
  returnNameID = F,
  returnSchoolYearID = F,
  returnStatus = F,
  returnStatusCode = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F
)

Arguments

ChangeRequestID

The id of the ChangeRequest.
Run getAllChangeRequests for a list of ChangeRequests.

EntityID

The id of the entity. Run getAllEntities for a list of entities.

returnFieldName

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.

Value

Details for the ChangeRequest.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.