getDataMiningReportFieldFilter: Get a specific DataMiningReportFieldFilter

Description Usage Arguments Value References

View source: R/ReportingFunctions.R

Description

This function returns fields for a DataMiningReportFieldFilter.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
getDataMiningReportFieldFilter(
  DataMiningReportFieldFilterID,
  EntityID = 1,
  returnDataMiningReportFieldFilterID = F,
  returnComparisonType = F,
  returnComparisonTypeCode = F,
  returnCreatedTime = F,
  returnCurrentUserCanRead = F,
  returnDataMiningReportID = F,
  returnDistinctMultiSelectFieldPath = F,
  returnDistinctMultiSelectModule = F,
  returnDistinctMultiSelectObject = F,
  returnDistinctMultiSelectSchemaObject = F,
  returnFilterType = F,
  returnFilterTypeCode = F,
  returnFilterValue = F,
  returnFormatedDisplayValue = F,
  returnHigh = F,
  returnIsPrompt = F,
  returnList = F,
  returnListAsJsonDictionaryString = F,
  returnListAsJsonListString = F,
  returnListBackingData = F,
  returnListDisplayValue = F,
  returnLow = F,
  returnModifiedTime = F,
  returnPromptIsRequired = F,
  returnPromptLabel = F,
  returnSubtopicFieldID = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F
)

Arguments

DataMiningReportFieldFilterID

The id of the DataMiningReportFieldFilter.
Run getAllDataMiningReportFieldFilters for a list of DataMiningReportFieldFilters.

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 DataMiningReportFieldFilter.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub


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