Resources
post /filter-aware-metadata/continuous-variable
Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.
curl -X POST \
+ Resources
post /filter-aware-metadata/continuous-variable
Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/filter-aware-metadata/continuous-variable
Request Body chevron_right expand_more
ContinuousVariableMetadataPostRequest ContinuousVariableMetadataPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ContinuousVariableMetadataSpec
config.variable* object Inherits: object
config.variable.entityId* string config.variable.variableId* string config.metadata* array config.metadata[] string Enum:- binRanges
- median
200 OK chevron_right expand_more
ContinuousVariableMetadataPostResponse ContinuousVariableMetadataPostResponse
application/json
Inherits: object
Parameter Type Description binRanges object Inherits: object
binRanges.equalInterval* array binRanges.equalInterval[] object Inherits: lib.Range
binRanges.equalInterval[].min* string binRanges.equalInterval[].max* string binRanges.equalInterval[].label* string binRanges.quantile* array binRanges.quantile[] object Inherits: lib.Range
binRanges.quantile[].min* string binRanges.quantile[].max* string binRanges.quantile[].label* string binRanges.standardDeviation* array binRanges.standardDeviation[] object Inherits: lib.Range
binRanges.standardDeviation[].min* string binRanges.standardDeviation[].max* string binRanges.standardDeviation[].label* string median number
get /apps
200 OK chevron_right expand_more
AppsGetResponse AppsGetResponse
application/json
Additional properties: Yes
Inherits: object
Parameter Type Description apps* array apps[] object Inherits: lib.AppOverview
apps[].name* string apps[].displayName* string apps[].description* string apps[].projects* array apps[].projects[] string apps[].computeName string apps[].visualizations* array apps[].visualizations[] object Inherits: lib.VisualizationOverview
apps[].visualizations[].name* string apps[].visualizations[].displayName* string apps[].visualizations[].description* string apps[].visualizations[].projects* array apps[].visualizations[].projects[] string apps[].visualizations[].maxPanels* number apps[].visualizations[].dataElementConstraints array apps[].visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
apps[].visualizations[].dataElementConstraints[].//* object Inherits: object
apps[].visualizations[].dataElementConstraints[].//.isRequired* boolean apps[].visualizations[].dataElementConstraints[].//.isTemporal* boolean apps[].visualizations[].dataElementConstraints[].//.isCollection* boolean apps[].visualizations[].dataElementConstraints[].//.isCompositional* boolean apps[].visualizations[].dataElementConstraints[].//.isProportion* boolean apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string apps[].visualizations[].dataElementConstraints[].//.minNumVars* number apps[].visualizations[].dataElementConstraints[].//.maxNumVars* number apps[].visualizations[].dataElementConstraints[].//.minNumValues* number apps[].visualizations[].dataElementConstraints[].//.maxNumValues* number apps[].visualizations[].dataElementConstraints[].//.allowedTypes array apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
apps[].visualizations[].dataElementConstraints[].//.allowedShapes array apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
apps[].visualizations[].dataElementConstraints[].//.description* string apps[].visualizations[].dataElementDependencyOrder array apps[].visualizations[].dataElementDependencyOrder[] array apps[].visualizations[].dataElementDependencyOrder[][] string
post /apps/standalone-map/visualizations/map-markers
Returns data required to make Standalone Map markers
curl -X POST \
@@ -1339,10 +1339,10 @@
undefined/apps/differentialabundance/visualizations/volcanoplot
Request Body chevron_right expand_more
DifferentialAbundanceVolcanoplotPostRequest DifferentialAbundanceVolcanoplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
computeConfig.comparator.variable* object Inherits: object
computeConfig.comparator.variable.entityId* string computeConfig.comparator.variable.variableId* string computeConfig.comparator.groupA* array computeConfig.comparator.groupA[] object Inherits: lib.Range
computeConfig.comparator.groupA[].min* string computeConfig.comparator.groupA[].max* string computeConfig.comparator.groupA[].label* string computeConfig.comparator.groupB* array computeConfig.comparator.groupB[] object Inherits: lib.Range
computeConfig.comparator.groupB[].min* string computeConfig.comparator.groupB[].max* string computeConfig.comparator.groupB[].label* string computeConfig.differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
computeConfig.pValueFloor string config* object Inherits: lib.EmptyDataPluginSpec
200 OK chevron_right expand_more
DifferentialAbundanceStatsResponse DifferentialAbundanceStatsResponse
application/json
Additional properties: Yes
Inherits: object
Parameter Type Description effectSizeLabel* string statistics* object Additional properties: Yes
Inherits: object
statistics.effectSize* array statistics.effectSize[] string statistics.pValue* array statistics.pValue[] string statistics.adjustedPValue* array statistics.adjustedPValue[] string statistics.pointId* array statistics.pointId[] string pvalueFloor string adjustedPValueFloor string
post /apps/correlationassayassay/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
- undefined/apps/correlationassayassay/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string significanceThreshold* number correlationCoefThreshold* number
post /apps/correlationassaymetadata/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
+ undefined/apps/correlationassayassay/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: lib.NodeIdList
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string significanceThreshold* number correlationCoefThreshold* number
post /apps/correlationassaymetadata/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
- undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string significanceThreshold* number correlationCoefThreshold* number
post /apps/distributions/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
+ undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: lib.NodeIdList
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string significanceThreshold* number correlationCoefThreshold* number
post /apps/distributions/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/distributions/visualizations/histogram
Request Body chevron_right expand_more
HistogramPostRequest HistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HistogramSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
200 OK chevron_right expand_more
HistogramPostResponse HistogramPostResponse
application/json
Inherits: object
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: lib.HistogramData
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.config* object Inherits: lib.PlotConfig
histogram.config.completeCasesAllVars* number histogram.config.completeCasesAxesVars* number histogram.config.variables* array histogram.config.variables[] object Inherits: object
histogram.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.config.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.config.variables[].variableSpec.entityId* string histogram.config.variables[].variableSpec.variableId* string histogram.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.config.variables[].displayName string histogram.config.variables[].displayRangeMin any histogram.config.variables[].displayRangeMax any histogram.config.variables[].vocabulary array histogram.config.variables[].vocabulary[] string histogram.config.variables[].imputeZero* boolean histogram.config.variables[].hasStudyDependentVocabulary boolean histogram.config.variables[].isCollection* boolean histogram.config.variables[].members array histogram.config.variables[].members[] object Inherits: lib.VariableSpec
histogram.config.variables[].members[].entityId* string histogram.config.variables[].members[].variableId* string histogram.config.binSlider* object Inherits: lib.BinSlider
histogram.config.binSlider.min* number histogram.config.binSlider.max* number histogram.config.binSlider.step* number histogram.config.binSpec* object Inherits: lib.BinSpec
histogram.config.binSpec.type string Enum:- binWidth
- numBins
histogram.config.binSpec.value number histogram.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
histogram.config.binSpec.range union histogram.config.binSpec.range anyOf Any of the following types. histogram.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
histogram.config.binSpec.range{NumberRange}..min* number histogram.config.binSpec.range{NumberRange}..max* number histogram.config.binSpec.range{DateRange} object Inherits: lib.DateRange
histogram.config.binSpec.range{DateRange}..min* string histogram.config.binSpec.range{DateRange}..max* string histogram.config.summary* object Additional properties: Yes
Inherits: object
histogram.config.summary.min* string histogram.config.summary.q1* string histogram.config.summary.median* string histogram.config.summary.mean* string histogram.config.summary.q3* string histogram.config.summary.max* string histogram.config.viewport* object Inherits: lib.NumericViewport
histogram.config.viewport.xMin* string histogram.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
post /apps/distributions/visualizations/boxplot
Returns data required to create a boxplot visualization
Java impl- NA
R impl- working
curl -X POST \
@@ -1387,7 +1387,7 @@
}
get /metrics
Prometheus metrics for the service.
curl -X GET \
undefined/metrics200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Security Scheme header-auth
header-auth
Authentication based on a WDK auth cookie.
Headers chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Auth_Key* | string | Authorization header. |
curl -X <method> \
-H "Auth_Key: <value>" \
- /<path>Types
Type VariableClass (string)
VariableClass
Enum:
- native
- derived
- computed
Inherits: string
Type PlotReferenceValue (string)
PlotReferenceValue
Enum:
- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
Type VariableMapping (object)
VariableMapping
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableClass* | string | Enum:
Inherits: string |
| variableSpec* | object | Inherits: lib.VariableSpec |
| variableSpec.entityId* | string | |
| variableSpec.variableId* | string | |
| plotReference* | string | Enum:
Inherits: string |
| dataType* | string | Enum:
Inherits: lib.API_VariableType |
| dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| displayName | string | |
| displayRangeMin | any | |
| displayRangeMax | any | |
| vocabulary | array | |
| vocabulary[] | string | |
| imputeZero* | boolean | |
| hasStudyDependentVocabulary | boolean | |
| isCollection* | boolean | |
| members | array | |
| members[] | object | Inherits: lib.VariableSpec |
| members[].entityId* | string | |
| members[].variableId* | string |
Type API_Filter (object)
API_Filter
Additional properties: Yes
Discriminator: type
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
Type API_FilterType (string)
API_FilterType
Enum:
- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: string
Type API_BooleanOperationType (string)
API_BooleanOperationType
Enum:
- intersect
- union
Inherits: string
Type API_MultiFilterSubFilter (object)
API_MultiFilterSubFilter
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_MultiFilter (object)
API_MultiFilter
Additional properties: Yes
Discriminator: type
Discriminator value: multiFilter
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| operation* | string | Enum:
Inherits: string |
| variableId* | string | |
| subFilters* | array | |
| subFilters[] | object | Additional properties: Yes Inherits: object |
| subFilters[].variableId* | string | |
| subFilters[].stringSet* | array | |
| subFilters[].stringSet[] | string |
Type API_StringSetFilter (object)
API_StringSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_NumberSetFilter (object)
API_NumberSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| numberSet* | array | |
| numberSet[] | number |
Type API_DateSetFilter (object)
API_DateSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| dateSet* | array | |
| dateSet[] | string |
Type API_NumberRangeFilter (object)
API_NumberRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: numberRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | number | |
| max* | number |
Type API_DateRangeFilter (object)
API_DateRangeFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | string | |
| max* | string |
Type API_LongitudeRangeFilter (object)
API_LongitudeRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: longitudeRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| left* | number | |
| right* | number |
Type DerivedVariableSpec (object)
DerivedVariableSpec
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| functionName* | string | |
| displayName* | string | |
| config* | object |
Type VariableSpec (object)
VariableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string |
Type CollectionSpec (object)
CollectionSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| collectionId* | string |
Type DataElementConstraint (object)
DataElementConstraint
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| isRequired* | boolean | |
| isTemporal* | boolean | |
| isCollection* | boolean | |
| isCompositional* | boolean | |
| isProportion* | boolean | |
| allowedNormalizationMethods* | array | |
| allowedNormalizationMethods[] | string | |
| minNumVars* | number | |
| maxNumVars* | number | |
| minNumValues* | number | |
| maxNumValues* | number | |
| allowedTypes | array | |
| allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| allowedShapes | array | |
| allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| description* | string |
Type DataElementConstraintPattern (object)
DataElementConstraintPattern
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| //* | object | Inherits: object |
| //.isRequired* | boolean | |
| //.isTemporal* | boolean | |
| //.isCollection* | boolean | |
| //.isCompositional* | boolean | |
| //.isProportion* | boolean | |
| //.allowedNormalizationMethods* | array | |
| //.allowedNormalizationMethods[] | string | |
| //.minNumVars* | number | |
| //.maxNumVars* | number | |
| //.minNumValues* | number | |
| //.maxNumValues* | number | |
| //.allowedTypes | array | |
| //.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| //.allowedShapes | array | |
| //.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| //.description* | string |
Type EntityTabularPostResponse (object)
EntityTabularPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| tabular* | array | |
| tabular[] | array | |
| tabular[][] | string |
Type Range (object)
Range
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string |
Type LabeledRange (object)
LabeledRange
Inherits: lib.Range
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string | |
| label* | string |
Type API_VariableType (string)
API_VariableType
Enum:
- category
- string
- number
- date
- longitude
- integer
Inherits: string
Type API_VariableDataShape (string)
API_VariableDataShape
Enum:
- continuous
- categorical
- ordinal
- binary
Inherits: string
Type API_PagingConfig (object)
API_PagingConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numRows | integer | Format: int64 |
| offset | integer | Format: int64 |
Type BinUnits (string)
BinUnits
Enum:
- day
- week
- month
- year
Inherits: string
Type ValueSpec (string)
ValueSpec
Enum:
- count
- proportion
Inherits: string
Type AlphaDivComputeConfig (object)
AlphaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
Type AlphaDivMethod (string)
AlphaDivMethod
Enum:
- shannon
- simpson
- evenness
Inherits: string
Type BetaDivComputeConfig (object)
BetaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
Type BetaDivDissimilarityMethod (string)
BetaDivDissimilarityMethod
Enum:
- bray
- jaccard
- jsd
Inherits: string
Type CorrelationComputeConfig (object)
CorrelationComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
Type CorrelationMethod (string)
CorrelationMethod
Enum:
- spearman
- pearson
Inherits: string
Type Correlation1Collection (object)
Correlation1Collection
Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string |
Type Correlation2Collections (object)
Correlation2Collections
Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| collectionVariable1* | object | Inherits: object |
| collectionVariable1.entityId* | string | |
| collectionVariable1.collectionId* | string | |
| collectionVariable2* | object | Inherits: object |
| collectionVariable2.entityId* | string | |
| collectionVariable2.collectionId* | string |
Type DifferentialAbundanceComputeConfig (object)
DifferentialAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| comparator.variable* | object | Inherits: object |
| comparator.variable.entityId* | string | |
| comparator.variable.variableId* | string | |
| comparator.groupA* | array | |
| comparator.groupA[] | object | Inherits: lib.Range |
| comparator.groupA[].min* | string | |
| comparator.groupA[].max* | string | |
| comparator.groupA[].label* | string | |
| comparator.groupB* | array | |
| comparator.groupB[] | object | Inherits: lib.Range |
| comparator.groupB[].min* | string | |
| comparator.groupB[].max* | string | |
| comparator.groupB[].label* | string | |
| differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| pValueFloor | string |
Type DifferentialAbundanceMethod (string)
DifferentialAbundanceMethod
Enum:
- DESeq
- ANCOMBC
- Maaslin
Inherits: string
Type ComparatorSpec (object)
ComparatorSpec
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| groupA* | array | |
| groupA[] | object | Inherits: lib.Range |
| groupA[].min* | string | |
| groupA[].max* | string | |
| groupA[].label* | string | |
| groupB* | array | |
| groupB[] | object | Inherits: lib.Range |
| groupB[].min* | string | |
| groupB[].max* | string | |
| groupB[].label* | string |
Type DifferentialAbundanceStats (object)
DifferentialAbundanceStats
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| effectSize* | array | |
| effectSize[] | string | |
| pValue* | array | |
| pValue[] | string | |
| adjustedPValue* | array | |
| adjustedPValue[] | string | |
| pointId* | array | |
| pointId[] | string |
Type DifferentialAbundanceStatsResponse (object)
DifferentialAbundanceStatsResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| effectSizeLabel* | string | |
| statistics* | object | Additional properties: Yes Inherits: object |
| statistics.effectSize* | array | |
| statistics.effectSize[] | string | |
| statistics.pValue* | array | |
| statistics.pValue[] | string | |
| statistics.adjustedPValue* | array | |
| statistics.adjustedPValue[] | string | |
| statistics.pointId* | array | |
| statistics.pointId[] | string | |
| pvalueFloor | string | |
| adjustedPValueFloor | string |
Type ExampleComputeConfig (object)
ExampleComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| inputVariable* | object | Inherits: object |
| inputVariable.entityId* | string | |
| inputVariable.variableId* | string | |
| valueSuffix* | string |
Type RankedAbundanceComputeConfig (object)
RankedAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
Type RankingMethod (string)
RankingMethod
Enum:
- median
- q3
- variance
- max
Inherits: string
Type AbundanceBoxplotPostRequest (object)
AbundanceBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AbundanceScatterplotPostRequest (object)
AbundanceScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivBoxplotPostRequest (object)
AlphaDivBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivScatterplotPostRequest (object)
AlphaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AppsGetResponse (object)
AppsGetResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| apps* | array | |
| apps[] | object | Inherits: lib.AppOverview |
| apps[].name* | string | |
| apps[].displayName* | string | |
| apps[].description* | string | |
| apps[].projects* | array | |
| apps[].projects[] | string | |
| apps[].computeName | string | |
| apps[].visualizations* | array | |
| apps[].visualizations[] | object | Inherits: lib.VisualizationOverview |
| apps[].visualizations[].name* | string | |
| apps[].visualizations[].displayName* | string | |
| apps[].visualizations[].description* | string | |
| apps[].visualizations[].projects* | array | |
| apps[].visualizations[].projects[] | string | |
| apps[].visualizations[].maxPanels* | number | |
| apps[].visualizations[].dataElementConstraints | array | |
| apps[].visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isCollection* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isCompositional* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isProportion* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| apps[].visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| apps[].visualizations[].dataElementConstraints[].//.description* | string | |
| apps[].visualizations[].dataElementDependencyOrder | array | |
| apps[].visualizations[].dataElementDependencyOrder[] | array | |
| apps[].visualizations[].dataElementDependencyOrder[][] | string |
Type AppOverview (object)
AppOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| computeName | string | |
| visualizations* | array | |
| visualizations[] | object | Inherits: lib.VisualizationOverview |
| visualizations[].name* | string | |
| visualizations[].displayName* | string | |
| visualizations[].description* | string | |
| visualizations[].projects* | array | |
| visualizations[].projects[] | string | |
| visualizations[].maxPanels* | number | |
| visualizations[].dataElementConstraints | array | |
| visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| visualizations[].dataElementConstraints[].//.isCollection* | boolean | |
| visualizations[].dataElementConstraints[].//.isCompositional* | boolean | |
| visualizations[].dataElementConstraints[].//.isProportion* | boolean | |
| visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| visualizations[].dataElementConstraints[].//.description* | string | |
| visualizations[].dataElementDependencyOrder | array | |
| visualizations[].dataElementDependencyOrder[] | array | |
| visualizations[].dataElementDependencyOrder[][] | string |
Type VisualizationOverview (object)
VisualizationOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| maxPanels* | number | |
| dataElementConstraints | array | |
| dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| dataElementConstraints[].//* | object | Inherits: object |
| dataElementConstraints[].//.isRequired* | boolean | |
| dataElementConstraints[].//.isTemporal* | boolean | |
| dataElementConstraints[].//.isCollection* | boolean | |
| dataElementConstraints[].//.isCompositional* | boolean | |
| dataElementConstraints[].//.isProportion* | boolean | |
| dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| dataElementConstraints[].//.minNumVars* | number | |
| dataElementConstraints[].//.maxNumVars* | number | |
| dataElementConstraints[].//.minNumValues* | number | |
| dataElementConstraints[].//.maxNumValues* | number | |
| dataElementConstraints[].//.allowedTypes | array | |
| dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| dataElementConstraints[].//.allowedShapes | array | |
| dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| dataElementConstraints[].//.description* | string | |
| dataElementDependencyOrder | array | |
| dataElementDependencyOrder[] | array | |
| dataElementDependencyOrder[][] | string |
Type BetaDivScatterplotPostRequest (object)
BetaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
| config* | object | Inherits: lib.BetaDivScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string |
Type BetaDivScatterplotSpec (object)
BetaDivScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type CorrelationBipartitenetworkSpec (object)
CorrelationBipartitenetworkSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| significanceThreshold | number | |
| correlationCoefThreshold | number |
Type CorrelationBipartiteNetworkPostResponse (object)
CorrelationBipartiteNetworkPostResponse
Inherits: lib.BipartiteNetworkPostResponse
Model
| Parameter | Type | Description |
|---|---|---|
| bipartitenetwork* | object | Inherits: lib.BipartiteNetwork |
| bipartitenetwork.data* | object | Additional properties: Yes Inherits: lib.BipartiteNetworkData |
| bipartitenetwork.data.nodes* | array | |
| bipartitenetwork.data.nodes[] | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.nodes[].id* | string | |
| bipartitenetwork.data.links* | array | |
| bipartitenetwork.data.links[] | object | Additional properties: Yes Inherits: lib.LinkData |
| bipartitenetwork.data.links[].source* | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.links[].source.id* | string | |
| bipartitenetwork.data.links[].target* | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.links[].target.id* | string | |
| bipartitenetwork.data.links[].strokeWidth* | string | |
| bipartitenetwork.data.links[].color* | string | |
| bipartitenetwork.data.column1NodeIDs* | array | |
| bipartitenetwork.data.column1NodeIDs[] | string | |
| bipartitenetwork.data.column2NodeIDs* | array | |
| bipartitenetwork.data.column2NodeIDs[] | string | |
| bipartitenetwork.config* | object | Additional properties: Yes Inherits: lib.BipartiteNetworkConfig |
| bipartitenetwork.config.variables | array | |
| bipartitenetwork.config.variables[] | object | Inherits: object |
| bipartitenetwork.config.variables[].variableClass* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].variableSpec.entityId* | string | |
| bipartitenetwork.config.variables[].variableSpec.variableId* | string | |
| bipartitenetwork.config.variables[].plotReference* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| bipartitenetwork.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| bipartitenetwork.config.variables[].displayName | string | |
| bipartitenetwork.config.variables[].displayRangeMin | any | |
| bipartitenetwork.config.variables[].displayRangeMax | any | |
| bipartitenetwork.config.variables[].vocabulary | array | |
| bipartitenetwork.config.variables[].vocabulary[] | string | |
| bipartitenetwork.config.variables[].imputeZero* | boolean | |
| bipartitenetwork.config.variables[].hasStudyDependentVocabulary | boolean | |
| bipartitenetwork.config.variables[].isCollection* | boolean | |
| bipartitenetwork.config.variables[].members | array | |
| bipartitenetwork.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].members[].entityId* | string | |
| bipartitenetwork.config.variables[].members[].variableId* | string | |
| bipartitenetwork.config.column1Metadata* | string | |
| bipartitenetwork.config.column2Metadata* | string | |
| significanceThreshold* | number | |
| correlationCoefThreshold* | number |
Type CorrelationAssayAssayBipartitenetworkPostRequest (object)
CorrelationAssayAssayBipartitenetworkPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: lib.CorrelationComputeConfig |
| computeConfig.correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| computeConfig.collectionVariable1* | object | Inherits: object |
| computeConfig.collectionVariable1.entityId* | string | |
| computeConfig.collectionVariable1.collectionId* | string | |
| computeConfig.collectionVariable2* | object | Inherits: object |
| computeConfig.collectionVariable2.entityId* | string | |
| computeConfig.collectionVariable2.collectionId* | string | |
| config* | object | Inherits: object |
| config.significanceThreshold | number | |
| config.correlationCoefThreshold | number |
Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)
CorrelationAssayMetadataBipartitenetworkPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: lib.CorrelationComputeConfig |
| computeConfig.correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| config* | object | Inherits: object |
| config.significanceThreshold | number | |
| config.correlationCoefThreshold | number |
Type DifferentialAbundanceVolcanoplotPostRequest (object)
DifferentialAbundanceVolcanoplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| computeConfig.comparator.variable* | object | Inherits: object |
| computeConfig.comparator.variable.entityId* | string | |
| computeConfig.comparator.variable.variableId* | string | |
| computeConfig.comparator.groupA* | array | |
| computeConfig.comparator.groupA[] | object | Inherits: lib.Range |
| computeConfig.comparator.groupA[].min* | string | |
| computeConfig.comparator.groupA[].max* | string | |
| computeConfig.comparator.groupA[].label* | string | |
| computeConfig.comparator.groupB* | array | |
| computeConfig.comparator.groupB[] | object | Inherits: lib.Range |
| computeConfig.comparator.groupB[].min* | string | |
| computeConfig.comparator.groupB[].max* | string | |
| computeConfig.comparator.groupB[].label* | string | |
| computeConfig.differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| computeConfig.pValueFloor | string | |
| config* | object | Inherits: lib.EmptyDataPluginSpec |
Type ContinuousVariableMetadataPostRequest (object)
ContinuousVariableMetadataPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ContinuousVariableMetadataSpec |
| config.variable* | object | Inherits: object |
| config.variable.entityId* | string | |
| config.variable.variableId* | string | |
| config.metadata* | array | |
| config.metadata[] | string | Enum:
|
Type ContinuousVariableMetadataSpec (object)
ContinuousVariableMetadataSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| metadata* | array | |
| metadata[] | string | Enum:
|
Type AllBinRanges (object)
AllBinRanges
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| equalInterval* | array | |
| equalInterval[] | object | Inherits: lib.Range |
| equalInterval[].min* | string | |
| equalInterval[].max* | string | |
| equalInterval[].label* | string | |
| quantile* | array | |
| quantile[] | object | Inherits: lib.Range |
| quantile[].min* | string | |
| quantile[].max* | string | |
| quantile[].label* | string | |
| standardDeviation* | array | |
| standardDeviation[] | object | Inherits: lib.Range |
| standardDeviation[].min* | string | |
| standardDeviation[].max* | string | |
| standardDeviation[].label* | string |
Type ContinuousVariableMetadataPostResponse (object)
ContinuousVariableMetadataPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binRanges | object | Inherits: object |
| binRanges.equalInterval* | array | |
| binRanges.equalInterval[] | object | Inherits: lib.Range |
| binRanges.equalInterval[].min* | string | |
| binRanges.equalInterval[].max* | string | |
| binRanges.equalInterval[].label* | string | |
| binRanges.quantile* | array | |
| binRanges.quantile[] | object | Inherits: lib.Range |
| binRanges.quantile[].min* | string | |
| binRanges.quantile[].max* | string | |
| binRanges.quantile[].label* | string | |
| binRanges.standardDeviation* | array | |
| binRanges.standardDeviation[] | object | Inherits: lib.Range |
| binRanges.standardDeviation[].min* | string | |
| binRanges.standardDeviation[].max* | string | |
| binRanges.standardDeviation[].label* | string | |
| median | number |
Type NodeData (object)
NodeData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| id* | string |
Type LinkData (object)
LinkData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| source* | object | Additional properties: Yes Inherits: object |
| source.id* | string | |
| target* | object | Additional properties: Yes Inherits: object |
| target.id* | string | |
| strokeWidth* | string | |
| color* | string |
Type NetworkData (object)
NetworkData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| nodes* | array | |
| nodes[] | object | Additional properties: Yes Inherits: object |
| nodes[].id* | string | |
| links* | array | |
| links[] | object | Additional properties: Yes Inherits: object |
| links[].source* | object | Additional properties: Yes Inherits: object |
| links[].source.id* | string | |
| links[].target* | object | Additional properties: Yes Inherits: object |
| links[].target.id* | string | |
| links[].strokeWidth* | string | |
| links[].color* | string |
Type NetworkConfig (object)
NetworkConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variables | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type BipartiteNetworkConfig (object)
BipartiteNetworkConfig
Additional properties: Yes
Inherits: lib.NetworkConfig
Model
| Parameter | Type | Description |
|---|---|---|
| variables | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| column1Metadata* | string | |
| column2Metadata* | string |
Type BipartiteNetworkData (object)
BipartiteNetworkData
Additional properties: Yes
Inherits: lib.NetworkData
Model
| Parameter | Type | Description |
|---|---|---|
| nodes* | array | |
| nodes[] | object | Additional properties: Yes Inherits: object |
| nodes[].id* | string | |
| links* | array | |
| links[] | object | Additional properties: Yes Inherits: object |
| links[].source* | object | Additional properties: Yes Inherits: object |
| links[].source.id* | string | |
| links[].target* | object | Additional properties: Yes Inherits: object |
| links[].target.id* | string | |
| links[].strokeWidth* | string | |
| links[].color* | string | |
| column1NodeIDs* | array | |
| column1NodeIDs[] | string | |
| column2NodeIDs* | array | |
| column2NodeIDs[] | string |
Type BipartiteNetwork (object)
BipartiteNetwork
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | object | Additional properties: Yes Inherits: lib.NetworkData |
| data.nodes* | array | |
| data.nodes[] | object | Additional properties: Yes Inherits: object |
| data.nodes[].id* | string | |
| data.links* | array | |
| data.links[] | object | Additional properties: Yes Inherits: object |
| data.links[].source* | object | Additional properties: Yes Inherits: object |
| data.links[].source.id* | string | |
| data.links[].target* | object | Additional properties: Yes Inherits: object |
| data.links[].target.id* | string | |
| data.links[].strokeWidth* | string | |
| data.links[].color* | string | |
| data.column1NodeIDs* | array | |
| data.column1NodeIDs[] | string | |
| data.column2NodeIDs* | array | |
| data.column2NodeIDs[] | string | |
| config* | object | Additional properties: Yes Inherits: lib.NetworkConfig |
| config.variables | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.column1Metadata* | string | |
| config.column2Metadata* | string |
Type BipartiteNetworkPostResponse (object)
BipartiteNetworkPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| bipartitenetwork* | object | Inherits: object |
| bipartitenetwork.data* | object | Additional properties: Yes Inherits: lib.NetworkData |
| bipartitenetwork.data.nodes* | array | |
| bipartitenetwork.data.nodes[] | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.nodes[].id* | string | |
| bipartitenetwork.data.links* | array | |
| bipartitenetwork.data.links[] | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].source* | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].source.id* | string | |
| bipartitenetwork.data.links[].target* | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].target.id* | string | |
| bipartitenetwork.data.links[].strokeWidth* | string | |
| bipartitenetwork.data.links[].color* | string | |
| bipartitenetwork.data.column1NodeIDs* | array | |
| bipartitenetwork.data.column1NodeIDs[] | string | |
| bipartitenetwork.data.column2NodeIDs* | array | |
| bipartitenetwork.data.column2NodeIDs[] | string | |
| bipartitenetwork.config* | object | Additional properties: Yes Inherits: lib.NetworkConfig |
| bipartitenetwork.config.variables | array | |
| bipartitenetwork.config.variables[] | object | Inherits: object |
| bipartitenetwork.config.variables[].variableClass* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].variableSpec.entityId* | string | |
| bipartitenetwork.config.variables[].variableSpec.variableId* | string | |
| bipartitenetwork.config.variables[].plotReference* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| bipartitenetwork.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| bipartitenetwork.config.variables[].displayName | string | |
| bipartitenetwork.config.variables[].displayRangeMin | any | |
| bipartitenetwork.config.variables[].displayRangeMax | any | |
| bipartitenetwork.config.variables[].vocabulary | array | |
| bipartitenetwork.config.variables[].vocabulary[] | string | |
| bipartitenetwork.config.variables[].imputeZero* | boolean | |
| bipartitenetwork.config.variables[].hasStudyDependentVocabulary | boolean | |
| bipartitenetwork.config.variables[].isCollection* | boolean | |
| bipartitenetwork.config.variables[].members | array | |
| bipartitenetwork.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].members[].entityId* | string | |
| bipartitenetwork.config.variables[].members[].variableId* | string | |
| bipartitenetwork.config.column1Metadata* | string | |
| bipartitenetwork.config.column2Metadata* | string |
Type BarplotPostRequest (object)
BarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BarplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type BarplotSpec (object)
BarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Barplot (object)
Barplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BarplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BarplotPostResponse (object)
BarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: lib.BarplotData |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.config* | object | Inherits: lib.PlotConfig |
| barplot.config.completeCasesAllVars* | number | |
| barplot.config.completeCasesAxesVars* | number | |
| barplot.config.variables* | array | |
| barplot.config.variables[] | object | Inherits: object |
| barplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| barplot.config.variables[].variableSpec.entityId* | string | |
| barplot.config.variables[].variableSpec.variableId* | string | |
| barplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| barplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| barplot.config.variables[].displayName | string | |
| barplot.config.variables[].displayRangeMin | any | |
| barplot.config.variables[].displayRangeMax | any | |
| barplot.config.variables[].vocabulary | array | |
| barplot.config.variables[].vocabulary[] | string | |
| barplot.config.variables[].imputeZero* | boolean | |
| barplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| barplot.config.variables[].isCollection* | boolean | |
| barplot.config.variables[].members | array | |
| barplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| barplot.config.variables[].members[].entityId* | string | |
| barplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BoxplotPostRequest (object)
BoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BoxplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type BoxplotSpec (object)
BoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: lib.StringBoolean |
| computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Boxplot (object)
Boxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BoxplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BoxplotPostResponse (object)
BoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
Type ContTableStatsTable (object)
ContTableStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| pvalue* | array | |
| pvalue[] | number | |
| degreesFreedom* | array | |
| degreesFreedom[] | number | |
| chisq* | array | |
| chisq[] | number |
Type ContTablePostResponse (object)
ContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].pvalue* | array | |
| statsTable[].pvalue[] | number | |
| statsTable[].degreesFreedom* | array | |
| statsTable[].degreesFreedom[] | number | |
| statsTable[].chisq* | array | |
| statsTable[].chisq[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type DensityplotPostRequest (object)
DensityplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.DensityplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type DensityplotSpec (object)
DensityplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Densityplot (object)
Densityplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.DensityplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].densityY* | array | |
| data[].densityY[] | number | |
| data[].densityX* | array | |
| data[].densityX[] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type DensityplotPostResponse (object)
DensityplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| densityplot* | object | Inherits: object |
| densityplot.data* | array | |
| densityplot.data[] | object | Inherits: lib.DensityplotData |
| densityplot.data[].overlayVariableDetails | object | Inherits: object |
| densityplot.data[].overlayVariableDetails.entityId* | string | |
| densityplot.data[].overlayVariableDetails.variableId* | string | |
| densityplot.data[].overlayVariableDetails.value* | string | |
| densityplot.data[].facetVariableDetails | array | Max. items: 2 |
| densityplot.data[].facetVariableDetails[] | object | Inherits: object |
| densityplot.data[].facetVariableDetails[].entityId* | string | |
| densityplot.data[].facetVariableDetails[].variableId* | string | |
| densityplot.data[].facetVariableDetails[].value* | string | |
| densityplot.data[].densityY* | array | |
| densityplot.data[].densityY[] | number | |
| densityplot.data[].densityX* | array | |
| densityplot.data[].densityX[] | number | |
| densityplot.config* | object | Inherits: lib.PlotConfig |
| densityplot.config.completeCasesAllVars* | number | |
| densityplot.config.completeCasesAxesVars* | number | |
| densityplot.config.variables* | array | |
| densityplot.config.variables[] | object | Inherits: object |
| densityplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| densityplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| densityplot.config.variables[].variableSpec.entityId* | string | |
| densityplot.config.variables[].variableSpec.variableId* | string | |
| densityplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| densityplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| densityplot.config.variables[].displayName | string | |
| densityplot.config.variables[].displayRangeMin | any | |
| densityplot.config.variables[].displayRangeMax | any | |
| densityplot.config.variables[].vocabulary | array | |
| densityplot.config.variables[].vocabulary[] | string | |
| densityplot.config.variables[].imputeZero* | boolean | |
| densityplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| densityplot.config.variables[].isCollection* | boolean | |
| densityplot.config.variables[].members | array | |
| densityplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| densityplot.config.variables[].members[].entityId* | string | |
| densityplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HeatmapPostRequest (object)
HeatmapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HeatmapSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.zAxisVariable | object | Inherits: object |
| config.zAxisVariable.entityId* | string | |
| config.zAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type HeatmapSpec (object)
HeatmapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| zAxisVariable | object | Inherits: object |
| zAxisVariable.entityId* | string | |
| zAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Heatmap (object)
Heatmap
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HeatmapData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type HeatmapPostResponse (object)
HeatmapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| heatmap* | object | Inherits: object |
| heatmap.data* | array | |
| heatmap.data[] | object | Inherits: lib.HeatmapData |
| heatmap.data[].facetVariableDetails | array | Max. items: 2 |
| heatmap.data[].facetVariableDetails[] | object | Inherits: object |
| heatmap.data[].facetVariableDetails[].entityId* | string | |
| heatmap.data[].facetVariableDetails[].variableId* | string | |
| heatmap.data[].facetVariableDetails[].value* | string | |
| heatmap.data[].value* | array | |
| heatmap.data[].value[] | array | |
| heatmap.data[].value[][] | number | |
| heatmap.data[].label* | array | |
| heatmap.data[].label[] | string | |
| heatmap.config* | object | Inherits: lib.PlotConfig |
| heatmap.config.completeCasesAllVars* | number | |
| heatmap.config.completeCasesAxesVars* | number | |
| heatmap.config.variables* | array | |
| heatmap.config.variables[] | object | Inherits: object |
| heatmap.config.variables[].variableClass* | string | Enum:
Inherits: string |
| heatmap.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| heatmap.config.variables[].variableSpec.entityId* | string | |
| heatmap.config.variables[].variableSpec.variableId* | string | |
| heatmap.config.variables[].plotReference* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| heatmap.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| heatmap.config.variables[].displayName | string | |
| heatmap.config.variables[].displayRangeMin | any | |
| heatmap.config.variables[].displayRangeMax | any | |
| heatmap.config.variables[].vocabulary | array | |
| heatmap.config.variables[].vocabulary[] | string | |
| heatmap.config.variables[].imputeZero* | boolean | |
| heatmap.config.variables[].hasStudyDependentVocabulary | boolean | |
| heatmap.config.variables[].isCollection* | boolean | |
| heatmap.config.variables[].members | array | |
| heatmap.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| heatmap.config.variables[].members[].entityId* | string | |
| heatmap.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HistogramPostRequest (object)
HistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HistogramSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramSpec (object)
HistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type HistogramSummary (object)
HistogramSummary
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| q1* | string | |
| median* | string | |
| mean* | string | |
| q3* | string | |
| max* | string |
Type HistogramConfig (object)
HistogramConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider* | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| summary* | object | Additional properties: Yes Inherits: object |
| summary.min* | string | |
| summary.q1* | string | |
| summary.median* | string | |
| summary.mean* | string | |
| summary.q3* | string | |
| summary.max* | string | |
| viewport* | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Histogram (object)
Histogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HistogramData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider* | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.summary* | object | Additional properties: Yes Inherits: object |
| config.summary.min* | string | |
| config.summary.q1* | string | |
| config.summary.median* | string | |
| config.summary.mean* | string | |
| config.summary.q3* | string | |
| config.summary.max* | string | |
| config.viewport* | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramPostResponse (object)
HistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: lib.HistogramData |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.config* | object | Inherits: lib.PlotConfig |
| histogram.config.completeCasesAllVars* | number | |
| histogram.config.completeCasesAxesVars* | number | |
| histogram.config.variables* | array | |
| histogram.config.variables[] | object | Inherits: object |
| histogram.config.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| histogram.config.variables[].variableSpec.entityId* | string | |
| histogram.config.variables[].variableSpec.variableId* | string | |
| histogram.config.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| histogram.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| histogram.config.variables[].displayName | string | |
| histogram.config.variables[].displayRangeMin | any | |
| histogram.config.variables[].displayRangeMax | any | |
| histogram.config.variables[].vocabulary | array | |
| histogram.config.variables[].vocabulary[] | string | |
| histogram.config.variables[].imputeZero* | boolean | |
| histogram.config.variables[].hasStudyDependentVocabulary | boolean | |
| histogram.config.variables[].isCollection* | boolean | |
| histogram.config.variables[].members | array | |
| histogram.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| histogram.config.variables[].members[].entityId* | string | |
| histogram.config.variables[].members[].variableId* | string | |
| histogram.config.binSlider* | object | Inherits: lib.BinSlider |
| histogram.config.binSlider.min* | number | |
| histogram.config.binSlider.max* | number | |
| histogram.config.binSlider.step* | number | |
| histogram.config.binSpec* | object | Inherits: lib.BinSpec |
| histogram.config.binSpec.type | string | Enum:
|
| histogram.config.binSpec.value | number | |
| histogram.config.binSpec.units | string | Enum:
Inherits: string |
| histogram.config.binSpec.range | union | |
| histogram.config.binSpec.range | anyOf | Any of the following types. |
| histogram.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| histogram.config.binSpec.range{NumberRange}..min* | number | |
| histogram.config.binSpec.range{NumberRange}..max* | number | |
| histogram.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| histogram.config.binSpec.range{DateRange}..min* | string | |
| histogram.config.binSpec.range{DateRange}..max* | string | |
| histogram.config.summary* | object | Additional properties: Yes Inherits: object |
| histogram.config.summary.min* | string | |
| histogram.config.summary.q1* | string | |
| histogram.config.summary.median* | string | |
| histogram.config.summary.mean* | string | |
| histogram.config.summary.q3* | string | |
| histogram.config.summary.max* | string | |
| histogram.config.viewport* | object | Inherits: lib.NumericViewport |
| histogram.config.viewport.xMin* | string | |
| histogram.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type LineplotPostRequest (object)
LineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotSpec (object)
LineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type LineplotConfig (object)
LineplotConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Lineplot (object)
Lineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.LineplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotPostResponse (object)
LineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapMarkersOverlayPostRequest (object)
MapMarkersOverlayPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapMarkersOverlaySpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.longitudeVariable | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlaySpec (object)
MapMarkersOverlaySpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| longitudeVariable | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlayConfig (object)
MapMarkersOverlayConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlay (object)
MapMarkersOverlay
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.MapMarkersOverlayData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlayPostResponse (object)
MapMarkersOverlayPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapMarkers* | object | Inherits: object |
| mapMarkers.data* | array | |
| mapMarkers.data[] | object | Inherits: lib.MapMarkersOverlayData |
| mapMarkers.data[].facetVariableDetails | array | Max. items: 2 |
| mapMarkers.data[].facetVariableDetails[] | object | Inherits: object |
| mapMarkers.data[].facetVariableDetails[].entityId* | string | |
| mapMarkers.data[].facetVariableDetails[].variableId* | string | |
| mapMarkers.data[].facetVariableDetails[].value* | string | |
| mapMarkers.data[].value* | array | |
| mapMarkers.data[].value[] | number | |
| mapMarkers.data[].label* | array | |
| mapMarkers.data[].label[] | string | |
| mapMarkers.config* | object | Inherits: lib.PlotConfig |
| mapMarkers.config.completeCasesAllVars* | number | |
| mapMarkers.config.completeCasesAxesVars* | number | |
| mapMarkers.config.variables* | array | |
| mapMarkers.config.variables[] | object | Inherits: object |
| mapMarkers.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mapMarkers.config.variables[].variableSpec.entityId* | string | |
| mapMarkers.config.variables[].variableSpec.variableId* | string | |
| mapMarkers.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mapMarkers.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mapMarkers.config.variables[].displayName | string | |
| mapMarkers.config.variables[].displayRangeMin | any | |
| mapMarkers.config.variables[].displayRangeMax | any | |
| mapMarkers.config.variables[].vocabulary | array | |
| mapMarkers.config.variables[].vocabulary[] | string | |
| mapMarkers.config.variables[].imputeZero* | boolean | |
| mapMarkers.config.variables[].hasStudyDependentVocabulary | boolean | |
| mapMarkers.config.variables[].isCollection* | boolean | |
| mapMarkers.config.variables[].members | array | |
| mapMarkers.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mapMarkers.config.variables[].members[].entityId* | string | |
| mapMarkers.config.variables[].members[].variableId* | string | |
| mapMarkers.config.viewport* | object | Inherits: lib.GeolocationViewport |
| mapMarkers.config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| mapMarkers.config.viewport.latitude.xMin* | string | |
| mapMarkers.config.viewport.latitude.xMax* | string | |
| mapMarkers.config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| mapMarkers.config.viewport.longitude.left* | number | |
| mapMarkers.config.viewport.longitude.right* | number | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapPostRequest (object)
MapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapSpec (object)
MapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapConfig (object)
MapConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesGeoVar* | number |
Type MapPostResponse (object)
MapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.MapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number | |
| config* | object | Inherits: object |
| config.completeCasesGeoVar* | number |
Type MapElementInfo (object)
MapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type ScatterplotPostRequest (object)
ScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type ScatterplotSpec (object)
ScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Scatterplot (object)
Scatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.ScatterplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotPostResponse (object)
ScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type TablePostRequest (object)
TablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.TableSpec |
| config.outputEntityId* | string | |
| config.outputVariable* | array | |
| config.outputVariable[] | object | Inherits: object |
| config.outputVariable[].entityId* | string | |
| config.outputVariable[].variableId* | string | |
| config.pagingConfig* | object | Additional properties: Yes Inherits: object |
| config.pagingConfig.numRows | integer | Format: int64 |
| config.pagingConfig.offset | integer | Format: int64 |
Type TableSpec (object)
TableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| outputVariable* | array | |
| outputVariable[] | object | Inherits: object |
| outputVariable[].entityId* | string | |
| outputVariable[].variableId* | string | |
| pagingConfig* | object | Additional properties: Yes Inherits: object |
| pagingConfig.numRows | integer | Format: int64 |
| pagingConfig.offset | integer | Format: int64 |
Type TablePostResponse (object)
TablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| columns* | array | |
| columns[] | object | Inherits: object |
| columns[].entityId* | string | |
| columns[].variableId* | string | |
| rows* | array | |
| rows[] | array | |
| rows[][] | string |
Type TwoByTwoSpec (object)
TwoByTwoSpec
Inherits: lib.MosaicSpec
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| xAxisReferenceValue* | string | |
| yAxisReferenceValue* | string |
Type TwoByTwoPostRequest (object)
TwoByTwoPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.xAxisReferenceValue* | string | |
| config.yAxisReferenceValue* | string |
Type Statistic (object)
Statistic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| value* | number | |
| confidenceInterval | string | |
| confidenceLevel | number | |
| pvalue* | string |
Type TwoByTwoStatsTable (object)
TwoByTwoStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| chisq* | object | Inherits: object |
| chisq.value* | number | |
| chisq.confidenceInterval | string | |
| chisq.confidenceLevel | number | |
| chisq.pvalue* | string | |
| fisher* | object | Inherits: object |
| fisher.value* | number | |
| fisher.confidenceInterval | string | |
| fisher.confidenceLevel | number | |
| fisher.pvalue* | string | |
| prevalence | object | Inherits: object |
| prevalence.value* | number | |
| prevalence.confidenceInterval | string | |
| prevalence.confidenceLevel | number | |
| prevalence.pvalue* | string | |
| oddsratio | object | Inherits: object |
| oddsratio.value* | number | |
| oddsratio.confidenceInterval | string | |
| oddsratio.confidenceLevel | number | |
| oddsratio.pvalue* | string | |
| relativerisk | object | Inherits: object |
| relativerisk.value* | number | |
| relativerisk.confidenceInterval | string | |
| relativerisk.confidenceLevel | number | |
| relativerisk.pvalue* | string | |
| sensitivity | object | Inherits: object |
| sensitivity.value* | number | |
| sensitivity.confidenceInterval | string | |
| sensitivity.confidenceLevel | number | |
| sensitivity.pvalue* | string | |
| specificity | object | Inherits: object |
| specificity.value* | number | |
| specificity.confidenceInterval | string | |
| specificity.confidenceLevel | number | |
| specificity.pvalue* | string | |
| posPredictiveValue | object | Inherits: object |
| posPredictiveValue.value* | number | |
| posPredictiveValue.confidenceInterval | string | |
| posPredictiveValue.confidenceLevel | number | |
| posPredictiveValue.pvalue* | string | |
| negPredictiveValue | object | Inherits: object |
| negPredictiveValue.value* | number | |
| negPredictiveValue.confidenceInterval | string | |
| negPredictiveValue.confidenceLevel | number | |
| negPredictiveValue.pvalue* | string |
Type TwoByTwoPostResponse (object)
TwoByTwoPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BarplotData (object)
BarplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type MapMarkersOverlayData (object)
MapMarkersOverlayData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotData (object)
BoxplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| lowerfence* | array | |
| lowerfence[] | number | |
| upperfence* | array | |
| upperfence[] | number | |
| q1* | array | |
| q1[] | number | |
| q3* | array | |
| q3[] | number | |
| median* | array | |
| median[] | number | |
| outliers | array | |
| outliers[] | array | |
| outliers[][] | number | |
| rawData | array | |
| rawData[] | array | |
| rawData[][] | number | |
| mean | array | |
| mean[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotStatsTable (object)
BoxplotStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xVariableDetails | object | Inherits: object |
| xVariableDetails.entityId* | string | |
| xVariableDetails.variableId* | string | |
| xVariableDetails.value* | string | |
| statistic* | string | |
| pvalue* | number | |
| parameter* | array | |
| parameter[] | number | |
| method* | string | |
| statsError* | string |
Type HistogramData (object)
HistogramData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| binStart* | array | |
| binStart[] | string | |
| binEnd* | array | |
| binEnd[] | string | |
| binLabel* | array | |
| binLabel[] | string |
Type BinSlider (object)
BinSlider
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number | |
| step* | number |
Type HeatmapData (object)
HeatmapData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | array | |
| value[][] | number | |
| label* | array | |
| label[] | string |
Type MosaicPostRequest (object)
MosaicPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type MosaicSpec (object)
MosaicSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type MosaicData (object)
MosaicData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xLabel* | array | |
| xLabel[] | string | |
| yLabel* | array | |
| yLabel[] | array | |
| yLabel[][] | string | |
| value* | array | |
| value[] | array | |
| value[][] | number |
Type Mosaic (object)
Mosaic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotData (object)
ScatterplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| smoothedMeanX | array | |
| smoothedMeanX[] | string | |
| smoothedMeanY | array | |
| smoothedMeanY[] | number | |
| smoothedMeanSE | array | |
| smoothedMeanSE[] | number | |
| smoothedMeanError | string | |
| bestFitLineX | array | |
| bestFitLineX[] | string | |
| bestFitLineY | array | |
| bestFitLineY[] | number | |
| r2 | number |
Type DensityplotData (object)
DensityplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| densityY* | array | |
| densityY[] | number | |
| densityX* | array | |
| densityX[] | number |
Type LineplotData (object)
LineplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| binStart | array | |
| binStart[] | string | |
| binEnd | array | |
| binEnd[] | string | |
| binSampleSize | array | |
| binSampleSize[] | union | Inherits: lib.SampleSize |
| binSampleSize[] | anyOf | Any of the following types. |
| binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| binSampleSize[]{SimpleSampleSize}..N* | number | |
| binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| errorBars | array | |
| errorBars[] | object | Inherits: lib.ErrorBar |
| errorBars[].lowerBound* | number | |
| errorBars[].upperBound* | number | |
| errorBars[].error* | string |
Type PlotConfig (object)
PlotConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type SampleSizeTable (object)
SampleSizeTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xVariableDetails | array | |
| xVariableDetails[] | object | Inherits: object |
| xVariableDetails[].entityId* | string | |
| xVariableDetails[].variableId* | string | |
| xVariableDetails[].value* | string | |
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| size* | array | |
| size[] | number |
Type VariableCompleteCases (object)
VariableCompleteCases
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableDetails* | object | Inherits: object |
| variableDetails.entityId* | string | |
| variableDetails.variableId* | string | |
| completeCases* | number |
Type CategoricalDistributionPostRequest (object)
CategoricalDistributionPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.variableId* | string |
Type CategoricalDistributionBin (object)
CategoricalDistributionBin
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| label* | string | |
| value* | number |
Type CategoricalDistributionPostResponse (object)
CategoricalDistributionPostResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countDistribution* | array | |
| countDistribution[] | object | Additional properties: Yes Inherits: object |
| countDistribution[].label* | string | |
| countDistribution[].value* | number | |
| proportionDistribution* | array | |
| proportionDistribution[] | object | Additional properties: Yes Inherits: object |
| proportionDistribution[].label* | string | |
| proportionDistribution[].value* | number |
Type ExampleComputeVizPostRequest (object)
ExampleComputeVizPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ExampleComputeVizSpec |
| config.prefixVar* | object | Inherits: object |
| config.prefixVar.entityId* | string | |
| config.prefixVar.variableId* | string | |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.inputVariable* | object | Inherits: object |
| computeConfig.inputVariable.entityId* | string | |
| computeConfig.inputVariable.variableId* | string | |
| computeConfig.valueSuffix* | string |
Type ExampleComputeVizSpec (object)
ExampleComputeVizSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| prefixVar* | object | Inherits: object |
| prefixVar.entityId* | string | |
| prefixVar.variableId* | string |
Type ExampleComputeVizPostResponse (object)
ExampleComputeVizPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countPluginResult* | integer | |
| numEmptyValues* | integer | |
| longestConcatenatedValue* | string | |
| avgConcatenatedLength* | number |
Type MultiStreamPostRequest (object)
MultiStreamPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MultiStreamSpec |
| config.entityId* | string |
Type MultiStreamSpec (object)
MultiStreamSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostRequest (object)
RecordCountPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.RecordCountSpec |
| config.entityId* | string |
Type RecordCountSpec (object)
RecordCountSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostResponse (object)
RecordCountPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| recordCount* | integer |
Type TestCollectionsPostRequest (object)
TestCollectionsPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.collectionId* | string |
Type CollectionFloatingBarplotPostRequest (object)
CollectionFloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.overlayConfig.selectedValues | array | |
| config.overlayConfig.selectedValues[] | string |
Type CollectionFloatingBarplotSpec (object)
CollectionFloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| overlayConfig.selectedValues | array | |
| overlayConfig.selectedValues[] | string |
Type CollectionFloatingBoxplotPostRequest (object)
CollectionFloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingBoxplotSpec (object)
CollectionFloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingContTablePostRequest (object)
CollectionFloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.xAxisVariable.collection* | object | Inherits: object |
| config.xAxisVariable.collection.entityId* | string | |
| config.xAxisVariable.collection.collectionId* | string | |
| config.xAxisVariable.selectedMembers* | array | |
| config.xAxisVariable.selectedMembers[] | object | Inherits: object |
| config.xAxisVariable.selectedMembers[].entityId* | string | |
| config.xAxisVariable.selectedMembers[].variableId* | string | |
| config.xAxisVariable.selectedValues | array | |
| config.xAxisVariable.selectedValues[] | string |
Type CollectionFloatingContTableSpec (object)
CollectionFloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| xAxisVariable.collection* | object | Inherits: object |
| xAxisVariable.collection.entityId* | string | |
| xAxisVariable.collection.collectionId* | string | |
| xAxisVariable.selectedMembers* | array | |
| xAxisVariable.selectedMembers[] | object | Inherits: object |
| xAxisVariable.selectedMembers[].entityId* | string | |
| xAxisVariable.selectedMembers[].variableId* | string | |
| xAxisVariable.selectedValues | array | |
| xAxisVariable.selectedValues[] | string |
Type CollectionFloatingHistogramPostRequest (object)
CollectionFloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinWidthSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingHistogramSpec (object)
CollectionFloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinWidthSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type CollectionFloatingLineplotPostRequest (object)
CollectionFloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.overlayConfig.selectedValues | array | |
| config.overlayConfig.selectedValues[] | string | |
| config.binSpec | object | Inherits: lib.BinWidthSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingLineplotSpec (object)
CollectionFloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| overlayConfig.selectedValues | array | |
| overlayConfig.selectedValues[] | string | |
| binSpec | object | Inherits: lib.BinWidthSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type StandaloneCollectionMapMarkerPostRequest (object)
StandaloneCollectionMapMarkerPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for a map marker Inherits: lib.StandaloneCollectionMapMarkerSpec |
| config.outputEntityId* | string | Entity ID associated with collection variable of interest. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number | |
| config.collection* | object | Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.collection.collection* | object | Inherits: object |
| config.collection.collection.entityId* | string | |
| config.collection.collection.collectionId* | string | |
| config.collection.selectedMembers* | array | |
| config.collection.selectedMembers[] | object | Inherits: object |
| config.collection.selectedMembers[].entityId* | string | |
| config.collection.selectedMembers[].variableId* | string | |
| config.aggregatorConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.aggregatorConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type StandaloneCollectionMapMarkerSpec (object)
StandaloneCollectionMapMarkerSpec
Specification for a map marker
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity ID associated with collection variable of interest. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number | |
| collection* | object | Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| collection.collection* | object | Inherits: object |
| collection.collection.entityId* | string | |
| collection.collection.collectionId* | string | |
| collection.selectedMembers* | array | |
| collection.selectedMembers[] | object | Inherits: object |
| collection.selectedMembers[].entityId* | string | |
| collection.selectedMembers[].variableId* | string | |
| aggregatorConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| aggregatorConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type CollectionOverlayConfig (object)
CollectionOverlayConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collection* | object | Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| selectedMembers* | array | |
| selectedMembers[] | object | Inherits: object |
| selectedMembers[].entityId* | string | |
| selectedMembers[].variableId* | string |
Type CollectionMapMarkerElement (object)
CollectionMapMarkerElement
Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number | |
| values* | array | |
| values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| values[].variableId* | string | |
| values[].value* | number | |
| values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| values[].confidenceInterval.min* | number | |
| values[].confidenceInterval.max* | number | |
| values[].n* | number |
Type CollectionMemberAggregate (object)
CollectionMemberAggregate
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| value* | number | |
| confidenceInterval* | object | Inherits: lib.NumberRange |
| confidenceInterval.min* | number | |
| confidenceInterval.max* | number | |
| n* | number |
Type StandaloneCollectionMapMarkerPostResponse (object)
StandaloneCollectionMapMarkerPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| markers* | array | |
| markers[] | object | Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar. Additional properties: Yes Inherits: object |
| markers[].entityCount* | number | |
| markers[].avgLat* | number | |
| markers[].avgLon* | number | |
| markers[].minLat* | number | |
| markers[].minLon* | number | |
| markers[].maxLat* | number | |
| markers[].maxLon* | number | |
| markers[].values* | array | |
| markers[].values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| markers[].values[].variableId* | string | |
| markers[].values[].value* | number | |
| markers[].values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| markers[].values[].confidenceInterval.min* | number | |
| markers[].values[].confidenceInterval.max* | number | |
| markers[].values[].n* | number |
Type FloatingBarplotPostRequest (object)
FloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplotSpec (object)
FloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplot (object)
FloatingBarplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBarplotPostResponse (object)
FloatingBarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: object |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.variables* | array | |
| barplot.variables[] | object | Inherits: object |
| barplot.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| barplot.variables[].variableSpec.entityId* | string | |
| barplot.variables[].variableSpec.variableId* | string | |
| barplot.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| barplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| barplot.variables[].displayName | string | |
| barplot.variables[].displayRangeMin | any | |
| barplot.variables[].displayRangeMax | any | |
| barplot.variables[].vocabulary | array | |
| barplot.variables[].vocabulary[] | string | |
| barplot.variables[].imputeZero* | boolean | |
| barplot.variables[].hasStudyDependentVocabulary | boolean | |
| barplot.variables[].isCollection* | boolean | |
| barplot.variables[].members | array | |
| barplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| barplot.variables[].members[].entityId* | string | |
| barplot.variables[].members[].variableId* | string |
Type FloatingBoxplotPostRequest (object)
FloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplotSpec (object)
FloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplot (object)
FloatingBoxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBoxplotPostResponse (object)
FloatingBoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: object |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.variables* | array | |
| boxplot.variables[] | object | Inherits: object |
| boxplot.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| boxplot.variables[].variableSpec.entityId* | string | |
| boxplot.variables[].variableSpec.variableId* | string | |
| boxplot.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| boxplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| boxplot.variables[].displayName | string | |
| boxplot.variables[].displayRangeMin | any | |
| boxplot.variables[].displayRangeMax | any | |
| boxplot.variables[].vocabulary | array | |
| boxplot.variables[].vocabulary[] | string | |
| boxplot.variables[].imputeZero* | boolean | |
| boxplot.variables[].hasStudyDependentVocabulary | boolean | |
| boxplot.variables[].isCollection* | boolean | |
| boxplot.variables[].members | array | |
| boxplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| boxplot.variables[].members[].entityId* | string | |
| boxplot.variables[].members[].variableId* | string |
Type FloatingContTablePostRequest (object)
FloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string |
Type FloatingContTableSpec (object)
FloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string |
Type FloatingContTable (object)
FloatingContTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingContTablePostResponse (object)
FloatingContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: object |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.variables* | array | |
| mosaic.variables[] | object | Inherits: object |
| mosaic.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.variables[].variableSpec.entityId* | string | |
| mosaic.variables[].variableSpec.variableId* | string | |
| mosaic.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.variables[].displayName | string | |
| mosaic.variables[].displayRangeMin | any | |
| mosaic.variables[].displayRangeMax | any | |
| mosaic.variables[].vocabulary | array | |
| mosaic.variables[].vocabulary[] | string | |
| mosaic.variables[].imputeZero* | boolean | |
| mosaic.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.variables[].isCollection* | boolean | |
| mosaic.variables[].members | array | |
| mosaic.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.variables[].members[].entityId* | string | |
| mosaic.variables[].members[].variableId* | string | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string |
Type FloatingHistogramPostRequest (object)
FloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingHistogramSpec (object)
FloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingHistogram (object)
FloatingHistogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingHistogramPostResponse (object)
FloatingHistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: object |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.variables* | array | |
| histogram.variables[] | object | Inherits: object |
| histogram.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| histogram.variables[].variableSpec.entityId* | string | |
| histogram.variables[].variableSpec.variableId* | string | |
| histogram.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| histogram.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| histogram.variables[].displayName | string | |
| histogram.variables[].displayRangeMin | any | |
| histogram.variables[].displayRangeMax | any | |
| histogram.variables[].vocabulary | array | |
| histogram.variables[].vocabulary[] | string | |
| histogram.variables[].imputeZero* | boolean | |
| histogram.variables[].hasStudyDependentVocabulary | boolean | |
| histogram.variables[].isCollection* | boolean | |
| histogram.variables[].members | array | |
| histogram.variables[].members[] | object | Inherits: lib.VariableSpec |
| histogram.variables[].members[].entityId* | string | |
| histogram.variables[].members[].variableId* | string |
Type FloatingLineplotPostRequest (object)
FloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingLineplotSpec (object)
FloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingLineplot (object)
FloatingLineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingLineplotPostResponse (object)
FloatingLineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].hasStudyDependentVocabulary | boolean | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
Type FloatingScatterplotPostRequest (object)
FloatingScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingScatterplotSpec |
| config.outputEntityId* | string | |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplotSpec (object)
FloatingScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplot (object)
FloatingScatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingScatterplotPostResponse (object)
FloatingScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.variables* | array | |
| scatterplot.variables[] | object | Inherits: object |
| scatterplot.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| scatterplot.variables[].variableSpec.entityId* | string | |
| scatterplot.variables[].variableSpec.variableId* | string | |
| scatterplot.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| scatterplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| scatterplot.variables[].displayName | string | |
| scatterplot.variables[].displayRangeMin | any | |
| scatterplot.variables[].displayRangeMax | any | |
| scatterplot.variables[].vocabulary | array | |
| scatterplot.variables[].vocabulary[] | string | |
| scatterplot.variables[].imputeZero* | boolean | |
| scatterplot.variables[].hasStudyDependentVocabulary | boolean | |
| scatterplot.variables[].isCollection* | boolean | |
| scatterplot.variables[].members | array | |
| scatterplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| scatterplot.variables[].members[].entityId* | string | |
| scatterplot.variables[].members[].variableId* | string |
Type StandaloneMapBubblesLegendPostRequest (object)
StandaloneMapBubblesLegendPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapBubblesLegendSpec |
| config.outputEntityId* | string | |
| config.colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| config.colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| config.colorLegendConfig.geoAggregateVariable.entityId* | string | |
| config.colorLegendConfig.geoAggregateVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| config.sizeConfig.geoAggregateVariable* | object | Inherits: object |
| config.sizeConfig.geoAggregateVariable.entityId* | string | |
| config.sizeConfig.geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendSpec (object)
StandaloneMapBubblesLegendSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| colorLegendConfig.geoAggregateVariable.entityId* | string | |
| colorLegendConfig.geoAggregateVariable.variableId* | string | |
| colorLegendConfig.quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| sizeConfig.geoAggregateVariable* | object | Inherits: object |
| sizeConfig.geoAggregateVariable.entityId* | string | |
| sizeConfig.geoAggregateVariable.variableId* | string |
Type OverlayLegendConfig (object)
OverlayLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type SizeLegendConfig (object)
SizeLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendPostResponse (object)
StandaloneMapBubblesLegendPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| minColorValue* | string | |
| maxColorValue* | string | |
| minSizeValue* | number | |
| maxSizeValue* | number |
Type StandaloneMapBubblesPostRequest (object)
StandaloneMapBubblesPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for map bubbles. Inherits: lib.StandaloneMapBubblesSpec |
| config.outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.overlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.overlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapBubblesSpec (object)
StandaloneMapBubblesSpec
Specification for map bubbles.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| overlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| overlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapBubblesPostResponse (object)
StandaloneMapBubblesPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.ColoredMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValue* | string | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type ColoredMapElementInfo (object)
ColoredMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValue* | string | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type StandaloneMapMarkersPostRequest (object)
StandaloneMapMarkersPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapMarkersSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapMarkersSpec (object)
StandaloneMapMarkersSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapMarkersPostResponse (object)
StandaloneMapMarkersPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.StandaloneMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValues* | array | |
| mapElements[].overlayValues[] | object | Inherits: lib.LegacyLabeledRangeWithCountAndValue |
| mapElements[].overlayValues[].binStart* | string | |
| mapElements[].overlayValues[].binEnd* | string | |
| mapElements[].overlayValues[].binLabel* | string | |
| mapElements[].overlayValues[].value* | number | |
| mapElements[].overlayValues[].count* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type OverlayType (string)
OverlayType
Enum:
- continuous
- categorical
Inherits: string
Type OverlayConfig (object)
OverlayConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type ContinousOverlayConfig (object)
ContinousOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: lib.LegacyLabeledRange |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string |
Type CategoricalOverlayConfig (object)
CategoricalOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | string |
Type StandaloneMapElementInfo (object)
StandaloneMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: lib.LegacyLabeledRangeWithCountAndValue |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string | |
| overlayValues[].value* | number | |
| overlayValues[].count* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type DataPluginRequestBase (object)
DataPluginRequestBase
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
Type EmptyDataPluginSpec (object)
EmptyDataPluginSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|
Type StringBoolean (string)
StringBoolean
Enum:
- TRUE
- FALSE
Inherits: string
Type StrataVariableDetails (object)
StrataVariableDetails
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| value* | string |
Type BinSpec (object)
BinSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| type | string | Enum:
|
| value | number | |
| units | string | Enum:
Inherits: string |
| range | union | |
| range | anyOf | Any of the following types. |
| range{NumberRange} | object | Inherits: lib.NumberRange |
| range{NumberRange}..min* | number | |
| range{NumberRange}..max* | number | |
| range{DateRange} | object | Inherits: lib.DateRange |
| range{DateRange}..min* | string | |
| range{DateRange}..max* | string |
Type BinWidthSpec (object)
BinWidthSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| type | string | Enum:
|
| value | number | |
| units | string | Enum:
Inherits: string |
| range | union | |
| range | anyOf | Any of the following types. |
| range{NumberRange} | object | Inherits: lib.NumberRange |
| range{NumberRange}..min* | number | |
| range{NumberRange}..max* | number | |
| range{DateRange} | object | Inherits: lib.DateRange |
| range{DateRange}..min* | string | |
| range{DateRange}..max* | string |
Type NumberRange (object)
NumberRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number |
Type DateRange (object)
DateRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string |
Type NumericViewport (object)
NumericViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xMin* | string | |
| xMax* | string |
Type LongitudeViewport (object)
LongitudeViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| left* | number | |
| right* | number |
Type GeolocationViewport (object)
GeolocationViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| latitude* | object | Inherits: object |
| latitude.xMin* | string | |
| latitude.xMax* | string | |
| longitude* | object | Inherits: object |
| longitude.left* | number | |
| longitude.right* | number |
Type ErrorBar (object)
ErrorBar
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lowerBound* | number | |
| upperBound* | number | |
| error* | string |
Type SimpleSampleSize (object)
SimpleSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| N* | number |
Type ProportionSampleSize (object)
ProportionSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numeratorN* | number | |
| denominatorN* | number |
Type SampleSize (union)
SampleSize
Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize
Model
| Parameter | Type | Description |
|---|---|---|
| anyOf | Any of the following types. | |
| {SimpleSampleSize} | object | Inherits: object |
| {SimpleSampleSize}.N* | number | |
| {ProportionSampleSize} | object | Inherits: object |
| {ProportionSampleSize}.numeratorN* | number | |
| {ProportionSampleSize}.denominatorN* | number |
Type ShowMissingness (string)
ShowMissingness
Enum:
- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type ShowMissingnessNoAxes (string)
ShowMissingnessNoAxes
Enum:
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type BoxplotWith1ComputeSpec (object)
BoxplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: string |
| computeStats* | string | Enum:
Inherits: string |
| xAxisVariable | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type ScatterplotWith1ComputeSpec (object)
ScatterplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Aggregator (string)
Aggregator
Enum:
- mean
- median
Inherits: string
Type QuantitativeOverlayConfig (object)
QuantitativeOverlayConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| aggregationConfig.overlayType* | string | Enum:
Inherits: string |
Type QuantitativeAggregationConfig (object)
QuantitativeAggregationConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
Type ContinuousAggregationConfig (object)
ContinuousAggregationConfig
Discriminator: overlayType
Discriminator value: continuous
Inherits: lib.QuantitativeAggregationConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| aggregator* | string | Enum:
Inherits: string |
Type CategoricalAggregationConfig (object)
CategoricalAggregationConfig
Discriminator: overlayType
Discriminator value: categorical
Inherits: lib.QuantitativeAggregationConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| numeratorValues* | array | |
| numeratorValues[] | string | |
| denominatorValues* | array | |
| denominatorValues[] | string |
Type CollectionOverlayConfigWithValues (object)
CollectionOverlayConfigWithValues
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| collection* | object | Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| selectedMembers* | array | |
| selectedMembers[] | object | Inherits: object |
| selectedMembers[].entityId* | string | |
| selectedMembers[].variableId* | string | |
| selectedValues | array | |
| selectedValues[] | string |
Type LegacyLabeledRange (object)
LegacyLabeledRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string |
Type LegacyLabeledRangeWithCountAndValue (object)
LegacyLabeledRangeWithCountAndValue
Inherits: lib.LegacyLabeledRange
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string | |
| value* | number | |
| count* | number |
Type Error (object)
Error
Discriminator: status
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Type ErrorType (string)
ErrorType
Enum:
- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: string
Type BadRequestError (object)
Bad Request
Request could not be parsed or was otherwise unusable.
Discriminator: status
Discriminator value: bad-request
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
+ /<path>Types
Type VariableClass (string)
VariableClass
Enum:
- native
- derived
- computed
Inherits: string
Type PlotReferenceValue (string)
PlotReferenceValue
Enum:
- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
Type VariableMapping (object)
VariableMapping
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableClass* | string | Enum:
Inherits: string |
| variableSpec* | object | Inherits: lib.VariableSpec |
| variableSpec.entityId* | string | |
| variableSpec.variableId* | string | |
| plotReference* | string | Enum:
Inherits: string |
| dataType* | string | Enum:
Inherits: lib.API_VariableType |
| dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| displayName | string | |
| displayRangeMin | any | |
| displayRangeMax | any | |
| vocabulary | array | |
| vocabulary[] | string | |
| imputeZero* | boolean | |
| hasStudyDependentVocabulary | boolean | |
| isCollection* | boolean | |
| members | array | |
| members[] | object | Inherits: lib.VariableSpec |
| members[].entityId* | string | |
| members[].variableId* | string |
Type API_Filter (object)
API_Filter
Additional properties: Yes
Discriminator: type
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
Type API_FilterType (string)
API_FilterType
Enum:
- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: string
Type API_BooleanOperationType (string)
API_BooleanOperationType
Enum:
- intersect
- union
Inherits: string
Type API_MultiFilterSubFilter (object)
API_MultiFilterSubFilter
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_MultiFilter (object)
API_MultiFilter
Additional properties: Yes
Discriminator: type
Discriminator value: multiFilter
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| operation* | string | Enum:
Inherits: string |
| variableId* | string | |
| subFilters* | array | |
| subFilters[] | object | Additional properties: Yes Inherits: object |
| subFilters[].variableId* | string | |
| subFilters[].stringSet* | array | |
| subFilters[].stringSet[] | string |
Type API_StringSetFilter (object)
API_StringSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_NumberSetFilter (object)
API_NumberSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| numberSet* | array | |
| numberSet[] | number |
Type API_DateSetFilter (object)
API_DateSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| dateSet* | array | |
| dateSet[] | string |
Type API_NumberRangeFilter (object)
API_NumberRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: numberRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | number | |
| max* | number |
Type API_DateRangeFilter (object)
API_DateRangeFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | string | |
| max* | string |
Type API_LongitudeRangeFilter (object)
API_LongitudeRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: longitudeRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| left* | number | |
| right* | number |
Type DerivedVariableSpec (object)
DerivedVariableSpec
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| functionName* | string | |
| displayName* | string | |
| config* | object |
Type VariableSpec (object)
VariableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string |
Type CollectionSpec (object)
CollectionSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| collectionId* | string |
Type DataElementConstraint (object)
DataElementConstraint
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| isRequired* | boolean | |
| isTemporal* | boolean | |
| isCollection* | boolean | |
| isCompositional* | boolean | |
| isProportion* | boolean | |
| allowedNormalizationMethods* | array | |
| allowedNormalizationMethods[] | string | |
| minNumVars* | number | |
| maxNumVars* | number | |
| minNumValues* | number | |
| maxNumValues* | number | |
| allowedTypes | array | |
| allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| allowedShapes | array | |
| allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| description* | string |
Type DataElementConstraintPattern (object)
DataElementConstraintPattern
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| //* | object | Inherits: object |
| //.isRequired* | boolean | |
| //.isTemporal* | boolean | |
| //.isCollection* | boolean | |
| //.isCompositional* | boolean | |
| //.isProportion* | boolean | |
| //.allowedNormalizationMethods* | array | |
| //.allowedNormalizationMethods[] | string | |
| //.minNumVars* | number | |
| //.maxNumVars* | number | |
| //.minNumValues* | number | |
| //.maxNumValues* | number | |
| //.allowedTypes | array | |
| //.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| //.allowedShapes | array | |
| //.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| //.description* | string |
Type EntityTabularPostResponse (object)
EntityTabularPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| tabular* | array | |
| tabular[] | array | |
| tabular[][] | string |
Type Range (object)
Range
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string |
Type LabeledRange (object)
LabeledRange
Inherits: lib.Range
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string | |
| label* | string |
Type API_VariableType (string)
API_VariableType
Enum:
- category
- string
- number
- date
- longitude
- integer
Inherits: string
Type API_VariableDataShape (string)
API_VariableDataShape
Enum:
- continuous
- categorical
- ordinal
- binary
Inherits: string
Type API_PagingConfig (object)
API_PagingConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numRows | integer | Format: int64 |
| offset | integer | Format: int64 |
Type BinUnits (string)
BinUnits
Enum:
- day
- week
- month
- year
Inherits: string
Type ValueSpec (string)
ValueSpec
Enum:
- count
- proportion
Inherits: string
Type AlphaDivComputeConfig (object)
AlphaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
Type AlphaDivMethod (string)
AlphaDivMethod
Enum:
- shannon
- simpson
- evenness
Inherits: string
Type BetaDivComputeConfig (object)
BetaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
Type BetaDivDissimilarityMethod (string)
BetaDivDissimilarityMethod
Enum:
- bray
- jaccard
- jsd
Inherits: string
Type FeaturePrefilterThresholds (object)
FeaturePrefilterThresholds
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| proportionNonZero | number | |
| variance | number | |
| standardDeviation | number |
Type CorrelationComputeConfig (object)
CorrelationComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| prefilterThresholds | object | Inherits: object |
| prefilterThresholds.proportionNonZero | number | |
| prefilterThresholds.variance | number | |
| prefilterThresholds.standardDeviation | number |
Type CorrelationMethod (string)
CorrelationMethod
Enum:
- spearman
- pearson
Inherits: string
Type Correlation1Collection (object)
Correlation1Collection
Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| prefilterThresholds | object | Inherits: object |
| prefilterThresholds.proportionNonZero | number | |
| prefilterThresholds.variance | number | |
| prefilterThresholds.standardDeviation | number | |
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string |
Type Correlation2Collections (object)
Correlation2Collections
Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
| Parameter | Type | Description |
|---|---|---|
| correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| prefilterThresholds | object | Inherits: object |
| prefilterThresholds.proportionNonZero | number | |
| prefilterThresholds.variance | number | |
| prefilterThresholds.standardDeviation | number | |
| collectionVariable1* | object | Inherits: object |
| collectionVariable1.entityId* | string | |
| collectionVariable1.collectionId* | string | |
| collectionVariable2* | object | Inherits: object |
| collectionVariable2.entityId* | string | |
| collectionVariable2.collectionId* | string |
Type DifferentialAbundanceComputeConfig (object)
DifferentialAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| comparator.variable* | object | Inherits: object |
| comparator.variable.entityId* | string | |
| comparator.variable.variableId* | string | |
| comparator.groupA* | array | |
| comparator.groupA[] | object | Inherits: lib.Range |
| comparator.groupA[].min* | string | |
| comparator.groupA[].max* | string | |
| comparator.groupA[].label* | string | |
| comparator.groupB* | array | |
| comparator.groupB[] | object | Inherits: lib.Range |
| comparator.groupB[].min* | string | |
| comparator.groupB[].max* | string | |
| comparator.groupB[].label* | string | |
| differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| pValueFloor | string |
Type DifferentialAbundanceMethod (string)
DifferentialAbundanceMethod
Enum:
- DESeq
- ANCOMBC
- Maaslin
Inherits: string
Type ComparatorSpec (object)
ComparatorSpec
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| groupA* | array | |
| groupA[] | object | Inherits: lib.Range |
| groupA[].min* | string | |
| groupA[].max* | string | |
| groupA[].label* | string | |
| groupB* | array | |
| groupB[] | object | Inherits: lib.Range |
| groupB[].min* | string | |
| groupB[].max* | string | |
| groupB[].label* | string |
Type DifferentialAbundanceStats (object)
DifferentialAbundanceStats
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| effectSize* | array | |
| effectSize[] | string | |
| pValue* | array | |
| pValue[] | string | |
| adjustedPValue* | array | |
| adjustedPValue[] | string | |
| pointId* | array | |
| pointId[] | string |
Type DifferentialAbundanceStatsResponse (object)
DifferentialAbundanceStatsResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| effectSizeLabel* | string | |
| statistics* | object | Additional properties: Yes Inherits: object |
| statistics.effectSize* | array | |
| statistics.effectSize[] | string | |
| statistics.pValue* | array | |
| statistics.pValue[] | string | |
| statistics.adjustedPValue* | array | |
| statistics.adjustedPValue[] | string | |
| statistics.pointId* | array | |
| statistics.pointId[] | string | |
| pvalueFloor | string | |
| adjustedPValueFloor | string |
Type ExampleComputeConfig (object)
ExampleComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| inputVariable* | object | Inherits: object |
| inputVariable.entityId* | string | |
| inputVariable.variableId* | string | |
| valueSuffix* | string |
Type RankedAbundanceComputeConfig (object)
RankedAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.collectionId* | string | |
| rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
Type RankingMethod (string)
RankingMethod
Enum:
- median
- q3
- variance
- max
Inherits: string
Type AbundanceBoxplotPostRequest (object)
AbundanceBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AbundanceScatterplotPostRequest (object)
AbundanceScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivBoxplotPostRequest (object)
AlphaDivBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivScatterplotPostRequest (object)
AlphaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AppsGetResponse (object)
AppsGetResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| apps* | array | |
| apps[] | object | Inherits: lib.AppOverview |
| apps[].name* | string | |
| apps[].displayName* | string | |
| apps[].description* | string | |
| apps[].projects* | array | |
| apps[].projects[] | string | |
| apps[].computeName | string | |
| apps[].visualizations* | array | |
| apps[].visualizations[] | object | Inherits: lib.VisualizationOverview |
| apps[].visualizations[].name* | string | |
| apps[].visualizations[].displayName* | string | |
| apps[].visualizations[].description* | string | |
| apps[].visualizations[].projects* | array | |
| apps[].visualizations[].projects[] | string | |
| apps[].visualizations[].maxPanels* | number | |
| apps[].visualizations[].dataElementConstraints | array | |
| apps[].visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isCollection* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isCompositional* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isProportion* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| apps[].visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| apps[].visualizations[].dataElementConstraints[].//.description* | string | |
| apps[].visualizations[].dataElementDependencyOrder | array | |
| apps[].visualizations[].dataElementDependencyOrder[] | array | |
| apps[].visualizations[].dataElementDependencyOrder[][] | string |
Type AppOverview (object)
AppOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| computeName | string | |
| visualizations* | array | |
| visualizations[] | object | Inherits: lib.VisualizationOverview |
| visualizations[].name* | string | |
| visualizations[].displayName* | string | |
| visualizations[].description* | string | |
| visualizations[].projects* | array | |
| visualizations[].projects[] | string | |
| visualizations[].maxPanels* | number | |
| visualizations[].dataElementConstraints | array | |
| visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| visualizations[].dataElementConstraints[].//.isCollection* | boolean | |
| visualizations[].dataElementConstraints[].//.isCompositional* | boolean | |
| visualizations[].dataElementConstraints[].//.isProportion* | boolean | |
| visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| visualizations[].dataElementConstraints[].//.description* | string | |
| visualizations[].dataElementDependencyOrder | array | |
| visualizations[].dataElementDependencyOrder[] | array | |
| visualizations[].dataElementDependencyOrder[][] | string |
Type VisualizationOverview (object)
VisualizationOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| maxPanels* | number | |
| dataElementConstraints | array | |
| dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| dataElementConstraints[].//* | object | Inherits: object |
| dataElementConstraints[].//.isRequired* | boolean | |
| dataElementConstraints[].//.isTemporal* | boolean | |
| dataElementConstraints[].//.isCollection* | boolean | |
| dataElementConstraints[].//.isCompositional* | boolean | |
| dataElementConstraints[].//.isProportion* | boolean | |
| dataElementConstraints[].//.allowedNormalizationMethods* | array | |
| dataElementConstraints[].//.allowedNormalizationMethods[] | string | |
| dataElementConstraints[].//.minNumVars* | number | |
| dataElementConstraints[].//.maxNumVars* | number | |
| dataElementConstraints[].//.minNumValues* | number | |
| dataElementConstraints[].//.maxNumValues* | number | |
| dataElementConstraints[].//.allowedTypes | array | |
| dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: lib.API_VariableType |
| dataElementConstraints[].//.allowedShapes | array | |
| dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: lib.API_VariableDataShape |
| dataElementConstraints[].//.description* | string | |
| dataElementDependencyOrder | array | |
| dataElementDependencyOrder[] | array | |
| dataElementDependencyOrder[][] | string |
Type BetaDivScatterplotPostRequest (object)
BetaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
| config* | object | Inherits: lib.BetaDivScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string |
Type BetaDivScatterplotSpec (object)
BetaDivScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type CorrelationBipartitenetworkSpec (object)
CorrelationBipartitenetworkSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| significanceThreshold | number | |
| correlationCoefThreshold | number |
Type CorrelationBipartiteNetworkPostResponse (object)
CorrelationBipartiteNetworkPostResponse
Inherits: lib.BipartiteNetworkPostResponse
Model
| Parameter | Type | Description |
|---|---|---|
| bipartitenetwork* | object | Inherits: lib.BipartiteNetwork |
| bipartitenetwork.data* | object | Additional properties: Yes Inherits: lib.BipartiteNetworkData |
| bipartitenetwork.data.nodes* | array | |
| bipartitenetwork.data.nodes[] | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.nodes[].id* | string | |
| bipartitenetwork.data.links* | array | |
| bipartitenetwork.data.links[] | object | Additional properties: Yes Inherits: lib.LinkData |
| bipartitenetwork.data.links[].source* | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.links[].source.id* | string | |
| bipartitenetwork.data.links[].target* | object | Additional properties: Yes Inherits: lib.NodeData |
| bipartitenetwork.data.links[].target.id* | string | |
| bipartitenetwork.data.links[].weight* | string | |
| bipartitenetwork.data.links[].color* | string | |
| bipartitenetwork.data.partitions* | array | Max. items: 2 |
| bipartitenetwork.data.partitions[] | object | Inherits: lib.NodeIdList |
| bipartitenetwork.data.partitions[].nodeIds* | array | |
| bipartitenetwork.data.partitions[].nodeIds[] | string | |
| bipartitenetwork.config* | object | Additional properties: Yes Inherits: lib.BipartiteNetworkConfig |
| bipartitenetwork.config.variables | array | |
| bipartitenetwork.config.variables[] | object | Inherits: object |
| bipartitenetwork.config.variables[].variableClass* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].variableSpec.entityId* | string | |
| bipartitenetwork.config.variables[].variableSpec.variableId* | string | |
| bipartitenetwork.config.variables[].plotReference* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| bipartitenetwork.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| bipartitenetwork.config.variables[].displayName | string | |
| bipartitenetwork.config.variables[].displayRangeMin | any | |
| bipartitenetwork.config.variables[].displayRangeMax | any | |
| bipartitenetwork.config.variables[].vocabulary | array | |
| bipartitenetwork.config.variables[].vocabulary[] | string | |
| bipartitenetwork.config.variables[].imputeZero* | boolean | |
| bipartitenetwork.config.variables[].hasStudyDependentVocabulary | boolean | |
| bipartitenetwork.config.variables[].isCollection* | boolean | |
| bipartitenetwork.config.variables[].members | array | |
| bipartitenetwork.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].members[].entityId* | string | |
| bipartitenetwork.config.variables[].members[].variableId* | string | |
| bipartitenetwork.config.partitionsMetadata* | array | Max. items: 2 |
| bipartitenetwork.config.partitionsMetadata[] | string | |
| significanceThreshold* | number | |
| correlationCoefThreshold* | number |
Type CorrelationAssayAssayBipartitenetworkPostRequest (object)
CorrelationAssayAssayBipartitenetworkPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: lib.CorrelationComputeConfig |
| computeConfig.correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| computeConfig.prefilterThresholds | object | Inherits: object |
| computeConfig.prefilterThresholds.proportionNonZero | number | |
| computeConfig.prefilterThresholds.variance | number | |
| computeConfig.prefilterThresholds.standardDeviation | number | |
| computeConfig.collectionVariable1* | object | Inherits: object |
| computeConfig.collectionVariable1.entityId* | string | |
| computeConfig.collectionVariable1.collectionId* | string | |
| computeConfig.collectionVariable2* | object | Inherits: object |
| computeConfig.collectionVariable2.entityId* | string | |
| computeConfig.collectionVariable2.collectionId* | string | |
| config* | object | Inherits: object |
| config.significanceThreshold | number | |
| config.correlationCoefThreshold | number |
Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)
CorrelationAssayMetadataBipartitenetworkPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: lib.CorrelationComputeConfig |
| computeConfig.correlationMethod* | string | Enum:
Inherits: lib.CorrelationMethod |
| computeConfig.prefilterThresholds | object | Inherits: object |
| computeConfig.prefilterThresholds.proportionNonZero | number | |
| computeConfig.prefilterThresholds.variance | number | |
| computeConfig.prefilterThresholds.standardDeviation | number | |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| config* | object | Inherits: object |
| config.significanceThreshold | number | |
| config.correlationCoefThreshold | number |
Type DifferentialAbundanceVolcanoplotPostRequest (object)
DifferentialAbundanceVolcanoplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.collectionId* | string | |
| computeConfig.comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| computeConfig.comparator.variable* | object | Inherits: object |
| computeConfig.comparator.variable.entityId* | string | |
| computeConfig.comparator.variable.variableId* | string | |
| computeConfig.comparator.groupA* | array | |
| computeConfig.comparator.groupA[] | object | Inherits: lib.Range |
| computeConfig.comparator.groupA[].min* | string | |
| computeConfig.comparator.groupA[].max* | string | |
| computeConfig.comparator.groupA[].label* | string | |
| computeConfig.comparator.groupB* | array | |
| computeConfig.comparator.groupB[] | object | Inherits: lib.Range |
| computeConfig.comparator.groupB[].min* | string | |
| computeConfig.comparator.groupB[].max* | string | |
| computeConfig.comparator.groupB[].label* | string | |
| computeConfig.differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| computeConfig.pValueFloor | string | |
| config* | object | Inherits: lib.EmptyDataPluginSpec |
Type ContinuousVariableMetadataPostRequest (object)
ContinuousVariableMetadataPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ContinuousVariableMetadataSpec |
| config.variable* | object | Inherits: object |
| config.variable.entityId* | string | |
| config.variable.variableId* | string | |
| config.metadata* | array | |
| config.metadata[] | string | Enum:
|
Type ContinuousVariableMetadataSpec (object)
ContinuousVariableMetadataSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| metadata* | array | |
| metadata[] | string | Enum:
|
Type AllBinRanges (object)
AllBinRanges
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| equalInterval* | array | |
| equalInterval[] | object | Inherits: lib.Range |
| equalInterval[].min* | string | |
| equalInterval[].max* | string | |
| equalInterval[].label* | string | |
| quantile* | array | |
| quantile[] | object | Inherits: lib.Range |
| quantile[].min* | string | |
| quantile[].max* | string | |
| quantile[].label* | string | |
| standardDeviation* | array | |
| standardDeviation[] | object | Inherits: lib.Range |
| standardDeviation[].min* | string | |
| standardDeviation[].max* | string | |
| standardDeviation[].label* | string |
Type ContinuousVariableMetadataPostResponse (object)
ContinuousVariableMetadataPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binRanges | object | Inherits: object |
| binRanges.equalInterval* | array | |
| binRanges.equalInterval[] | object | Inherits: lib.Range |
| binRanges.equalInterval[].min* | string | |
| binRanges.equalInterval[].max* | string | |
| binRanges.equalInterval[].label* | string | |
| binRanges.quantile* | array | |
| binRanges.quantile[] | object | Inherits: lib.Range |
| binRanges.quantile[].min* | string | |
| binRanges.quantile[].max* | string | |
| binRanges.quantile[].label* | string | |
| binRanges.standardDeviation* | array | |
| binRanges.standardDeviation[] | object | Inherits: lib.Range |
| binRanges.standardDeviation[].min* | string | |
| binRanges.standardDeviation[].max* | string | |
| binRanges.standardDeviation[].label* | string | |
| median | number |
Type NodeData (object)
NodeData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| id* | string |
Type LinkData (object)
LinkData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| source* | object | Additional properties: Yes Inherits: object |
| source.id* | string | |
| target* | object | Additional properties: Yes Inherits: object |
| target.id* | string | |
| weight* | string | |
| color* | string |
Type NetworkData (object)
NetworkData
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| nodes* | array | |
| nodes[] | object | Additional properties: Yes Inherits: object |
| nodes[].id* | string | |
| links* | array | |
| links[] | object | Additional properties: Yes Inherits: object |
| links[].source* | object | Additional properties: Yes Inherits: object |
| links[].source.id* | string | |
| links[].target* | object | Additional properties: Yes Inherits: object |
| links[].target.id* | string | |
| links[].weight* | string | |
| links[].color* | string |
Type NetworkConfig (object)
NetworkConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variables | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type NodeIdList (object)
NodeIdList
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| nodeIds* | array | |
| nodeIds[] | string |
Type BipartiteNetworkConfig (object)
BipartiteNetworkConfig
Additional properties: Yes
Inherits: lib.NetworkConfig
Model
| Parameter | Type | Description |
|---|---|---|
| variables | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| partitionsMetadata* | array | Max. items: 2 |
| partitionsMetadata[] | string |
Type BipartiteNetworkData (object)
BipartiteNetworkData
Additional properties: Yes
Inherits: lib.NetworkData
Model
| Parameter | Type | Description |
|---|---|---|
| nodes* | array | |
| nodes[] | object | Additional properties: Yes Inherits: object |
| nodes[].id* | string | |
| links* | array | |
| links[] | object | Additional properties: Yes Inherits: object |
| links[].source* | object | Additional properties: Yes Inherits: object |
| links[].source.id* | string | |
| links[].target* | object | Additional properties: Yes Inherits: object |
| links[].target.id* | string | |
| links[].weight* | string | |
| links[].color* | string | |
| partitions* | array | Max. items: 2 |
| partitions[] | object | Inherits: object |
| partitions[].nodeIds* | array | |
| partitions[].nodeIds[] | string |
Type BipartiteNetwork (object)
BipartiteNetwork
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | object | Additional properties: Yes Inherits: lib.NetworkData |
| data.nodes* | array | |
| data.nodes[] | object | Additional properties: Yes Inherits: object |
| data.nodes[].id* | string | |
| data.links* | array | |
| data.links[] | object | Additional properties: Yes Inherits: object |
| data.links[].source* | object | Additional properties: Yes Inherits: object |
| data.links[].source.id* | string | |
| data.links[].target* | object | Additional properties: Yes Inherits: object |
| data.links[].target.id* | string | |
| data.links[].weight* | string | |
| data.links[].color* | string | |
| data.partitions* | array | Max. items: 2 |
| data.partitions[] | object | Inherits: object |
| data.partitions[].nodeIds* | array | |
| data.partitions[].nodeIds[] | string | |
| config* | object | Additional properties: Yes Inherits: lib.NetworkConfig |
| config.variables | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.partitionsMetadata* | array | Max. items: 2 |
| config.partitionsMetadata[] | string |
Type BipartiteNetworkPostResponse (object)
BipartiteNetworkPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| bipartitenetwork* | object | Inherits: object |
| bipartitenetwork.data* | object | Additional properties: Yes Inherits: lib.NetworkData |
| bipartitenetwork.data.nodes* | array | |
| bipartitenetwork.data.nodes[] | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.nodes[].id* | string | |
| bipartitenetwork.data.links* | array | |
| bipartitenetwork.data.links[] | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].source* | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].source.id* | string | |
| bipartitenetwork.data.links[].target* | object | Additional properties: Yes Inherits: object |
| bipartitenetwork.data.links[].target.id* | string | |
| bipartitenetwork.data.links[].weight* | string | |
| bipartitenetwork.data.links[].color* | string | |
| bipartitenetwork.data.partitions* | array | Max. items: 2 |
| bipartitenetwork.data.partitions[] | object | Inherits: object |
| bipartitenetwork.data.partitions[].nodeIds* | array | |
| bipartitenetwork.data.partitions[].nodeIds[] | string | |
| bipartitenetwork.config* | object | Additional properties: Yes Inherits: lib.NetworkConfig |
| bipartitenetwork.config.variables | array | |
| bipartitenetwork.config.variables[] | object | Inherits: object |
| bipartitenetwork.config.variables[].variableClass* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].variableSpec.entityId* | string | |
| bipartitenetwork.config.variables[].variableSpec.variableId* | string | |
| bipartitenetwork.config.variables[].plotReference* | string | Enum:
Inherits: string |
| bipartitenetwork.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| bipartitenetwork.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| bipartitenetwork.config.variables[].displayName | string | |
| bipartitenetwork.config.variables[].displayRangeMin | any | |
| bipartitenetwork.config.variables[].displayRangeMax | any | |
| bipartitenetwork.config.variables[].vocabulary | array | |
| bipartitenetwork.config.variables[].vocabulary[] | string | |
| bipartitenetwork.config.variables[].imputeZero* | boolean | |
| bipartitenetwork.config.variables[].hasStudyDependentVocabulary | boolean | |
| bipartitenetwork.config.variables[].isCollection* | boolean | |
| bipartitenetwork.config.variables[].members | array | |
| bipartitenetwork.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| bipartitenetwork.config.variables[].members[].entityId* | string | |
| bipartitenetwork.config.variables[].members[].variableId* | string | |
| bipartitenetwork.config.partitionsMetadata* | array | Max. items: 2 |
| bipartitenetwork.config.partitionsMetadata[] | string |
Type BarplotPostRequest (object)
BarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BarplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type BarplotSpec (object)
BarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Barplot (object)
Barplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BarplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BarplotPostResponse (object)
BarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: lib.BarplotData |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.config* | object | Inherits: lib.PlotConfig |
| barplot.config.completeCasesAllVars* | number | |
| barplot.config.completeCasesAxesVars* | number | |
| barplot.config.variables* | array | |
| barplot.config.variables[] | object | Inherits: object |
| barplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| barplot.config.variables[].variableSpec.entityId* | string | |
| barplot.config.variables[].variableSpec.variableId* | string | |
| barplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| barplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| barplot.config.variables[].displayName | string | |
| barplot.config.variables[].displayRangeMin | any | |
| barplot.config.variables[].displayRangeMax | any | |
| barplot.config.variables[].vocabulary | array | |
| barplot.config.variables[].vocabulary[] | string | |
| barplot.config.variables[].imputeZero* | boolean | |
| barplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| barplot.config.variables[].isCollection* | boolean | |
| barplot.config.variables[].members | array | |
| barplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| barplot.config.variables[].members[].entityId* | string | |
| barplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BoxplotPostRequest (object)
BoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BoxplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type BoxplotSpec (object)
BoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: lib.StringBoolean |
| computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Boxplot (object)
Boxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BoxplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BoxplotPostResponse (object)
BoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
Type ContTableStatsTable (object)
ContTableStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| pvalue* | array | |
| pvalue[] | number | |
| degreesFreedom* | array | |
| degreesFreedom[] | number | |
| chisq* | array | |
| chisq[] | number |
Type ContTablePostResponse (object)
ContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].pvalue* | array | |
| statsTable[].pvalue[] | number | |
| statsTable[].degreesFreedom* | array | |
| statsTable[].degreesFreedom[] | number | |
| statsTable[].chisq* | array | |
| statsTable[].chisq[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type DensityplotPostRequest (object)
DensityplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.DensityplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type DensityplotSpec (object)
DensityplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Densityplot (object)
Densityplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.DensityplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].densityY* | array | |
| data[].densityY[] | number | |
| data[].densityX* | array | |
| data[].densityX[] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type DensityplotPostResponse (object)
DensityplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| densityplot* | object | Inherits: object |
| densityplot.data* | array | |
| densityplot.data[] | object | Inherits: lib.DensityplotData |
| densityplot.data[].overlayVariableDetails | object | Inherits: object |
| densityplot.data[].overlayVariableDetails.entityId* | string | |
| densityplot.data[].overlayVariableDetails.variableId* | string | |
| densityplot.data[].overlayVariableDetails.value* | string | |
| densityplot.data[].facetVariableDetails | array | Max. items: 2 |
| densityplot.data[].facetVariableDetails[] | object | Inherits: object |
| densityplot.data[].facetVariableDetails[].entityId* | string | |
| densityplot.data[].facetVariableDetails[].variableId* | string | |
| densityplot.data[].facetVariableDetails[].value* | string | |
| densityplot.data[].densityY* | array | |
| densityplot.data[].densityY[] | number | |
| densityplot.data[].densityX* | array | |
| densityplot.data[].densityX[] | number | |
| densityplot.config* | object | Inherits: lib.PlotConfig |
| densityplot.config.completeCasesAllVars* | number | |
| densityplot.config.completeCasesAxesVars* | number | |
| densityplot.config.variables* | array | |
| densityplot.config.variables[] | object | Inherits: object |
| densityplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| densityplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| densityplot.config.variables[].variableSpec.entityId* | string | |
| densityplot.config.variables[].variableSpec.variableId* | string | |
| densityplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| densityplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| densityplot.config.variables[].displayName | string | |
| densityplot.config.variables[].displayRangeMin | any | |
| densityplot.config.variables[].displayRangeMax | any | |
| densityplot.config.variables[].vocabulary | array | |
| densityplot.config.variables[].vocabulary[] | string | |
| densityplot.config.variables[].imputeZero* | boolean | |
| densityplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| densityplot.config.variables[].isCollection* | boolean | |
| densityplot.config.variables[].members | array | |
| densityplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| densityplot.config.variables[].members[].entityId* | string | |
| densityplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HeatmapPostRequest (object)
HeatmapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HeatmapSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.zAxisVariable | object | Inherits: object |
| config.zAxisVariable.entityId* | string | |
| config.zAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type HeatmapSpec (object)
HeatmapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| zAxisVariable | object | Inherits: object |
| zAxisVariable.entityId* | string | |
| zAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Heatmap (object)
Heatmap
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HeatmapData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type HeatmapPostResponse (object)
HeatmapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| heatmap* | object | Inherits: object |
| heatmap.data* | array | |
| heatmap.data[] | object | Inherits: lib.HeatmapData |
| heatmap.data[].facetVariableDetails | array | Max. items: 2 |
| heatmap.data[].facetVariableDetails[] | object | Inherits: object |
| heatmap.data[].facetVariableDetails[].entityId* | string | |
| heatmap.data[].facetVariableDetails[].variableId* | string | |
| heatmap.data[].facetVariableDetails[].value* | string | |
| heatmap.data[].value* | array | |
| heatmap.data[].value[] | array | |
| heatmap.data[].value[][] | number | |
| heatmap.data[].label* | array | |
| heatmap.data[].label[] | string | |
| heatmap.config* | object | Inherits: lib.PlotConfig |
| heatmap.config.completeCasesAllVars* | number | |
| heatmap.config.completeCasesAxesVars* | number | |
| heatmap.config.variables* | array | |
| heatmap.config.variables[] | object | Inherits: object |
| heatmap.config.variables[].variableClass* | string | Enum:
Inherits: string |
| heatmap.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| heatmap.config.variables[].variableSpec.entityId* | string | |
| heatmap.config.variables[].variableSpec.variableId* | string | |
| heatmap.config.variables[].plotReference* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| heatmap.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| heatmap.config.variables[].displayName | string | |
| heatmap.config.variables[].displayRangeMin | any | |
| heatmap.config.variables[].displayRangeMax | any | |
| heatmap.config.variables[].vocabulary | array | |
| heatmap.config.variables[].vocabulary[] | string | |
| heatmap.config.variables[].imputeZero* | boolean | |
| heatmap.config.variables[].hasStudyDependentVocabulary | boolean | |
| heatmap.config.variables[].isCollection* | boolean | |
| heatmap.config.variables[].members | array | |
| heatmap.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| heatmap.config.variables[].members[].entityId* | string | |
| heatmap.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HistogramPostRequest (object)
HistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HistogramSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramSpec (object)
HistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type HistogramSummary (object)
HistogramSummary
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| q1* | string | |
| median* | string | |
| mean* | string | |
| q3* | string | |
| max* | string |
Type HistogramConfig (object)
HistogramConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider* | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| summary* | object | Additional properties: Yes Inherits: object |
| summary.min* | string | |
| summary.q1* | string | |
| summary.median* | string | |
| summary.mean* | string | |
| summary.q3* | string | |
| summary.max* | string | |
| viewport* | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Histogram (object)
Histogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HistogramData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider* | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.summary* | object | Additional properties: Yes Inherits: object |
| config.summary.min* | string | |
| config.summary.q1* | string | |
| config.summary.median* | string | |
| config.summary.mean* | string | |
| config.summary.q3* | string | |
| config.summary.max* | string | |
| config.viewport* | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramPostResponse (object)
HistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: lib.HistogramData |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.config* | object | Inherits: lib.PlotConfig |
| histogram.config.completeCasesAllVars* | number | |
| histogram.config.completeCasesAxesVars* | number | |
| histogram.config.variables* | array | |
| histogram.config.variables[] | object | Inherits: object |
| histogram.config.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| histogram.config.variables[].variableSpec.entityId* | string | |
| histogram.config.variables[].variableSpec.variableId* | string | |
| histogram.config.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| histogram.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| histogram.config.variables[].displayName | string | |
| histogram.config.variables[].displayRangeMin | any | |
| histogram.config.variables[].displayRangeMax | any | |
| histogram.config.variables[].vocabulary | array | |
| histogram.config.variables[].vocabulary[] | string | |
| histogram.config.variables[].imputeZero* | boolean | |
| histogram.config.variables[].hasStudyDependentVocabulary | boolean | |
| histogram.config.variables[].isCollection* | boolean | |
| histogram.config.variables[].members | array | |
| histogram.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| histogram.config.variables[].members[].entityId* | string | |
| histogram.config.variables[].members[].variableId* | string | |
| histogram.config.binSlider* | object | Inherits: lib.BinSlider |
| histogram.config.binSlider.min* | number | |
| histogram.config.binSlider.max* | number | |
| histogram.config.binSlider.step* | number | |
| histogram.config.binSpec* | object | Inherits: lib.BinSpec |
| histogram.config.binSpec.type | string | Enum:
|
| histogram.config.binSpec.value | number | |
| histogram.config.binSpec.units | string | Enum:
Inherits: string |
| histogram.config.binSpec.range | union | |
| histogram.config.binSpec.range | anyOf | Any of the following types. |
| histogram.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| histogram.config.binSpec.range{NumberRange}..min* | number | |
| histogram.config.binSpec.range{NumberRange}..max* | number | |
| histogram.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| histogram.config.binSpec.range{DateRange}..min* | string | |
| histogram.config.binSpec.range{DateRange}..max* | string | |
| histogram.config.summary* | object | Additional properties: Yes Inherits: object |
| histogram.config.summary.min* | string | |
| histogram.config.summary.q1* | string | |
| histogram.config.summary.median* | string | |
| histogram.config.summary.mean* | string | |
| histogram.config.summary.q3* | string | |
| histogram.config.summary.max* | string | |
| histogram.config.viewport* | object | Inherits: lib.NumericViewport |
| histogram.config.viewport.xMin* | string | |
| histogram.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type LineplotPostRequest (object)
LineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotSpec (object)
LineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type LineplotConfig (object)
LineplotConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Lineplot (object)
Lineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.LineplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotPostResponse (object)
LineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapMarkersOverlayPostRequest (object)
MapMarkersOverlayPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapMarkersOverlaySpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.longitudeVariable | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlaySpec (object)
MapMarkersOverlaySpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| longitudeVariable | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlayConfig (object)
MapMarkersOverlayConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlay (object)
MapMarkersOverlay
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.MapMarkersOverlayData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlayPostResponse (object)
MapMarkersOverlayPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapMarkers* | object | Inherits: object |
| mapMarkers.data* | array | |
| mapMarkers.data[] | object | Inherits: lib.MapMarkersOverlayData |
| mapMarkers.data[].facetVariableDetails | array | Max. items: 2 |
| mapMarkers.data[].facetVariableDetails[] | object | Inherits: object |
| mapMarkers.data[].facetVariableDetails[].entityId* | string | |
| mapMarkers.data[].facetVariableDetails[].variableId* | string | |
| mapMarkers.data[].facetVariableDetails[].value* | string | |
| mapMarkers.data[].value* | array | |
| mapMarkers.data[].value[] | number | |
| mapMarkers.data[].label* | array | |
| mapMarkers.data[].label[] | string | |
| mapMarkers.config* | object | Inherits: lib.PlotConfig |
| mapMarkers.config.completeCasesAllVars* | number | |
| mapMarkers.config.completeCasesAxesVars* | number | |
| mapMarkers.config.variables* | array | |
| mapMarkers.config.variables[] | object | Inherits: object |
| mapMarkers.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mapMarkers.config.variables[].variableSpec.entityId* | string | |
| mapMarkers.config.variables[].variableSpec.variableId* | string | |
| mapMarkers.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mapMarkers.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mapMarkers.config.variables[].displayName | string | |
| mapMarkers.config.variables[].displayRangeMin | any | |
| mapMarkers.config.variables[].displayRangeMax | any | |
| mapMarkers.config.variables[].vocabulary | array | |
| mapMarkers.config.variables[].vocabulary[] | string | |
| mapMarkers.config.variables[].imputeZero* | boolean | |
| mapMarkers.config.variables[].hasStudyDependentVocabulary | boolean | |
| mapMarkers.config.variables[].isCollection* | boolean | |
| mapMarkers.config.variables[].members | array | |
| mapMarkers.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mapMarkers.config.variables[].members[].entityId* | string | |
| mapMarkers.config.variables[].members[].variableId* | string | |
| mapMarkers.config.viewport* | object | Inherits: lib.GeolocationViewport |
| mapMarkers.config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| mapMarkers.config.viewport.latitude.xMin* | string | |
| mapMarkers.config.viewport.latitude.xMax* | string | |
| mapMarkers.config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| mapMarkers.config.viewport.longitude.left* | number | |
| mapMarkers.config.viewport.longitude.right* | number | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapPostRequest (object)
MapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapSpec (object)
MapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapConfig (object)
MapConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesGeoVar* | number |
Type MapPostResponse (object)
MapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.MapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number | |
| config* | object | Inherits: object |
| config.completeCasesGeoVar* | number |
Type MapElementInfo (object)
MapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type ScatterplotPostRequest (object)
ScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type ScatterplotSpec (object)
ScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Scatterplot (object)
Scatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.ScatterplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotPostResponse (object)
ScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].hasStudyDependentVocabulary | boolean | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type TablePostRequest (object)
TablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.TableSpec |
| config.outputEntityId* | string | |
| config.outputVariable* | array | |
| config.outputVariable[] | object | Inherits: object |
| config.outputVariable[].entityId* | string | |
| config.outputVariable[].variableId* | string | |
| config.pagingConfig* | object | Additional properties: Yes Inherits: object |
| config.pagingConfig.numRows | integer | Format: int64 |
| config.pagingConfig.offset | integer | Format: int64 |
Type TableSpec (object)
TableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| outputVariable* | array | |
| outputVariable[] | object | Inherits: object |
| outputVariable[].entityId* | string | |
| outputVariable[].variableId* | string | |
| pagingConfig* | object | Additional properties: Yes Inherits: object |
| pagingConfig.numRows | integer | Format: int64 |
| pagingConfig.offset | integer | Format: int64 |
Type TablePostResponse (object)
TablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| columns* | array | |
| columns[] | object | Inherits: object |
| columns[].entityId* | string | |
| columns[].variableId* | string | |
| rows* | array | |
| rows[] | array | |
| rows[][] | string |
Type TwoByTwoSpec (object)
TwoByTwoSpec
Inherits: lib.MosaicSpec
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| xAxisReferenceValue* | string | |
| yAxisReferenceValue* | string |
Type TwoByTwoPostRequest (object)
TwoByTwoPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.xAxisReferenceValue* | string | |
| config.yAxisReferenceValue* | string |
Type Statistic (object)
Statistic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| value* | number | |
| confidenceInterval | string | |
| confidenceLevel | number | |
| pvalue* | string |
Type TwoByTwoStatsTable (object)
TwoByTwoStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| chisq* | object | Inherits: object |
| chisq.value* | number | |
| chisq.confidenceInterval | string | |
| chisq.confidenceLevel | number | |
| chisq.pvalue* | string | |
| fisher* | object | Inherits: object |
| fisher.value* | number | |
| fisher.confidenceInterval | string | |
| fisher.confidenceLevel | number | |
| fisher.pvalue* | string | |
| prevalence | object | Inherits: object |
| prevalence.value* | number | |
| prevalence.confidenceInterval | string | |
| prevalence.confidenceLevel | number | |
| prevalence.pvalue* | string | |
| oddsratio | object | Inherits: object |
| oddsratio.value* | number | |
| oddsratio.confidenceInterval | string | |
| oddsratio.confidenceLevel | number | |
| oddsratio.pvalue* | string | |
| relativerisk | object | Inherits: object |
| relativerisk.value* | number | |
| relativerisk.confidenceInterval | string | |
| relativerisk.confidenceLevel | number | |
| relativerisk.pvalue* | string | |
| sensitivity | object | Inherits: object |
| sensitivity.value* | number | |
| sensitivity.confidenceInterval | string | |
| sensitivity.confidenceLevel | number | |
| sensitivity.pvalue* | string | |
| specificity | object | Inherits: object |
| specificity.value* | number | |
| specificity.confidenceInterval | string | |
| specificity.confidenceLevel | number | |
| specificity.pvalue* | string | |
| posPredictiveValue | object | Inherits: object |
| posPredictiveValue.value* | number | |
| posPredictiveValue.confidenceInterval | string | |
| posPredictiveValue.confidenceLevel | number | |
| posPredictiveValue.pvalue* | string | |
| negPredictiveValue | object | Inherits: object |
| negPredictiveValue.value* | number | |
| negPredictiveValue.confidenceInterval | string | |
| negPredictiveValue.confidenceLevel | number | |
| negPredictiveValue.pvalue* | string |
Type TwoByTwoPostResponse (object)
TwoByTwoPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BarplotData (object)
BarplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type MapMarkersOverlayData (object)
MapMarkersOverlayData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotData (object)
BoxplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| lowerfence* | array | |
| lowerfence[] | number | |
| upperfence* | array | |
| upperfence[] | number | |
| q1* | array | |
| q1[] | number | |
| q3* | array | |
| q3[] | number | |
| median* | array | |
| median[] | number | |
| outliers | array | |
| outliers[] | array | |
| outliers[][] | number | |
| rawData | array | |
| rawData[] | array | |
| rawData[][] | number | |
| mean | array | |
| mean[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotStatsTable (object)
BoxplotStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xVariableDetails | object | Inherits: object |
| xVariableDetails.entityId* | string | |
| xVariableDetails.variableId* | string | |
| xVariableDetails.value* | string | |
| statistic* | string | |
| pvalue* | number | |
| parameter* | array | |
| parameter[] | number | |
| method* | string | |
| statsError* | string |
Type HistogramData (object)
HistogramData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| binStart* | array | |
| binStart[] | string | |
| binEnd* | array | |
| binEnd[] | string | |
| binLabel* | array | |
| binLabel[] | string |
Type BinSlider (object)
BinSlider
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number | |
| step* | number |
Type HeatmapData (object)
HeatmapData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | array | |
| value[][] | number | |
| label* | array | |
| label[] | string |
Type MosaicPostRequest (object)
MosaicPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type MosaicSpec (object)
MosaicSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type MosaicData (object)
MosaicData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xLabel* | array | |
| xLabel[] | string | |
| yLabel* | array | |
| yLabel[] | array | |
| yLabel[][] | string | |
| value* | array | |
| value[] | array | |
| value[][] | number |
Type Mosaic (object)
Mosaic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| config.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].hasStudyDependentVocabulary | boolean | |
| config.variables[].isCollection* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: lib.VariableSpec |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotData (object)
ScatterplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| smoothedMeanX | array | |
| smoothedMeanX[] | string | |
| smoothedMeanY | array | |
| smoothedMeanY[] | number | |
| smoothedMeanSE | array | |
| smoothedMeanSE[] | number | |
| smoothedMeanError | string | |
| bestFitLineX | array | |
| bestFitLineX[] | string | |
| bestFitLineY | array | |
| bestFitLineY[] | number | |
| r2 | number |
Type DensityplotData (object)
DensityplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| densityY* | array | |
| densityY[] | number | |
| densityX* | array | |
| densityX[] | number |
Type LineplotData (object)
LineplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| binStart | array | |
| binStart[] | string | |
| binEnd | array | |
| binEnd[] | string | |
| binSampleSize | array | |
| binSampleSize[] | union | Inherits: lib.SampleSize |
| binSampleSize[] | anyOf | Any of the following types. |
| binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| binSampleSize[]{SimpleSampleSize}..N* | number | |
| binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| errorBars | array | |
| errorBars[] | object | Inherits: lib.ErrorBar |
| errorBars[].lowerBound* | number | |
| errorBars[].upperBound* | number | |
| errorBars[].error* | string |
Type PlotConfig (object)
PlotConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type SampleSizeTable (object)
SampleSizeTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xVariableDetails | array | |
| xVariableDetails[] | object | Inherits: object |
| xVariableDetails[].entityId* | string | |
| xVariableDetails[].variableId* | string | |
| xVariableDetails[].value* | string | |
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| size* | array | |
| size[] | number |
Type VariableCompleteCases (object)
VariableCompleteCases
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableDetails* | object | Inherits: object |
| variableDetails.entityId* | string | |
| variableDetails.variableId* | string | |
| completeCases* | number |
Type CategoricalDistributionPostRequest (object)
CategoricalDistributionPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.variableId* | string |
Type CategoricalDistributionBin (object)
CategoricalDistributionBin
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| label* | string | |
| value* | number |
Type CategoricalDistributionPostResponse (object)
CategoricalDistributionPostResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countDistribution* | array | |
| countDistribution[] | object | Additional properties: Yes Inherits: object |
| countDistribution[].label* | string | |
| countDistribution[].value* | number | |
| proportionDistribution* | array | |
| proportionDistribution[] | object | Additional properties: Yes Inherits: object |
| proportionDistribution[].label* | string | |
| proportionDistribution[].value* | number |
Type ExampleComputeVizPostRequest (object)
ExampleComputeVizPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ExampleComputeVizSpec |
| config.prefixVar* | object | Inherits: object |
| config.prefixVar.entityId* | string | |
| config.prefixVar.variableId* | string | |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.inputVariable* | object | Inherits: object |
| computeConfig.inputVariable.entityId* | string | |
| computeConfig.inputVariable.variableId* | string | |
| computeConfig.valueSuffix* | string |
Type ExampleComputeVizSpec (object)
ExampleComputeVizSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| prefixVar* | object | Inherits: object |
| prefixVar.entityId* | string | |
| prefixVar.variableId* | string |
Type ExampleComputeVizPostResponse (object)
ExampleComputeVizPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countPluginResult* | integer | |
| numEmptyValues* | integer | |
| longestConcatenatedValue* | string | |
| avgConcatenatedLength* | number |
Type MultiStreamPostRequest (object)
MultiStreamPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MultiStreamSpec |
| config.entityId* | string |
Type MultiStreamSpec (object)
MultiStreamSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostRequest (object)
RecordCountPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.RecordCountSpec |
| config.entityId* | string |
Type RecordCountSpec (object)
RecordCountSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostResponse (object)
RecordCountPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| recordCount* | integer |
Type TestCollectionsPostRequest (object)
TestCollectionsPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.collectionId* | string |
Type CollectionFloatingBarplotPostRequest (object)
CollectionFloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.overlayConfig.selectedValues | array | |
| config.overlayConfig.selectedValues[] | string |
Type CollectionFloatingBarplotSpec (object)
CollectionFloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| overlayConfig.selectedValues | array | |
| overlayConfig.selectedValues[] | string |
Type CollectionFloatingBoxplotPostRequest (object)
CollectionFloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingBoxplotSpec (object)
CollectionFloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingContTablePostRequest (object)
CollectionFloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.xAxisVariable.collection* | object | Inherits: object |
| config.xAxisVariable.collection.entityId* | string | |
| config.xAxisVariable.collection.collectionId* | string | |
| config.xAxisVariable.selectedMembers* | array | |
| config.xAxisVariable.selectedMembers[] | object | Inherits: object |
| config.xAxisVariable.selectedMembers[].entityId* | string | |
| config.xAxisVariable.selectedMembers[].variableId* | string | |
| config.xAxisVariable.selectedValues | array | |
| config.xAxisVariable.selectedValues[] | string |
Type CollectionFloatingContTableSpec (object)
CollectionFloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| xAxisVariable.collection* | object | Inherits: object |
| xAxisVariable.collection.entityId* | string | |
| xAxisVariable.collection.collectionId* | string | |
| xAxisVariable.selectedMembers* | array | |
| xAxisVariable.selectedMembers[] | object | Inherits: object |
| xAxisVariable.selectedMembers[].entityId* | string | |
| xAxisVariable.selectedMembers[].variableId* | string | |
| xAxisVariable.selectedValues | array | |
| xAxisVariable.selectedValues[] | string |
Type CollectionFloatingHistogramPostRequest (object)
CollectionFloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinWidthSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingHistogramSpec (object)
CollectionFloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinWidthSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type CollectionFloatingLineplotPostRequest (object)
CollectionFloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.overlayConfig.selectedValues | array | |
| config.overlayConfig.selectedValues[] | string | |
| config.binSpec | object | Inherits: lib.BinWidthSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingLineplotSpec (object)
CollectionFloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig* | object | Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| overlayConfig.selectedValues | array | |
| overlayConfig.selectedValues[] | string | |
| binSpec | object | Inherits: lib.BinWidthSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type StandaloneCollectionMapMarkerPostRequest (object)
StandaloneCollectionMapMarkerPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for a map marker Inherits: lib.StandaloneCollectionMapMarkerSpec |
| config.outputEntityId* | string | Entity ID associated with collection variable of interest. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number | |
| config.collection* | object | Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| config.collection.collection* | object | Inherits: object |
| config.collection.collection.entityId* | string | |
| config.collection.collection.collectionId* | string | |
| config.collection.selectedMembers* | array | |
| config.collection.selectedMembers[] | object | Inherits: object |
| config.collection.selectedMembers[].entityId* | string | |
| config.collection.selectedMembers[].variableId* | string | |
| config.aggregatorConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.aggregatorConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type StandaloneCollectionMapMarkerSpec (object)
StandaloneCollectionMapMarkerSpec
Specification for a map marker
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity ID associated with collection variable of interest. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number | |
| collection* | object | Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig |
| collection.collection* | object | Inherits: object |
| collection.collection.entityId* | string | |
| collection.collection.collectionId* | string | |
| collection.selectedMembers* | array | |
| collection.selectedMembers[] | object | Inherits: object |
| collection.selectedMembers[].entityId* | string | |
| collection.selectedMembers[].variableId* | string | |
| aggregatorConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| aggregatorConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type CollectionOverlayConfig (object)
CollectionOverlayConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collection* | object | Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| selectedMembers* | array | |
| selectedMembers[] | object | Inherits: object |
| selectedMembers[].entityId* | string | |
| selectedMembers[].variableId* | string |
Type CollectionMapMarkerElement (object)
CollectionMapMarkerElement
Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number | |
| values* | array | |
| values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| values[].variableId* | string | |
| values[].value* | number | |
| values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| values[].confidenceInterval.min* | number | |
| values[].confidenceInterval.max* | number | |
| values[].n* | number |
Type CollectionMemberAggregate (object)
CollectionMemberAggregate
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| value* | number | |
| confidenceInterval* | object | Inherits: lib.NumberRange |
| confidenceInterval.min* | number | |
| confidenceInterval.max* | number | |
| n* | number |
Type StandaloneCollectionMapMarkerPostResponse (object)
StandaloneCollectionMapMarkerPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| markers* | array | |
| markers[] | object | Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar. Additional properties: Yes Inherits: object |
| markers[].entityCount* | number | |
| markers[].avgLat* | number | |
| markers[].avgLon* | number | |
| markers[].minLat* | number | |
| markers[].minLon* | number | |
| markers[].maxLat* | number | |
| markers[].maxLon* | number | |
| markers[].values* | array | |
| markers[].values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| markers[].values[].variableId* | string | |
| markers[].values[].value* | number | |
| markers[].values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| markers[].values[].confidenceInterval.min* | number | |
| markers[].values[].confidenceInterval.max* | number | |
| markers[].values[].n* | number |
Type FloatingBarplotPostRequest (object)
FloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplotSpec (object)
FloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplot (object)
FloatingBarplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBarplotPostResponse (object)
FloatingBarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: object |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.variables* | array | |
| barplot.variables[] | object | Inherits: object |
| barplot.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| barplot.variables[].variableSpec.entityId* | string | |
| barplot.variables[].variableSpec.variableId* | string | |
| barplot.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| barplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| barplot.variables[].displayName | string | |
| barplot.variables[].displayRangeMin | any | |
| barplot.variables[].displayRangeMax | any | |
| barplot.variables[].vocabulary | array | |
| barplot.variables[].vocabulary[] | string | |
| barplot.variables[].imputeZero* | boolean | |
| barplot.variables[].hasStudyDependentVocabulary | boolean | |
| barplot.variables[].isCollection* | boolean | |
| barplot.variables[].members | array | |
| barplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| barplot.variables[].members[].entityId* | string | |
| barplot.variables[].members[].variableId* | string |
Type FloatingBoxplotPostRequest (object)
FloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplotSpec (object)
FloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplot (object)
FloatingBoxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBoxplotPostResponse (object)
FloatingBoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: object |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.variables* | array | |
| boxplot.variables[] | object | Inherits: object |
| boxplot.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| boxplot.variables[].variableSpec.entityId* | string | |
| boxplot.variables[].variableSpec.variableId* | string | |
| boxplot.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| boxplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| boxplot.variables[].displayName | string | |
| boxplot.variables[].displayRangeMin | any | |
| boxplot.variables[].displayRangeMax | any | |
| boxplot.variables[].vocabulary | array | |
| boxplot.variables[].vocabulary[] | string | |
| boxplot.variables[].imputeZero* | boolean | |
| boxplot.variables[].hasStudyDependentVocabulary | boolean | |
| boxplot.variables[].isCollection* | boolean | |
| boxplot.variables[].members | array | |
| boxplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| boxplot.variables[].members[].entityId* | string | |
| boxplot.variables[].members[].variableId* | string |
Type FloatingContTablePostRequest (object)
FloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string |
Type FloatingContTableSpec (object)
FloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string |
Type FloatingContTable (object)
FloatingContTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingContTablePostResponse (object)
FloatingContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: object |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.variables* | array | |
| mosaic.variables[] | object | Inherits: object |
| mosaic.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| mosaic.variables[].variableSpec.entityId* | string | |
| mosaic.variables[].variableSpec.variableId* | string | |
| mosaic.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| mosaic.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| mosaic.variables[].displayName | string | |
| mosaic.variables[].displayRangeMin | any | |
| mosaic.variables[].displayRangeMax | any | |
| mosaic.variables[].vocabulary | array | |
| mosaic.variables[].vocabulary[] | string | |
| mosaic.variables[].imputeZero* | boolean | |
| mosaic.variables[].hasStudyDependentVocabulary | boolean | |
| mosaic.variables[].isCollection* | boolean | |
| mosaic.variables[].members | array | |
| mosaic.variables[].members[] | object | Inherits: lib.VariableSpec |
| mosaic.variables[].members[].entityId* | string | |
| mosaic.variables[].members[].variableId* | string | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string |
Type FloatingHistogramPostRequest (object)
FloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingHistogramSpec (object)
FloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingHistogram (object)
FloatingHistogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingHistogramPostResponse (object)
FloatingHistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: object |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.variables* | array | |
| histogram.variables[] | object | Inherits: object |
| histogram.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| histogram.variables[].variableSpec.entityId* | string | |
| histogram.variables[].variableSpec.variableId* | string | |
| histogram.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| histogram.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| histogram.variables[].displayName | string | |
| histogram.variables[].displayRangeMin | any | |
| histogram.variables[].displayRangeMax | any | |
| histogram.variables[].vocabulary | array | |
| histogram.variables[].vocabulary[] | string | |
| histogram.variables[].imputeZero* | boolean | |
| histogram.variables[].hasStudyDependentVocabulary | boolean | |
| histogram.variables[].isCollection* | boolean | |
| histogram.variables[].members | array | |
| histogram.variables[].members[] | object | Inherits: lib.VariableSpec |
| histogram.variables[].members[].entityId* | string | |
| histogram.variables[].members[].variableId* | string |
Type FloatingLineplotPostRequest (object)
FloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingLineplotSpec (object)
FloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingLineplot (object)
FloatingLineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingLineplotPostResponse (object)
FloatingLineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].hasStudyDependentVocabulary | boolean | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
Type FloatingScatterplotPostRequest (object)
FloatingScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingScatterplotSpec |
| config.outputEntityId* | string | |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplotSpec (object)
FloatingScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplot (object)
FloatingScatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].imputeZero* | boolean | |
| variables[].hasStudyDependentVocabulary | boolean | |
| variables[].isCollection* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: lib.VariableSpec |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingScatterplotPostResponse (object)
FloatingScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.variables* | array | |
| scatterplot.variables[] | object | Inherits: object |
| scatterplot.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.variables[].variableSpec* | object | Inherits: lib.VariableSpec |
| scatterplot.variables[].variableSpec.entityId* | string | |
| scatterplot.variables[].variableSpec.variableId* | string | |
| scatterplot.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataType* | string | Enum:
Inherits: lib.API_VariableType |
| scatterplot.variables[].dataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| scatterplot.variables[].displayName | string | |
| scatterplot.variables[].displayRangeMin | any | |
| scatterplot.variables[].displayRangeMax | any | |
| scatterplot.variables[].vocabulary | array | |
| scatterplot.variables[].vocabulary[] | string | |
| scatterplot.variables[].imputeZero* | boolean | |
| scatterplot.variables[].hasStudyDependentVocabulary | boolean | |
| scatterplot.variables[].isCollection* | boolean | |
| scatterplot.variables[].members | array | |
| scatterplot.variables[].members[] | object | Inherits: lib.VariableSpec |
| scatterplot.variables[].members[].entityId* | string | |
| scatterplot.variables[].members[].variableId* | string |
Type StandaloneMapBubblesLegendPostRequest (object)
StandaloneMapBubblesLegendPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapBubblesLegendSpec |
| config.outputEntityId* | string | |
| config.colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| config.colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| config.colorLegendConfig.geoAggregateVariable.entityId* | string | |
| config.colorLegendConfig.geoAggregateVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| config.sizeConfig.geoAggregateVariable* | object | Inherits: object |
| config.sizeConfig.geoAggregateVariable.entityId* | string | |
| config.sizeConfig.geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendSpec (object)
StandaloneMapBubblesLegendSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| colorLegendConfig.geoAggregateVariable.entityId* | string | |
| colorLegendConfig.geoAggregateVariable.variableId* | string | |
| colorLegendConfig.quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| sizeConfig.geoAggregateVariable* | object | Inherits: object |
| sizeConfig.geoAggregateVariable.entityId* | string | |
| sizeConfig.geoAggregateVariable.variableId* | string |
Type OverlayLegendConfig (object)
OverlayLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| quantitativeOverlayConfig* | object | Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| quantitativeOverlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| quantitativeOverlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
Type SizeLegendConfig (object)
SizeLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendPostResponse (object)
StandaloneMapBubblesLegendPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| minColorValue* | string | |
| maxColorValue* | string | |
| minSizeValue* | number | |
| maxSizeValue* | number |
Type StandaloneMapBubblesPostRequest (object)
StandaloneMapBubblesPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for map bubbles. Inherits: lib.StandaloneMapBubblesSpec |
| config.outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.overlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| config.overlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapBubblesSpec (object)
StandaloneMapBubblesSpec
Specification for map bubbles.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Additional properties: Yes Inherits: lib.QuantitativeOverlayConfig |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| overlayConfig.aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| overlayConfig.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapBubblesPostResponse (object)
StandaloneMapBubblesPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.ColoredMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValue* | string | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type ColoredMapElementInfo (object)
ColoredMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValue* | string | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type StandaloneMapMarkersPostRequest (object)
StandaloneMapMarkersPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapMarkersSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapMarkersSpec (object)
StandaloneMapMarkersSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapMarkersPostResponse (object)
StandaloneMapMarkersPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.StandaloneMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValues* | array | |
| mapElements[].overlayValues[] | object | Inherits: lib.LegacyLabeledRangeWithCountAndValue |
| mapElements[].overlayValues[].binStart* | string | |
| mapElements[].overlayValues[].binEnd* | string | |
| mapElements[].overlayValues[].binLabel* | string | |
| mapElements[].overlayValues[].value* | number | |
| mapElements[].overlayValues[].count* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type OverlayType (string)
OverlayType
Enum:
- continuous
- categorical
Inherits: string
Type OverlayConfig (object)
OverlayConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type ContinousOverlayConfig (object)
ContinousOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: lib.LegacyLabeledRange |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string |
Type CategoricalOverlayConfig (object)
CategoricalOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | string |
Type StandaloneMapElementInfo (object)
StandaloneMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: lib.LegacyLabeledRangeWithCountAndValue |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string | |
| overlayValues[].value* | number | |
| overlayValues[].count* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type DataPluginRequestBase (object)
DataPluginRequestBase
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].functionName* | string | |
| derivedVariables[].displayName* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
Type EmptyDataPluginSpec (object)
EmptyDataPluginSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|
Type StringBoolean (string)
StringBoolean
Enum:
- TRUE
- FALSE
Inherits: string
Type StrataVariableDetails (object)
StrataVariableDetails
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| value* | string |
Type BinSpec (object)
BinSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| type | string | Enum:
|
| value | number | |
| units | string | Enum:
Inherits: string |
| range | union | |
| range | anyOf | Any of the following types. |
| range{NumberRange} | object | Inherits: lib.NumberRange |
| range{NumberRange}..min* | number | |
| range{NumberRange}..max* | number | |
| range{DateRange} | object | Inherits: lib.DateRange |
| range{DateRange}..min* | string | |
| range{DateRange}..max* | string |
Type BinWidthSpec (object)
BinWidthSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| type | string | Enum:
|
| value | number | |
| units | string | Enum:
Inherits: string |
| range | union | |
| range | anyOf | Any of the following types. |
| range{NumberRange} | object | Inherits: lib.NumberRange |
| range{NumberRange}..min* | number | |
| range{NumberRange}..max* | number | |
| range{DateRange} | object | Inherits: lib.DateRange |
| range{DateRange}..min* | string | |
| range{DateRange}..max* | string |
Type NumberRange (object)
NumberRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number |
Type DateRange (object)
DateRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string |
Type NumericViewport (object)
NumericViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xMin* | string | |
| xMax* | string |
Type LongitudeViewport (object)
LongitudeViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| left* | number | |
| right* | number |
Type GeolocationViewport (object)
GeolocationViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| latitude* | object | Inherits: object |
| latitude.xMin* | string | |
| latitude.xMax* | string | |
| longitude* | object | Inherits: object |
| longitude.left* | number | |
| longitude.right* | number |
Type ErrorBar (object)
ErrorBar
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lowerBound* | number | |
| upperBound* | number | |
| error* | string |
Type SimpleSampleSize (object)
SimpleSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| N* | number |
Type ProportionSampleSize (object)
ProportionSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numeratorN* | number | |
| denominatorN* | number |
Type SampleSize (union)
SampleSize
Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize
Model
| Parameter | Type | Description |
|---|---|---|
| anyOf | Any of the following types. | |
| {SimpleSampleSize} | object | Inherits: object |
| {SimpleSampleSize}.N* | number | |
| {ProportionSampleSize} | object | Inherits: object |
| {ProportionSampleSize}.numeratorN* | number | |
| {ProportionSampleSize}.denominatorN* | number |
Type ShowMissingness (string)
ShowMissingness
Enum:
- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type ShowMissingnessNoAxes (string)
ShowMissingnessNoAxes
Enum:
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type BoxplotWith1ComputeSpec (object)
BoxplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: string |
| computeStats* | string | Enum:
Inherits: string |
| xAxisVariable | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type ScatterplotWith1ComputeSpec (object)
ScatterplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Aggregator (string)
Aggregator
Enum:
- mean
- median
Inherits: string
Type QuantitativeOverlayConfig (object)
QuantitativeOverlayConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| aggregationConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeAggregationConfig |
| aggregationConfig.overlayType* | string | Enum:
Inherits: string |
Type QuantitativeAggregationConfig (object)
QuantitativeAggregationConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
Type ContinuousAggregationConfig (object)
ContinuousAggregationConfig
Discriminator: overlayType
Discriminator value: continuous
Inherits: lib.QuantitativeAggregationConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| aggregator* | string | Enum:
Inherits: string |
Type CategoricalAggregationConfig (object)
CategoricalAggregationConfig
Discriminator: overlayType
Discriminator value: categorical
Inherits: lib.QuantitativeAggregationConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| numeratorValues* | array | |
| numeratorValues[] | string | |
| denominatorValues* | array | |
| denominatorValues[] | string |
Type CollectionOverlayConfigWithValues (object)
CollectionOverlayConfigWithValues
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| collection* | object | Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| selectedMembers* | array | |
| selectedMembers[] | object | Inherits: object |
| selectedMembers[].entityId* | string | |
| selectedMembers[].variableId* | string | |
| selectedValues | array | |
| selectedValues[] | string |
Type LegacyLabeledRange (object)
LegacyLabeledRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string |
Type LegacyLabeledRangeWithCountAndValue (object)
LegacyLabeledRangeWithCountAndValue
Inherits: lib.LegacyLabeledRange
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string | |
| value* | number | |
| count* | number |
Type Error (object)
Error
Discriminator: status
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Type ErrorType (string)
ErrorType
Enum:
- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: string
Type BadRequestError (object)
Bad Request
Request could not be parsed or was otherwise unusable.
Discriminator: status
Discriminator value: bad-request
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "bad-request",
"message": "malformed JSON"
}Type UnauthorizedError (object)
Unauthorized
Unauthenticated client requested a resource that requires authentication.
Discriminator: status
Discriminator value: unauthorized
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
diff --git a/schema/library.raml b/schema/library.raml
index 206bb3fa..156c2a5d 100644
--- a/schema/library.raml
+++ b/schema/library.raml
@@ -646,10 +646,18 @@ types:
type: object
properties:
pcoaVariance: number[]
+ FeaturePrefilterThresholds:
+ type: object
+ additionalProperties: false
+ properties:
+ proportionNonZero?: number
+ variance?: number
+ standardDeviation?: number
CorrelationComputeConfig:
type: object
properties:
correlationMethod: CorrelationMethod
+ prefilterThresholds?: FeaturePrefilterThresholds
CorrelationMethod:
type: string
enum:
@@ -778,6 +786,15 @@ types:
additionalProperties: false
properties:
isCutoff: boolean
+ InternalJob:
+ type: object
+ properties:
+ jobId: JobID
+ status: JobStatus
+ owned: boolean
+ created: datetime
+ grabbed: datetime
+ finished: datetime
PluginOverview:
displayName: Plugin Overview
type: object
@@ -939,16 +956,44 @@ types:
variables:
type: VariableMapping[]
required: false
+ KPartiteNetworkConfig:
+ type: NetworkConfig
+ properties:
+ partitionsMetadata: string[]
+ NodeIdList:
+ type: object
+ additionalProperties: false
+ properties:
+ nodeIds: string[]
+ KPartiteNetworkData:
+ type: NetworkData
+ properties:
+ partitions: NodeIdList[]
+ KPartiteNetwork:
+ type: object
+ additionalProperties: false
+ properties:
+ data: KPartiteNetworkData
+ config: KPartiteNetworkConfig
+ KPartiteNetworkPostResponse:
+ type: object
+ additionalProperties: false
+ properties:
+ kpartitenetwork: KPartiteNetwork
BipartiteNetworkConfig:
type: NetworkConfig
properties:
- column1Metadata: string
- column2Metadata: string
+ partitionsMetadata:
+ type: string[]
+ minItems: 2
+ maxItems: 2
BipartiteNetworkData:
type: NetworkData
properties:
- column1NodeIDs: string[]
- column2NodeIDs: string[]
+ partitions:
+ type: NodeIdList[]
+ maxItems: 2
+ minItems: 2
BipartiteNetwork:
type: object
additionalProperties: false
diff --git a/schema/url/networks.raml b/schema/url/networks.raml
index 96ade114..f9c1f441 100644
--- a/schema/url/networks.raml
+++ b/schema/url/networks.raml
@@ -28,18 +28,48 @@ types:
type: VariableMapping[]
required: false
+ KPartiteNetworkConfig:
+ type: NetworkConfig
+ properties:
+ partitionsMetadata: string[]
+
+ NodeIdList:
+ additionalProperties: false
+ properties:
+ nodeIds: string[]
+
+ KPartiteNetworkData:
+ type: NetworkData
+ properties:
+ partitions: NodeIdList[]
+
+ KPartiteNetwork:
+ additionalProperties: false
+ properties:
+ data: KPartiteNetworkData
+ config: KPartiteNetworkConfig
+
+ KPartiteNetworkPostResponse:
+ additionalProperties: false
+ properties:
+ kpartitenetwork: KPartiteNetwork
+
+ # a specific case of a KPartiteNetwork w two partitions
BipartiteNetworkConfig:
type: NetworkConfig
properties:
- column1Metadata: string
- column2Metadata: string
+ partitionsMetadata:
+ type: string[]
+ minItems: 2
+ maxItems: 2
BipartiteNetworkData:
type: NetworkData
properties:
- column1NodeIDs: string[]
- column2NodeIDs: string[]
-
+ partitions:
+ type: NodeIdList[]
+ maxItems: 2
+ minItems: 2
BipartiteNetwork:
additionalProperties: false
diff --git a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
index a2d67ff5..ff3bf2e5 100644
--- a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
+++ b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
@@ -120,12 +120,20 @@ protected void writeResults(OutputStream out, Map dataStrea
BipartiteNetworkData bipartiteNetworkData = new BipartiteNetworkDataImpl();
bipartiteNetworkData.setLinks(links);
bipartiteNetworkData.setNodes(nodes);
- bipartiteNetworkData.setColumn1NodeIDs(uniqueColumn1IDs);
- bipartiteNetworkData.setColumn2NodeIDs(uniqueColumn2IDs);
+ NodeIdList partition1NodeIdList = new NodeIdListImpl();
+ partition1NodeIdList.setNodeIds(uniqueColumn1IDs);
+ NodeIdList partition2NodeIdList = new NodeIdListImpl();
+ partition2NodeIdList.setNodeIds(uniqueColumn2IDs);
+ List partitions = new ArrayList();
+ partitions.add(partition1NodeIdList);
+ partitions.add(partition2NodeIdList);
+ bipartiteNetworkData.setPartitions(partitions);
BipartiteNetworkConfig bipartiteNetworkConfig = new BipartiteNetworkConfigImpl();
- bipartiteNetworkConfig.setColumn1Metadata(stats.getData1Metadata());
- bipartiteNetworkConfig.setColumn2Metadata(stats.getData2Metadata());
+ List partitionsMetadata = new ArrayList();
+ partitionsMetadata.add(stats.getData1Metadata());
+ partitionsMetadata.add(stats.getData2Metadata());
+ bipartiteNetworkConfig.setPartitionsMetadata(partitionsMetadata);
BipartiteNetwork bipartiteNetwork = new BipartiteNetworkImpl();
bipartiteNetwork.setData(bipartiteNetworkData);
diff --git a/src/main/resources/api.html b/src/main/resources/api.html
index ba8c9753..08a771b1 100644
--- a/src/main/resources/api.html
+++ b/src/main/resources/api.html
@@ -1222,7 +1222,7 @@
bindFilters();
});
- Resources
post /filter-aware-metadata/continuous-variable
Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.
curl -X POST \
+ Resources
post /filter-aware-metadata/continuous-variable
Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/filter-aware-metadata/continuous-variable
Request Body chevron_right expand_more
ContinuousVariableMetadataPostRequest ContinuousVariableMetadataPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ContinuousVariableMetadataSpec
config.variable* object Inherits: object
config.variable.entityId* string config.variable.variableId* string config.metadata* array config.metadata[] string Enum:- binRanges
- median
200 OK chevron_right expand_more
ContinuousVariableMetadataPostResponse ContinuousVariableMetadataPostResponse
application/json
Inherits: object
Parameter Type Description binRanges object Inherits: object
binRanges.equalInterval* array binRanges.equalInterval[] object Inherits: lib.Range
binRanges.equalInterval[].min* string binRanges.equalInterval[].max* string binRanges.equalInterval[].label* string binRanges.quantile* array binRanges.quantile[] object Inherits: lib.Range
binRanges.quantile[].min* string binRanges.quantile[].max* string binRanges.quantile[].label* string binRanges.standardDeviation* array binRanges.standardDeviation[] object Inherits: lib.Range
binRanges.standardDeviation[].min* string binRanges.standardDeviation[].max* string binRanges.standardDeviation[].label* string median number
get /apps
200 OK chevron_right expand_more
AppsGetResponse AppsGetResponse
application/json
Additional properties: Yes
Inherits: object
Parameter Type Description apps* array apps[] object Inherits: lib.AppOverview
apps[].name* string apps[].displayName* string apps[].description* string apps[].projects* array apps[].projects[] string apps[].computeName string apps[].visualizations* array apps[].visualizations[] object Inherits: lib.VisualizationOverview
apps[].visualizations[].name* string apps[].visualizations[].displayName* string apps[].visualizations[].description* string apps[].visualizations[].projects* array apps[].visualizations[].projects[] string apps[].visualizations[].maxPanels* number apps[].visualizations[].dataElementConstraints array apps[].visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
apps[].visualizations[].dataElementConstraints[].//* object Inherits: object
apps[].visualizations[].dataElementConstraints[].//.isRequired* boolean apps[].visualizations[].dataElementConstraints[].//.isTemporal* boolean apps[].visualizations[].dataElementConstraints[].//.isCollection* boolean apps[].visualizations[].dataElementConstraints[].//.isCompositional* boolean apps[].visualizations[].dataElementConstraints[].//.isProportion* boolean apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string apps[].visualizations[].dataElementConstraints[].//.minNumVars* number apps[].visualizations[].dataElementConstraints[].//.maxNumVars* number apps[].visualizations[].dataElementConstraints[].//.minNumValues* number apps[].visualizations[].dataElementConstraints[].//.maxNumValues* number apps[].visualizations[].dataElementConstraints[].//.allowedTypes array apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
apps[].visualizations[].dataElementConstraints[].//.allowedShapes array apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
apps[].visualizations[].dataElementConstraints[].//.description* string apps[].visualizations[].dataElementDependencyOrder array apps[].visualizations[].dataElementDependencyOrder[] array apps[].visualizations[].dataElementDependencyOrder[][] string
post /apps/standalone-map/visualizations/map-markers
Returns data required to make Standalone Map markers
curl -X POST \
@@ -1339,10 +1339,10 @@
undefined/apps/differentialabundance/visualizations/volcanoplot
Request Body chevron_right expand_more
DifferentialAbundanceVolcanoplotPostRequest DifferentialAbundanceVolcanoplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
computeConfig.comparator.variable* object Inherits: object
computeConfig.comparator.variable.entityId* string computeConfig.comparator.variable.variableId* string computeConfig.comparator.groupA* array computeConfig.comparator.groupA[] object Inherits: lib.Range
computeConfig.comparator.groupA[].min* string computeConfig.comparator.groupA[].max* string computeConfig.comparator.groupA[].label* string computeConfig.comparator.groupB* array computeConfig.comparator.groupB[] object Inherits: lib.Range
computeConfig.comparator.groupB[].min* string computeConfig.comparator.groupB[].max* string computeConfig.comparator.groupB[].label* string computeConfig.differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
computeConfig.pValueFloor string config* object Inherits: lib.EmptyDataPluginSpec
200 OK chevron_right expand_more
DifferentialAbundanceStatsResponse DifferentialAbundanceStatsResponse
application/json
Additional properties: Yes
Inherits: object
Parameter Type Description effectSizeLabel* string statistics* object Additional properties: Yes
Inherits: object
statistics.effectSize* array statistics.effectSize[] string statistics.pValue* array statistics.pValue[] string statistics.adjustedPValue* array statistics.adjustedPValue[] string statistics.pointId* array statistics.pointId[] string pvalueFloor string adjustedPValueFloor string
post /apps/correlationassayassay/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
- undefined/apps/correlationassayassay/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string significanceThreshold* number correlationCoefThreshold* number
post /apps/correlationassaymetadata/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
+ undefined/apps/correlationassayassay/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: lib.NodeIdList
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string significanceThreshold* number correlationCoefThreshold* number
post /apps/correlationassaymetadata/visualizations/bipartitenetwork
Returns data required to create a bipartite network from a correlation matrix.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
- undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string significanceThreshold* number correlationCoefThreshold* number
post /apps/distributions/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
+ undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork
Request Body chevron_right expand_more
CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
200 OK chevron_right expand_more
CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse
application/json
Inherits: lib.BipartiteNetworkPostResponse
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: lib.NodeIdList
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string significanceThreshold* number correlationCoefThreshold* number
post /apps/distributions/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/distributions/visualizations/histogram
Request Body chevron_right expand_more
HistogramPostRequest HistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HistogramSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
200 OK chevron_right expand_more
HistogramPostResponse HistogramPostResponse
application/json
Inherits: object
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: lib.HistogramData
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.config* object Inherits: lib.PlotConfig
histogram.config.completeCasesAllVars* number histogram.config.completeCasesAxesVars* number histogram.config.variables* array histogram.config.variables[] object Inherits: object
histogram.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.config.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.config.variables[].variableSpec.entityId* string histogram.config.variables[].variableSpec.variableId* string histogram.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.config.variables[].displayName string histogram.config.variables[].displayRangeMin any histogram.config.variables[].displayRangeMax any histogram.config.variables[].vocabulary array histogram.config.variables[].vocabulary[] string histogram.config.variables[].imputeZero* boolean histogram.config.variables[].hasStudyDependentVocabulary boolean histogram.config.variables[].isCollection* boolean histogram.config.variables[].members array histogram.config.variables[].members[] object Inherits: lib.VariableSpec
histogram.config.variables[].members[].entityId* string histogram.config.variables[].members[].variableId* string histogram.config.binSlider* object Inherits: lib.BinSlider
histogram.config.binSlider.min* number histogram.config.binSlider.max* number histogram.config.binSlider.step* number histogram.config.binSpec* object Inherits: lib.BinSpec
histogram.config.binSpec.type string Enum:- binWidth
- numBins
histogram.config.binSpec.value number histogram.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
histogram.config.binSpec.range union histogram.config.binSpec.range anyOf Any of the following types. histogram.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
histogram.config.binSpec.range{NumberRange}..min* number histogram.config.binSpec.range{NumberRange}..max* number histogram.config.binSpec.range{DateRange} object Inherits: lib.DateRange
histogram.config.binSpec.range{DateRange}..min* string histogram.config.binSpec.range{DateRange}..max* string histogram.config.summary* object Additional properties: Yes
Inherits: object
histogram.config.summary.min* string histogram.config.summary.q1* string histogram.config.summary.median* string histogram.config.summary.mean* string histogram.config.summary.q3* string histogram.config.summary.max* string histogram.config.viewport* object Inherits: lib.NumericViewport
histogram.config.viewport.xMin* string histogram.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
post /apps/distributions/visualizations/boxplot
Returns data required to create a boxplot visualization
Java impl- NA
R impl- working
curl -X POST \
@@ -1387,7 +1387,7 @@
}
get /metrics
Prometheus metrics for the service.
curl -X GET \
undefined/metrics
200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Security Scheme header-auth
header-authAuthentication based on a WDK auth cookie.
Headers chevron_right expand_more
Parameter Type Description Auth_Key* string Authorization header.
curl -X <method> \
-H "Auth_Key: <value>" \
- /<path>
Types
Type VariableClass (string)
VariableClassEnum:- native
- derived
- computed
Inherits: string
Type PlotReferenceValue (string)
PlotReferenceValueEnum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
Type VariableMapping (object)
VariableMappingInherits: object
Model
Parameter Type Description variableClass* string Enum:- native
- derived
- computed
Inherits: string
variableSpec* object Inherits: lib.VariableSpec
variableSpec.entityId* string variableSpec.variableId* string plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
displayName string displayRangeMin any displayRangeMax any vocabulary array vocabulary[] string imputeZero* boolean hasStudyDependentVocabulary boolean isCollection* boolean members array members[] object Inherits: lib.VariableSpec
members[].entityId* string members[].variableId* string
Type API_Filter (object)
API_FilterAdditional properties: Yes
Discriminator: type
Inherits: object
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
Type API_FilterType (string)
API_FilterTypeEnum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: string
Type API_BooleanOperationType (string)
API_BooleanOperationTypeEnum:- intersect
- union
Inherits: string
Type API_MultiFilterSubFilter (object)
API_MultiFilterSubFilterAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variableId* string stringSet* array stringSet[] string
Type API_MultiFilter (object)
API_MultiFilterAdditional properties: Yes
Discriminator: type
Discriminator value: multiFilter
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
operation* string Enum:- intersect
- union
Inherits: string
variableId* string subFilters* array subFilters[] object Additional properties: Yes
Inherits: object
subFilters[].variableId* string subFilters[].stringSet* array subFilters[].stringSet[] string
Type API_StringSetFilter (object)
API_StringSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string stringSet* array stringSet[] string
Type API_NumberSetFilter (object)
API_NumberSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string numberSet* array numberSet[] number
Type API_DateSetFilter (object)
API_DateSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string dateSet* array dateSet[] string
Type API_NumberRangeFilter (object)
API_NumberRangeFilterAdditional properties: Yes
Discriminator: type
Discriminator value: numberRange
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string min* number max* number
Type API_DateRangeFilter (object)
API_DateRangeFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string min* string max* string
Type API_LongitudeRangeFilter (object)
API_LongitudeRangeFilterAdditional properties: Yes
Discriminator: type
Discriminator value: longitudeRange
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string left* number right* number
Type DerivedVariableSpec (object)
DerivedVariableSpecInherits: lib.VariableSpec
Model
Parameter Type Description entityId* string variableId* string functionName* string displayName* string config* object
Type VariableSpec (object)
VariableSpecInherits: object
Model
Parameter Type Description entityId* string variableId* string
Type CollectionSpec (object)
CollectionSpecInherits: object
Model
Parameter Type Description entityId* string collectionId* string
Type DataElementConstraint (object)
DataElementConstraintInherits: object
Model
Parameter Type Description isRequired* boolean isTemporal* boolean isCollection* boolean isCompositional* boolean isProportion* boolean allowedNormalizationMethods* array allowedNormalizationMethods[] string minNumVars* number maxNumVars* number minNumValues* number maxNumValues* number allowedTypes array allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
allowedShapes array allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
description* string
Type DataElementConstraintPattern (object)
DataElementConstraintPatternAdditional properties: Yes
Inherits: object
Model
Parameter Type Description //* object Inherits: object
//.isRequired* boolean //.isTemporal* boolean //.isCollection* boolean //.isCompositional* boolean //.isProportion* boolean //.allowedNormalizationMethods* array //.allowedNormalizationMethods[] string //.minNumVars* number //.maxNumVars* number //.minNumValues* number //.maxNumValues* number //.allowedTypes array //.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
//.allowedShapes array //.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
//.description* string
Type EntityTabularPostResponse (object)
EntityTabularPostResponseInherits: object
Model
Parameter Type Description tabular* array tabular[] array tabular[][] string
Type Range (object)
RangeInherits: object
Model
Parameter Type Description min* string max* string
Type LabeledRange (object)
LabeledRangeInherits: lib.Range
Model
Parameter Type Description min* string max* string label* string
Type API_VariableType (string)
API_VariableTypeEnum:- category
- string
- number
- date
- longitude
- integer
Inherits: string
Type API_VariableDataShape (string)
API_VariableDataShapeEnum:- continuous
- categorical
- ordinal
- binary
Inherits: string
Type API_PagingConfig (object)
API_PagingConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description numRows integer Format: int64
offset integer Format: int64
Type BinUnits (string)
BinUnitsEnum:- day
- week
- month
- year
Inherits: string
Type ValueSpec (string)
ValueSpecEnum:- count
- proportion
Inherits: string
Type AlphaDivComputeConfig (object)
AlphaDivComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
Type AlphaDivMethod (string)
AlphaDivMethodEnum:- shannon
- simpson
- evenness
Inherits: string
Type BetaDivComputeConfig (object)
BetaDivComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string betaDivDissimilarityMethod* string Enum:- bray
- jaccard
- jsd
Inherits: lib.BetaDivDissimilarityMethod
Type BetaDivDissimilarityMethod (string)
BetaDivDissimilarityMethodEnum:- bray
- jaccard
- jsd
Inherits: string
Type CorrelationComputeConfig (object)
CorrelationComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
Type CorrelationMethod (string)
CorrelationMethodEnum:- spearman
- pearson
Inherits: string
Type Correlation1Collection (object)
Correlation1CollectionAdditional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string
Type Correlation2Collections (object)
Correlation2CollectionsAdditional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
collectionVariable1* object Inherits: object
collectionVariable1.entityId* string collectionVariable1.collectionId* string collectionVariable2* object Inherits: object
collectionVariable2.entityId* string collectionVariable2.collectionId* string
Type DifferentialAbundanceComputeConfig (object)
DifferentialAbundanceComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
comparator.variable* object Inherits: object
comparator.variable.entityId* string comparator.variable.variableId* string comparator.groupA* array comparator.groupA[] object Inherits: lib.Range
comparator.groupA[].min* string comparator.groupA[].max* string comparator.groupA[].label* string comparator.groupB* array comparator.groupB[] object Inherits: lib.Range
comparator.groupB[].min* string comparator.groupB[].max* string comparator.groupB[].label* string differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
pValueFloor string
Type DifferentialAbundanceMethod (string)
DifferentialAbundanceMethodEnum:- DESeq
- ANCOMBC
- Maaslin
Inherits: string
Type ComparatorSpec (object)
ComparatorSpecAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variable* object Inherits: object
variable.entityId* string variable.variableId* string groupA* array groupA[] object Inherits: lib.Range
groupA[].min* string groupA[].max* string groupA[].label* string groupB* array groupB[] object Inherits: lib.Range
groupB[].min* string groupB[].max* string groupB[].label* string
Type DifferentialAbundanceStats (object)
DifferentialAbundanceStatsAdditional properties: Yes
Inherits: object
Model
Parameter Type Description effectSize* array effectSize[] string pValue* array pValue[] string adjustedPValue* array adjustedPValue[] string pointId* array pointId[] string
Type DifferentialAbundanceStatsResponse (object)
DifferentialAbundanceStatsResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description effectSizeLabel* string statistics* object Additional properties: Yes
Inherits: object
statistics.effectSize* array statistics.effectSize[] string statistics.pValue* array statistics.pValue[] string statistics.adjustedPValue* array statistics.adjustedPValue[] string statistics.pointId* array statistics.pointId[] string pvalueFloor string adjustedPValueFloor string
Type ExampleComputeConfig (object)
ExampleComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description inputVariable* object Inherits: object
inputVariable.entityId* string inputVariable.variableId* string valueSuffix* string
Type RankedAbundanceComputeConfig (object)
RankedAbundanceComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
Type RankingMethod (string)
RankingMethodEnum:- median
- q3
- variance
- max
Inherits: string
Type AbundanceBoxplotPostRequest (object)
AbundanceBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
config* object Inherits: lib.BoxplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AbundanceScatterplotPostRequest (object)
AbundanceScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
config* object Inherits: lib.ScatterplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AlphaDivBoxplotPostRequest (object)
AlphaDivBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
config* object Inherits: lib.BoxplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AlphaDivScatterplotPostRequest (object)
AlphaDivScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
config* object Inherits: lib.ScatterplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AppsGetResponse (object)
AppsGetResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description apps* array apps[] object Inherits: lib.AppOverview
apps[].name* string apps[].displayName* string apps[].description* string apps[].projects* array apps[].projects[] string apps[].computeName string apps[].visualizations* array apps[].visualizations[] object Inherits: lib.VisualizationOverview
apps[].visualizations[].name* string apps[].visualizations[].displayName* string apps[].visualizations[].description* string apps[].visualizations[].projects* array apps[].visualizations[].projects[] string apps[].visualizations[].maxPanels* number apps[].visualizations[].dataElementConstraints array apps[].visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
apps[].visualizations[].dataElementConstraints[].//* object Inherits: object
apps[].visualizations[].dataElementConstraints[].//.isRequired* boolean apps[].visualizations[].dataElementConstraints[].//.isTemporal* boolean apps[].visualizations[].dataElementConstraints[].//.isCollection* boolean apps[].visualizations[].dataElementConstraints[].//.isCompositional* boolean apps[].visualizations[].dataElementConstraints[].//.isProportion* boolean apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string apps[].visualizations[].dataElementConstraints[].//.minNumVars* number apps[].visualizations[].dataElementConstraints[].//.maxNumVars* number apps[].visualizations[].dataElementConstraints[].//.minNumValues* number apps[].visualizations[].dataElementConstraints[].//.maxNumValues* number apps[].visualizations[].dataElementConstraints[].//.allowedTypes array apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
apps[].visualizations[].dataElementConstraints[].//.allowedShapes array apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
apps[].visualizations[].dataElementConstraints[].//.description* string apps[].visualizations[].dataElementDependencyOrder array apps[].visualizations[].dataElementDependencyOrder[] array apps[].visualizations[].dataElementDependencyOrder[][] string
Type AppOverview (object)
AppOverviewInherits: object
Model
Parameter Type Description name* string displayName* string description* string projects* array projects[] string computeName string visualizations* array visualizations[] object Inherits: lib.VisualizationOverview
visualizations[].name* string visualizations[].displayName* string visualizations[].description* string visualizations[].projects* array visualizations[].projects[] string visualizations[].maxPanels* number visualizations[].dataElementConstraints array visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
visualizations[].dataElementConstraints[].//* object Inherits: object
visualizations[].dataElementConstraints[].//.isRequired* boolean visualizations[].dataElementConstraints[].//.isTemporal* boolean visualizations[].dataElementConstraints[].//.isCollection* boolean visualizations[].dataElementConstraints[].//.isCompositional* boolean visualizations[].dataElementConstraints[].//.isProportion* boolean visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string visualizations[].dataElementConstraints[].//.minNumVars* number visualizations[].dataElementConstraints[].//.maxNumVars* number visualizations[].dataElementConstraints[].//.minNumValues* number visualizations[].dataElementConstraints[].//.maxNumValues* number visualizations[].dataElementConstraints[].//.allowedTypes array visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
visualizations[].dataElementConstraints[].//.allowedShapes array visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
visualizations[].dataElementConstraints[].//.description* string visualizations[].dataElementDependencyOrder array visualizations[].dataElementDependencyOrder[] array visualizations[].dataElementDependencyOrder[][] string
Type VisualizationOverview (object)
VisualizationOverviewInherits: object
Model
Parameter Type Description name* string displayName* string description* string projects* array projects[] string maxPanels* number dataElementConstraints array dataElementConstraints[] object Additional properties: Yes
Inherits: object
dataElementConstraints[].//* object Inherits: object
dataElementConstraints[].//.isRequired* boolean dataElementConstraints[].//.isTemporal* boolean dataElementConstraints[].//.isCollection* boolean dataElementConstraints[].//.isCompositional* boolean dataElementConstraints[].//.isProportion* boolean dataElementConstraints[].//.allowedNormalizationMethods* array dataElementConstraints[].//.allowedNormalizationMethods[] string dataElementConstraints[].//.minNumVars* number dataElementConstraints[].//.maxNumVars* number dataElementConstraints[].//.minNumValues* number dataElementConstraints[].//.maxNumValues* number dataElementConstraints[].//.allowedTypes array dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
dataElementConstraints[].//.allowedShapes array dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
dataElementConstraints[].//.description* string dataElementDependencyOrder array dataElementDependencyOrder[] array dataElementDependencyOrder[][] string
Type BetaDivScatterplotPostRequest (object)
BetaDivScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.betaDivDissimilarityMethod* string Enum:- bray
- jaccard
- jsd
Inherits: lib.BetaDivDissimilarityMethod
config* object Inherits: lib.BetaDivScatterplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string
Type BetaDivScatterplotSpec (object)
BetaDivScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string
Type CorrelationBipartitenetworkSpec (object)
CorrelationBipartitenetworkSpecInherits: object
Model
Parameter Type Description significanceThreshold number correlationCoefThreshold number
Type CorrelationBipartiteNetworkPostResponse (object)
CorrelationBipartiteNetworkPostResponseInherits: lib.BipartiteNetworkPostResponse
Model
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string significanceThreshold* number correlationCoefThreshold* number
Type CorrelationAssayAssayBipartitenetworkPostRequest (object)
CorrelationAssayAssayBipartitenetworkPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)
CorrelationAssayMetadataBipartitenetworkPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
Type DifferentialAbundanceVolcanoplotPostRequest (object)
DifferentialAbundanceVolcanoplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
computeConfig.comparator.variable* object Inherits: object
computeConfig.comparator.variable.entityId* string computeConfig.comparator.variable.variableId* string computeConfig.comparator.groupA* array computeConfig.comparator.groupA[] object Inherits: lib.Range
computeConfig.comparator.groupA[].min* string computeConfig.comparator.groupA[].max* string computeConfig.comparator.groupA[].label* string computeConfig.comparator.groupB* array computeConfig.comparator.groupB[] object Inherits: lib.Range
computeConfig.comparator.groupB[].min* string computeConfig.comparator.groupB[].max* string computeConfig.comparator.groupB[].label* string computeConfig.differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
computeConfig.pValueFloor string config* object Inherits: lib.EmptyDataPluginSpec
Type ContinuousVariableMetadataPostRequest (object)
ContinuousVariableMetadataPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ContinuousVariableMetadataSpec
config.variable* object Inherits: object
config.variable.entityId* string config.variable.variableId* string config.metadata* array config.metadata[] string Enum:- binRanges
- median
Type ContinuousVariableMetadataSpec (object)
ContinuousVariableMetadataSpecInherits: object
Model
Parameter Type Description variable* object Inherits: object
variable.entityId* string variable.variableId* string metadata* array metadata[] string Enum:- binRanges
- median
Type AllBinRanges (object)
AllBinRangesInherits: object
Model
Parameter Type Description equalInterval* array equalInterval[] object Inherits: lib.Range
equalInterval[].min* string equalInterval[].max* string equalInterval[].label* string quantile* array quantile[] object Inherits: lib.Range
quantile[].min* string quantile[].max* string quantile[].label* string standardDeviation* array standardDeviation[] object Inherits: lib.Range
standardDeviation[].min* string standardDeviation[].max* string standardDeviation[].label* string
Type ContinuousVariableMetadataPostResponse (object)
ContinuousVariableMetadataPostResponseInherits: object
Model
Parameter Type Description binRanges object Inherits: object
binRanges.equalInterval* array binRanges.equalInterval[] object Inherits: lib.Range
binRanges.equalInterval[].min* string binRanges.equalInterval[].max* string binRanges.equalInterval[].label* string binRanges.quantile* array binRanges.quantile[] object Inherits: lib.Range
binRanges.quantile[].min* string binRanges.quantile[].max* string binRanges.quantile[].label* string binRanges.standardDeviation* array binRanges.standardDeviation[] object Inherits: lib.Range
binRanges.standardDeviation[].min* string binRanges.standardDeviation[].max* string binRanges.standardDeviation[].label* string median number
Type NodeData (object)
NodeDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description id* string
Type LinkData (object)
LinkDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description source* object Additional properties: Yes
Inherits: object
source.id* string target* object Additional properties: Yes
Inherits: object
target.id* string strokeWidth* string color* string
Type NetworkData (object)
NetworkDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description nodes* array nodes[] object Additional properties: Yes
Inherits: object
nodes[].id* string links* array links[] object Additional properties: Yes
Inherits: object
links[].source* object Additional properties: Yes
Inherits: object
links[].source.id* string links[].target* object Additional properties: Yes
Inherits: object
links[].target.id* string links[].strokeWidth* string links[].color* string
Type NetworkConfig (object)
NetworkConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variables array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type BipartiteNetworkConfig (object)
BipartiteNetworkConfigAdditional properties: Yes
Inherits: lib.NetworkConfig
Model
Parameter Type Description variables array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string column1Metadata* string column2Metadata* string
Type BipartiteNetworkData (object)
BipartiteNetworkDataAdditional properties: Yes
Inherits: lib.NetworkData
Model
Parameter Type Description nodes* array nodes[] object Additional properties: Yes
Inherits: object
nodes[].id* string links* array links[] object Additional properties: Yes
Inherits: object
links[].source* object Additional properties: Yes
Inherits: object
links[].source.id* string links[].target* object Additional properties: Yes
Inherits: object
links[].target.id* string links[].strokeWidth* string links[].color* string column1NodeIDs* array column1NodeIDs[] string column2NodeIDs* array column2NodeIDs[] string
Type BipartiteNetwork (object)
BipartiteNetworkInherits: object
Model
Parameter Type Description data* object Additional properties: Yes
Inherits: lib.NetworkData
data.nodes* array data.nodes[] object Additional properties: Yes
Inherits: object
data.nodes[].id* string data.links* array data.links[] object Additional properties: Yes
Inherits: object
data.links[].source* object Additional properties: Yes
Inherits: object
data.links[].source.id* string data.links[].target* object Additional properties: Yes
Inherits: object
data.links[].target.id* string data.links[].strokeWidth* string data.links[].color* string data.column1NodeIDs* array data.column1NodeIDs[] string data.column2NodeIDs* array data.column2NodeIDs[] string config* object Additional properties: Yes
Inherits: lib.NetworkConfig
config.variables array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.column1Metadata* string config.column2Metadata* string
Type BipartiteNetworkPostResponse (object)
BipartiteNetworkPostResponseInherits: object
Model
Parameter Type Description bipartitenetwork* object Inherits: object
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.NetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: object
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].strokeWidth* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.column1NodeIDs* array bipartitenetwork.data.column1NodeIDs[] string bipartitenetwork.data.column2NodeIDs* array bipartitenetwork.data.column2NodeIDs[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.NetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.column1Metadata* string bipartitenetwork.config.column2Metadata* string
Type BarplotPostRequest (object)
BarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.BarplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type BarplotSpec (object)
BarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Barplot (object)
BarplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.BarplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type BarplotPostResponse (object)
BarplotPostResponseInherits: object
Model
Parameter Type Description barplot* object Inherits: object
barplot.data* array barplot.data[] object Inherits: lib.BarplotData
barplot.data[].overlayVariableDetails object Inherits: object
barplot.data[].overlayVariableDetails.entityId* string barplot.data[].overlayVariableDetails.variableId* string barplot.data[].overlayVariableDetails.value* string barplot.data[].facetVariableDetails array Max. items: 2
barplot.data[].facetVariableDetails[] object Inherits: object
barplot.data[].facetVariableDetails[].entityId* string barplot.data[].facetVariableDetails[].variableId* string barplot.data[].facetVariableDetails[].value* string barplot.data[].value* array barplot.data[].value[] number barplot.data[].label* array barplot.data[].label[] string barplot.config* object Inherits: lib.PlotConfig
barplot.config.completeCasesAllVars* number barplot.config.completeCasesAxesVars* number barplot.config.variables* array barplot.config.variables[] object Inherits: object
barplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
barplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
barplot.config.variables[].variableSpec.entityId* string barplot.config.variables[].variableSpec.variableId* string barplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
barplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
barplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
barplot.config.variables[].displayName string barplot.config.variables[].displayRangeMin any barplot.config.variables[].displayRangeMax any barplot.config.variables[].vocabulary array barplot.config.variables[].vocabulary[] string barplot.config.variables[].imputeZero* boolean barplot.config.variables[].hasStudyDependentVocabulary boolean barplot.config.variables[].isCollection* boolean barplot.config.variables[].members array barplot.config.variables[].members[] object Inherits: lib.VariableSpec
barplot.config.variables[].members[].entityId* string barplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type BoxplotPostRequest (object)
BoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.BoxplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type BoxplotSpec (object)
BoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
points* string Enum:- outliers
- all
mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string maxAllowedDataPoints integer Format: int64
Type Boxplot (object)
BoxplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.BoxplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].lowerfence* array data[].lowerfence[] number data[].upperfence* array data[].upperfence[] number data[].q1* array data[].q1[] number data[].q3* array data[].q3[] number data[].median* array data[].median[] number data[].outliers array data[].outliers[] array data[].outliers[][] number data[].rawData array data[].rawData[] array data[].rawData[][] number data[].mean array data[].mean[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type BoxplotPostResponse (object)
BoxplotPostResponseInherits: object
Model
Parameter Type Description boxplot* object Inherits: object
boxplot.data* array boxplot.data[] object Inherits: lib.BoxplotData
boxplot.data[].overlayVariableDetails object Inherits: object
boxplot.data[].overlayVariableDetails.entityId* string boxplot.data[].overlayVariableDetails.variableId* string boxplot.data[].overlayVariableDetails.value* string boxplot.data[].facetVariableDetails array Max. items: 2
boxplot.data[].facetVariableDetails[] object Inherits: object
boxplot.data[].facetVariableDetails[].entityId* string boxplot.data[].facetVariableDetails[].variableId* string boxplot.data[].facetVariableDetails[].value* string boxplot.data[].lowerfence* array boxplot.data[].lowerfence[] number boxplot.data[].upperfence* array boxplot.data[].upperfence[] number boxplot.data[].q1* array boxplot.data[].q1[] number boxplot.data[].q3* array boxplot.data[].q3[] number boxplot.data[].median* array boxplot.data[].median[] number boxplot.data[].outliers array boxplot.data[].outliers[] array boxplot.data[].outliers[][] number boxplot.data[].rawData array boxplot.data[].rawData[] array boxplot.data[].rawData[][] number boxplot.data[].mean array boxplot.data[].mean[] number boxplot.data[].label* array boxplot.data[].label[] string boxplot.config* object Inherits: lib.PlotConfig
boxplot.config.completeCasesAllVars* number boxplot.config.completeCasesAxesVars* number boxplot.config.variables* array boxplot.config.variables[] object Inherits: object
boxplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
boxplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
boxplot.config.variables[].variableSpec.entityId* string boxplot.config.variables[].variableSpec.variableId* string boxplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
boxplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
boxplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
boxplot.config.variables[].displayName string boxplot.config.variables[].displayRangeMin any boxplot.config.variables[].displayRangeMax any boxplot.config.variables[].vocabulary array boxplot.config.variables[].vocabulary[] string boxplot.config.variables[].imputeZero* boolean boxplot.config.variables[].hasStudyDependentVocabulary boolean boxplot.config.variables[].isCollection* boolean boxplot.config.variables[].members array boxplot.config.variables[].members[] object Inherits: lib.VariableSpec
boxplot.config.variables[].members[].entityId* string boxplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number statsTable array statsTable[] object Inherits: lib.BoxplotStatsTable
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].xVariableDetails object Inherits: object
statsTable[].xVariableDetails.entityId* string statsTable[].xVariableDetails.variableId* string statsTable[].xVariableDetails.value* string statsTable[].statistic* string statsTable[].pvalue* number statsTable[].parameter* array statsTable[].parameter[] number statsTable[].method* string statsTable[].statsError* string
Type ContTableStatsTable (object)
ContTableStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string pvalue* array pvalue[] number degreesFreedom* array degreesFreedom[] number chisq* array chisq[] number
Type ContTablePostResponse (object)
ContTablePostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: lib.Mosaic
mosaic.data* array mosaic.data[] object Inherits: lib.MosaicData
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.config* object Inherits: lib.PlotConfig
mosaic.config.completeCasesAllVars* number mosaic.config.completeCasesAxesVars* number mosaic.config.variables* array mosaic.config.variables[] object Inherits: object
mosaic.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.config.variables[].variableSpec.entityId* string mosaic.config.variables[].variableSpec.variableId* string mosaic.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.config.variables[].displayName string mosaic.config.variables[].displayRangeMin any mosaic.config.variables[].displayRangeMax any mosaic.config.variables[].vocabulary array mosaic.config.variables[].vocabulary[] string mosaic.config.variables[].imputeZero* boolean mosaic.config.variables[].hasStudyDependentVocabulary boolean mosaic.config.variables[].isCollection* boolean mosaic.config.variables[].members array mosaic.config.variables[].members[] object Inherits: lib.VariableSpec
mosaic.config.variables[].members[].entityId* string mosaic.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].pvalue* array statsTable[].pvalue[] number statsTable[].degreesFreedom* array statsTable[].degreesFreedom[] number statsTable[].chisq* array statsTable[].chisq[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type DensityplotPostRequest (object)
DensityplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.DensityplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type DensityplotSpec (object)
DensityplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Densityplot (object)
DensityplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.DensityplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].densityY* array data[].densityY[] number data[].densityX* array data[].densityX[] number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type DensityplotPostResponse (object)
DensityplotPostResponseInherits: object
Model
Parameter Type Description densityplot* object Inherits: object
densityplot.data* array densityplot.data[] object Inherits: lib.DensityplotData
densityplot.data[].overlayVariableDetails object Inherits: object
densityplot.data[].overlayVariableDetails.entityId* string densityplot.data[].overlayVariableDetails.variableId* string densityplot.data[].overlayVariableDetails.value* string densityplot.data[].facetVariableDetails array Max. items: 2
densityplot.data[].facetVariableDetails[] object Inherits: object
densityplot.data[].facetVariableDetails[].entityId* string densityplot.data[].facetVariableDetails[].variableId* string densityplot.data[].facetVariableDetails[].value* string densityplot.data[].densityY* array densityplot.data[].densityY[] number densityplot.data[].densityX* array densityplot.data[].densityX[] number densityplot.config* object Inherits: lib.PlotConfig
densityplot.config.completeCasesAllVars* number densityplot.config.completeCasesAxesVars* number densityplot.config.variables* array densityplot.config.variables[] object Inherits: object
densityplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
densityplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
densityplot.config.variables[].variableSpec.entityId* string densityplot.config.variables[].variableSpec.variableId* string densityplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
densityplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
densityplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
densityplot.config.variables[].displayName string densityplot.config.variables[].displayRangeMin any densityplot.config.variables[].displayRangeMax any densityplot.config.variables[].vocabulary array densityplot.config.variables[].vocabulary[] string densityplot.config.variables[].imputeZero* boolean densityplot.config.variables[].hasStudyDependentVocabulary boolean densityplot.config.variables[].isCollection* boolean densityplot.config.variables[].members array densityplot.config.variables[].members[] object Inherits: lib.VariableSpec
densityplot.config.variables[].members[].entityId* string densityplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type HeatmapPostRequest (object)
HeatmapPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HeatmapSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- collection
- series
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.zAxisVariable object Inherits: object
config.zAxisVariable.entityId* string config.zAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type HeatmapSpec (object)
HeatmapSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
valueSpec* string Enum:- collection
- series
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string zAxisVariable object Inherits: object
zAxisVariable.entityId* string zAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Heatmap (object)
HeatmapInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.HeatmapData
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] array data[].value[][] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type HeatmapPostResponse (object)
HeatmapPostResponseInherits: object
Model
Parameter Type Description heatmap* object Inherits: object
heatmap.data* array heatmap.data[] object Inherits: lib.HeatmapData
heatmap.data[].facetVariableDetails array Max. items: 2
heatmap.data[].facetVariableDetails[] object Inherits: object
heatmap.data[].facetVariableDetails[].entityId* string heatmap.data[].facetVariableDetails[].variableId* string heatmap.data[].facetVariableDetails[].value* string heatmap.data[].value* array heatmap.data[].value[] array heatmap.data[].value[][] number heatmap.data[].label* array heatmap.data[].label[] string heatmap.config* object Inherits: lib.PlotConfig
heatmap.config.completeCasesAllVars* number heatmap.config.completeCasesAxesVars* number heatmap.config.variables* array heatmap.config.variables[] object Inherits: object
heatmap.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
heatmap.config.variables[].variableSpec* object Inherits: lib.VariableSpec
heatmap.config.variables[].variableSpec.entityId* string heatmap.config.variables[].variableSpec.variableId* string heatmap.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
heatmap.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
heatmap.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
heatmap.config.variables[].displayName string heatmap.config.variables[].displayRangeMin any heatmap.config.variables[].displayRangeMax any heatmap.config.variables[].vocabulary array heatmap.config.variables[].vocabulary[] string heatmap.config.variables[].imputeZero* boolean heatmap.config.variables[].hasStudyDependentVocabulary boolean heatmap.config.variables[].isCollection* boolean heatmap.config.variables[].members array heatmap.config.variables[].members[] object Inherits: lib.VariableSpec
heatmap.config.variables[].members[].entityId* string heatmap.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type HistogramPostRequest (object)
HistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HistogramSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type HistogramSpec (object)
HistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type HistogramSummary (object)
HistogramSummaryAdditional properties: Yes
Inherits: object
Model
Parameter Type Description min* string q1* string median* string mean* string q3* string max* string
Type HistogramConfig (object)
HistogramConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string binSlider* object Inherits: lib.BinSlider
binSlider.min* number binSlider.max* number binSlider.step* number binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string summary* object Additional properties: Yes
Inherits: object
summary.min* string summary.q1* string summary.median* string summary.mean* string summary.q3* string summary.max* string viewport* object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type Histogram (object)
HistogramInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.HistogramData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].binStart* array data[].binStart[] string data[].binEnd* array data[].binEnd[] string data[].binLabel* array data[].binLabel[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.binSlider* object Inherits: lib.BinSlider
config.binSlider.min* number config.binSlider.max* number config.binSlider.step* number config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.summary* object Additional properties: Yes
Inherits: object
config.summary.min* string config.summary.q1* string config.summary.median* string config.summary.mean* string config.summary.q3* string config.summary.max* string config.viewport* object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type HistogramPostResponse (object)
HistogramPostResponseInherits: object
Model
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: lib.HistogramData
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.config* object Inherits: lib.PlotConfig
histogram.config.completeCasesAllVars* number histogram.config.completeCasesAxesVars* number histogram.config.variables* array histogram.config.variables[] object Inherits: object
histogram.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.config.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.config.variables[].variableSpec.entityId* string histogram.config.variables[].variableSpec.variableId* string histogram.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.config.variables[].displayName string histogram.config.variables[].displayRangeMin any histogram.config.variables[].displayRangeMax any histogram.config.variables[].vocabulary array histogram.config.variables[].vocabulary[] string histogram.config.variables[].imputeZero* boolean histogram.config.variables[].hasStudyDependentVocabulary boolean histogram.config.variables[].isCollection* boolean histogram.config.variables[].members array histogram.config.variables[].members[] object Inherits: lib.VariableSpec
histogram.config.variables[].members[].entityId* string histogram.config.variables[].members[].variableId* string histogram.config.binSlider* object Inherits: lib.BinSlider
histogram.config.binSlider.min* number histogram.config.binSlider.max* number histogram.config.binSlider.step* number histogram.config.binSpec* object Inherits: lib.BinSpec
histogram.config.binSpec.type string Enum:- binWidth
- numBins
histogram.config.binSpec.value number histogram.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
histogram.config.binSpec.range union histogram.config.binSpec.range anyOf Any of the following types. histogram.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
histogram.config.binSpec.range{NumberRange}..min* number histogram.config.binSpec.range{NumberRange}..max* number histogram.config.binSpec.range{DateRange} object Inherits: lib.DateRange
histogram.config.binSpec.range{DateRange}..min* string histogram.config.binSpec.range{DateRange}..max* string histogram.config.summary* object Additional properties: Yes
Inherits: object
histogram.config.summary.min* string histogram.config.summary.q1* string histogram.config.summary.median* string histogram.config.summary.mean* string histogram.config.summary.q3* string histogram.config.summary.max* string histogram.config.viewport* object Inherits: lib.NumericViewport
histogram.config.viewport.xMin* string histogram.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type LineplotPostRequest (object)
LineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.LineplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type LineplotSpec (object)
LineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type LineplotConfig (object)
LineplotConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string binSlider object Inherits: lib.BinSlider
binSlider.min* number binSlider.max* number binSlider.step* number binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type Lineplot (object)
LineplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.LineplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].binStart array data[].binStart[] string data[].binEnd array data[].binEnd[] string data[].binSampleSize array data[].binSampleSize[] union Inherits: lib.SampleSize
data[].binSampleSize[] anyOf Any of the following types. data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
data[].binSampleSize[]{SimpleSampleSize}..N* number data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number data[].errorBars array data[].errorBars[] object Inherits: lib.ErrorBar
data[].errorBars[].lowerBound* number data[].errorBars[].upperBound* number data[].errorBars[].error* string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.binSlider object Inherits: lib.BinSlider
config.binSlider.min* number config.binSlider.max* number config.binSlider.step* number config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type LineplotPostResponse (object)
LineplotPostResponseInherits: object
Model
Parameter Type Description lineplot* object Inherits: object
lineplot.data* array lineplot.data[] object Inherits: lib.LineplotData
lineplot.data[].overlayVariableDetails object Inherits: object
lineplot.data[].overlayVariableDetails.entityId* string lineplot.data[].overlayVariableDetails.variableId* string lineplot.data[].overlayVariableDetails.value* string lineplot.data[].facetVariableDetails array Max. items: 2
lineplot.data[].facetVariableDetails[] object Inherits: object
lineplot.data[].facetVariableDetails[].entityId* string lineplot.data[].facetVariableDetails[].variableId* string lineplot.data[].facetVariableDetails[].value* string lineplot.data[].seriesY* array lineplot.data[].seriesY[] string lineplot.data[].seriesX* array lineplot.data[].seriesX[] string lineplot.data[].binStart array lineplot.data[].binStart[] string lineplot.data[].binEnd array lineplot.data[].binEnd[] string lineplot.data[].binSampleSize array lineplot.data[].binSampleSize[] union Inherits: lib.SampleSize
lineplot.data[].binSampleSize[] anyOf Any of the following types. lineplot.data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* number lineplot.data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number lineplot.data[].errorBars array lineplot.data[].errorBars[] object Inherits: lib.ErrorBar
lineplot.data[].errorBars[].lowerBound* number lineplot.data[].errorBars[].upperBound* number lineplot.data[].errorBars[].error* string lineplot.config* object Inherits: lib.PlotConfig
lineplot.config.completeCasesAllVars* number lineplot.config.completeCasesAxesVars* number lineplot.config.variables* array lineplot.config.variables[] object Inherits: object
lineplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
lineplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
lineplot.config.variables[].variableSpec.entityId* string lineplot.config.variables[].variableSpec.variableId* string lineplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
lineplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
lineplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
lineplot.config.variables[].displayName string lineplot.config.variables[].displayRangeMin any lineplot.config.variables[].displayRangeMax any lineplot.config.variables[].vocabulary array lineplot.config.variables[].vocabulary[] string lineplot.config.variables[].imputeZero* boolean lineplot.config.variables[].hasStudyDependentVocabulary boolean lineplot.config.variables[].isCollection* boolean lineplot.config.variables[].members array lineplot.config.variables[].members[] object Inherits: lib.VariableSpec
lineplot.config.variables[].members[].entityId* string lineplot.config.variables[].members[].variableId* string lineplot.config.binSlider object Inherits: lib.BinSlider
lineplot.config.binSlider.min* number lineplot.config.binSlider.max* number lineplot.config.binSlider.step* number lineplot.config.binSpec object Inherits: lib.BinSpec
lineplot.config.binSpec.type string Enum:- binWidth
- numBins
lineplot.config.binSpec.value number lineplot.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
lineplot.config.binSpec.range union lineplot.config.binSpec.range anyOf Any of the following types. lineplot.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
lineplot.config.binSpec.range{NumberRange}..min* number lineplot.config.binSpec.range{NumberRange}..max* number lineplot.config.binSpec.range{DateRange} object Inherits: lib.DateRange
lineplot.config.binSpec.range{DateRange}..min* string lineplot.config.binSpec.range{DateRange}..max* string lineplot.config.viewport object Inherits: lib.NumericViewport
lineplot.config.viewport.xMin* string lineplot.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type MapMarkersOverlayPostRequest (object)
MapMarkersOverlayPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MapMarkersOverlaySpec
config.outputEntityId* string config.showMissingness string Enum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingness
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.longitudeVariable object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapMarkersOverlaySpec (object)
MapMarkersOverlaySpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingness
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string valueSpec* string Enum:- count
- proportion
Inherits: string
longitudeVariable object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapMarkersOverlayConfig (object)
MapMarkersOverlayConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapMarkersOverlay (object)
MapMarkersOverlayInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.MapMarkersOverlayData
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapMarkersOverlayPostResponse (object)
MapMarkersOverlayPostResponseInherits: object
Model
Parameter Type Description mapMarkers* object Inherits: object
mapMarkers.data* array mapMarkers.data[] object Inherits: lib.MapMarkersOverlayData
mapMarkers.data[].facetVariableDetails array Max. items: 2
mapMarkers.data[].facetVariableDetails[] object Inherits: object
mapMarkers.data[].facetVariableDetails[].entityId* string mapMarkers.data[].facetVariableDetails[].variableId* string mapMarkers.data[].facetVariableDetails[].value* string mapMarkers.data[].value* array mapMarkers.data[].value[] number mapMarkers.data[].label* array mapMarkers.data[].label[] string mapMarkers.config* object Inherits: lib.PlotConfig
mapMarkers.config.completeCasesAllVars* number mapMarkers.config.completeCasesAxesVars* number mapMarkers.config.variables* array mapMarkers.config.variables[] object Inherits: object
mapMarkers.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mapMarkers.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mapMarkers.config.variables[].variableSpec.entityId* string mapMarkers.config.variables[].variableSpec.variableId* string mapMarkers.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mapMarkers.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mapMarkers.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mapMarkers.config.variables[].displayName string mapMarkers.config.variables[].displayRangeMin any mapMarkers.config.variables[].displayRangeMax any mapMarkers.config.variables[].vocabulary array mapMarkers.config.variables[].vocabulary[] string mapMarkers.config.variables[].imputeZero* boolean mapMarkers.config.variables[].hasStudyDependentVocabulary boolean mapMarkers.config.variables[].isCollection* boolean mapMarkers.config.variables[].members array mapMarkers.config.variables[].members[] object Inherits: lib.VariableSpec
mapMarkers.config.variables[].members[].entityId* string mapMarkers.config.variables[].members[].variableId* string mapMarkers.config.viewport* object Inherits: lib.GeolocationViewport
mapMarkers.config.viewport.latitude* object Inherits: lib.NumericViewport
mapMarkers.config.viewport.latitude.xMin* string mapMarkers.config.viewport.latitude.xMax* string mapMarkers.config.viewport.longitude* object Inherits: lib.LongitudeViewport
mapMarkers.config.viewport.longitude.left* number mapMarkers.config.viewport.longitude.right* number sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type MapPostRequest (object)
MapPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MapSpec
config.outputEntityId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapSpec (object)
MapSpecInherits: object
Model
Parameter Type Description outputEntityId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapConfig (object)
MapConfigInherits: object
Model
Parameter Type Description completeCasesGeoVar* number
Type MapPostResponse (object)
MapPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.MapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number config* object Inherits: object
config.completeCasesGeoVar* number
Type MapElementInfo (object)
MapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type ScatterplotPostRequest (object)
ScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ScatterplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type ScatterplotSpec (object)
ScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string maxAllowedDataPoints integer Format: int64
Type Scatterplot (object)
ScatterplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.ScatterplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].smoothedMeanX array data[].smoothedMeanX[] string data[].smoothedMeanY array data[].smoothedMeanY[] number data[].smoothedMeanSE array data[].smoothedMeanSE[] number data[].smoothedMeanError string data[].bestFitLineX array data[].bestFitLineX[] string data[].bestFitLineY array data[].bestFitLineY[] number data[].r2 number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type ScatterplotPostResponse (object)
ScatterplotPostResponseInherits: object
Model
Parameter Type Description scatterplot* object Inherits: object
scatterplot.data* array scatterplot.data[] object Inherits: lib.ScatterplotData
scatterplot.data[].overlayVariableDetails object Inherits: object
scatterplot.data[].overlayVariableDetails.entityId* string scatterplot.data[].overlayVariableDetails.variableId* string scatterplot.data[].overlayVariableDetails.value* string scatterplot.data[].facetVariableDetails array Max. items: 2
scatterplot.data[].facetVariableDetails[] object Inherits: object
scatterplot.data[].facetVariableDetails[].entityId* string scatterplot.data[].facetVariableDetails[].variableId* string scatterplot.data[].facetVariableDetails[].value* string scatterplot.data[].seriesY* array scatterplot.data[].seriesY[] string scatterplot.data[].seriesX* array scatterplot.data[].seriesX[] string scatterplot.data[].smoothedMeanX array scatterplot.data[].smoothedMeanX[] string scatterplot.data[].smoothedMeanY array scatterplot.data[].smoothedMeanY[] number scatterplot.data[].smoothedMeanSE array scatterplot.data[].smoothedMeanSE[] number scatterplot.data[].smoothedMeanError string scatterplot.data[].bestFitLineX array scatterplot.data[].bestFitLineX[] string scatterplot.data[].bestFitLineY array scatterplot.data[].bestFitLineY[] number scatterplot.data[].r2 number scatterplot.config* object Inherits: lib.PlotConfig
scatterplot.config.completeCasesAllVars* number scatterplot.config.completeCasesAxesVars* number scatterplot.config.variables* array scatterplot.config.variables[] object Inherits: object
scatterplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
scatterplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
scatterplot.config.variables[].variableSpec.entityId* string scatterplot.config.variables[].variableSpec.variableId* string scatterplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
scatterplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
scatterplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
scatterplot.config.variables[].displayName string scatterplot.config.variables[].displayRangeMin any scatterplot.config.variables[].displayRangeMax any scatterplot.config.variables[].vocabulary array scatterplot.config.variables[].vocabulary[] string scatterplot.config.variables[].imputeZero* boolean scatterplot.config.variables[].hasStudyDependentVocabulary boolean scatterplot.config.variables[].isCollection* boolean scatterplot.config.variables[].members array scatterplot.config.variables[].members[] object Inherits: lib.VariableSpec
scatterplot.config.variables[].members[].entityId* string scatterplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type TablePostRequest (object)
TablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.TableSpec
config.outputEntityId* string config.outputVariable* array config.outputVariable[] object Inherits: object
config.outputVariable[].entityId* string config.outputVariable[].variableId* string config.pagingConfig* object Additional properties: Yes
Inherits: object
config.pagingConfig.numRows integer Format: int64
config.pagingConfig.offset integer Format: int64
Type TableSpec (object)
TableSpecInherits: object
Model
Parameter Type Description outputEntityId* string outputVariable* array outputVariable[] object Inherits: object
outputVariable[].entityId* string outputVariable[].variableId* string pagingConfig* object Additional properties: Yes
Inherits: object
pagingConfig.numRows integer Format: int64
pagingConfig.offset integer Format: int64
Type TablePostResponse (object)
TablePostResponseInherits: object
Model
Parameter Type Description columns* array columns[] object Inherits: object
columns[].entityId* string columns[].variableId* string rows* array rows[] array rows[][] string
Type TwoByTwoSpec (object)
TwoByTwoSpecInherits: lib.MosaicSpec
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string xAxisReferenceValue* string yAxisReferenceValue* string
Type TwoByTwoPostRequest (object)
TwoByTwoPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MosaicSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.xAxisReferenceValue* string config.yAxisReferenceValue* string
Type Statistic (object)
StatisticInherits: object
Model
Parameter Type Description value* number confidenceInterval string confidenceLevel number pvalue* string
Type TwoByTwoStatsTable (object)
TwoByTwoStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string chisq* object Inherits: object
chisq.value* number chisq.confidenceInterval string chisq.confidenceLevel number chisq.pvalue* string fisher* object Inherits: object
fisher.value* number fisher.confidenceInterval string fisher.confidenceLevel number fisher.pvalue* string prevalence object Inherits: object
prevalence.value* number prevalence.confidenceInterval string prevalence.confidenceLevel number prevalence.pvalue* string oddsratio object Inherits: object
oddsratio.value* number oddsratio.confidenceInterval string oddsratio.confidenceLevel number oddsratio.pvalue* string relativerisk object Inherits: object
relativerisk.value* number relativerisk.confidenceInterval string relativerisk.confidenceLevel number relativerisk.pvalue* string sensitivity object Inherits: object
sensitivity.value* number sensitivity.confidenceInterval string sensitivity.confidenceLevel number sensitivity.pvalue* string specificity object Inherits: object
specificity.value* number specificity.confidenceInterval string specificity.confidenceLevel number specificity.pvalue* string posPredictiveValue object Inherits: object
posPredictiveValue.value* number posPredictiveValue.confidenceInterval string posPredictiveValue.confidenceLevel number posPredictiveValue.pvalue* string negPredictiveValue object Inherits: object
negPredictiveValue.value* number negPredictiveValue.confidenceInterval string negPredictiveValue.confidenceLevel number negPredictiveValue.pvalue* string
Type TwoByTwoPostResponse (object)
TwoByTwoPostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: lib.Mosaic
mosaic.data* array mosaic.data[] object Inherits: lib.MosaicData
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.config* object Inherits: lib.PlotConfig
mosaic.config.completeCasesAllVars* number mosaic.config.completeCasesAxesVars* number mosaic.config.variables* array mosaic.config.variables[] object Inherits: object
mosaic.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.config.variables[].variableSpec.entityId* string mosaic.config.variables[].variableSpec.variableId* string mosaic.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.config.variables[].displayName string mosaic.config.variables[].displayRangeMin any mosaic.config.variables[].displayRangeMax any mosaic.config.variables[].vocabulary array mosaic.config.variables[].vocabulary[] string mosaic.config.variables[].imputeZero* boolean mosaic.config.variables[].hasStudyDependentVocabulary boolean mosaic.config.variables[].isCollection* boolean mosaic.config.variables[].members array mosaic.config.variables[].members[] object Inherits: lib.VariableSpec
mosaic.config.variables[].members[].entityId* string mosaic.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].chisq* object Inherits: object
statsTable[].chisq.value* number statsTable[].chisq.confidenceInterval string statsTable[].chisq.confidenceLevel number statsTable[].chisq.pvalue* string statsTable[].fisher* object Inherits: object
statsTable[].fisher.value* number statsTable[].fisher.confidenceInterval string statsTable[].fisher.confidenceLevel number statsTable[].fisher.pvalue* string statsTable[].prevalence object Inherits: object
statsTable[].prevalence.value* number statsTable[].prevalence.confidenceInterval string statsTable[].prevalence.confidenceLevel number statsTable[].prevalence.pvalue* string statsTable[].oddsratio object Inherits: object
statsTable[].oddsratio.value* number statsTable[].oddsratio.confidenceInterval string statsTable[].oddsratio.confidenceLevel number statsTable[].oddsratio.pvalue* string statsTable[].relativerisk object Inherits: object
statsTable[].relativerisk.value* number statsTable[].relativerisk.confidenceInterval string statsTable[].relativerisk.confidenceLevel number statsTable[].relativerisk.pvalue* string statsTable[].sensitivity object Inherits: object
statsTable[].sensitivity.value* number statsTable[].sensitivity.confidenceInterval string statsTable[].sensitivity.confidenceLevel number statsTable[].sensitivity.pvalue* string statsTable[].specificity object Inherits: object
statsTable[].specificity.value* number statsTable[].specificity.confidenceInterval string statsTable[].specificity.confidenceLevel number statsTable[].specificity.pvalue* string statsTable[].posPredictiveValue object Inherits: object
statsTable[].posPredictiveValue.value* number statsTable[].posPredictiveValue.confidenceInterval string statsTable[].posPredictiveValue.confidenceLevel number statsTable[].posPredictiveValue.pvalue* string statsTable[].negPredictiveValue object Inherits: object
statsTable[].negPredictiveValue.value* number statsTable[].negPredictiveValue.confidenceInterval string statsTable[].negPredictiveValue.confidenceLevel number statsTable[].negPredictiveValue.pvalue* string completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type BarplotData (object)
BarplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number label* array label[] string
Type MapMarkersOverlayData (object)
MapMarkersOverlayDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number label* array label[] string
Type BoxplotData (object)
BoxplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string lowerfence* array lowerfence[] number upperfence* array upperfence[] number q1* array q1[] number q3* array q3[] number median* array median[] number outliers array outliers[] array outliers[][] number rawData array rawData[] array rawData[][] number mean array mean[] number label* array label[] string
Type BoxplotStatsTable (object)
BoxplotStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string xVariableDetails object Inherits: object
xVariableDetails.entityId* string xVariableDetails.variableId* string xVariableDetails.value* string statistic* string pvalue* number parameter* array parameter[] number method* string statsError* string
Type HistogramData (object)
HistogramDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number binStart* array binStart[] string binEnd* array binEnd[] string binLabel* array binLabel[] string
Type BinSlider (object)
BinSliderInherits: object
Model
Parameter Type Description min* number max* number step* number
Type HeatmapData (object)
HeatmapDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] array value[][] number label* array label[] string
Type MosaicPostRequest (object)
MosaicPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MosaicSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type MosaicSpec (object)
MosaicSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type MosaicData (object)
MosaicDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string xLabel* array xLabel[] string yLabel* array yLabel[] array yLabel[][] string value* array value[] array value[][] number
Type Mosaic (object)
MosaicInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].xLabel* array data[].xLabel[] string data[].yLabel* array data[].yLabel[] array data[].yLabel[][] string data[].value* array data[].value[] array data[].value[][] number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type ScatterplotData (object)
ScatterplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string seriesY* array seriesY[] string seriesX* array seriesX[] string smoothedMeanX array smoothedMeanX[] string smoothedMeanY array smoothedMeanY[] number smoothedMeanSE array smoothedMeanSE[] number smoothedMeanError string bestFitLineX array bestFitLineX[] string bestFitLineY array bestFitLineY[] number r2 number
Type DensityplotData (object)
DensityplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string densityY* array densityY[] number densityX* array densityX[] number
Type LineplotData (object)
LineplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string seriesY* array seriesY[] string seriesX* array seriesX[] string binStart array binStart[] string binEnd array binEnd[] string binSampleSize array binSampleSize[] union Inherits: lib.SampleSize
binSampleSize[] anyOf Any of the following types. binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
binSampleSize[]{SimpleSampleSize}..N* number binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
binSampleSize[]{ProportionSampleSize}..numeratorN* number binSampleSize[]{ProportionSampleSize}..denominatorN* number errorBars array errorBars[] object Inherits: lib.ErrorBar
errorBars[].lowerBound* number errorBars[].upperBound* number errorBars[].error* string
Type PlotConfig (object)
PlotConfigInherits: object
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type SampleSizeTable (object)
SampleSizeTableInherits: object
Model
Parameter Type Description xVariableDetails array xVariableDetails[] object Inherits: object
xVariableDetails[].entityId* string xVariableDetails[].variableId* string xVariableDetails[].value* string overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string size* array size[] number
Type VariableCompleteCases (object)
VariableCompleteCasesInherits: object
Model
Parameter Type Description variableDetails* object Inherits: object
variableDetails.entityId* string variableDetails.variableId* string completeCases* number
Type CategoricalDistributionPostRequest (object)
CategoricalDistributionPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: object
config.entityId* string config.variableId* string
Type CategoricalDistributionBin (object)
CategoricalDistributionBinAdditional properties: Yes
Inherits: object
Model
Parameter Type Description label* string value* number
Type CategoricalDistributionPostResponse (object)
CategoricalDistributionPostResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description countDistribution* array countDistribution[] object Additional properties: Yes
Inherits: object
countDistribution[].label* string countDistribution[].value* number proportionDistribution* array proportionDistribution[] object Additional properties: Yes
Inherits: object
proportionDistribution[].label* string proportionDistribution[].value* number
Type ExampleComputeVizPostRequest (object)
ExampleComputeVizPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ExampleComputeVizSpec
config.prefixVar* object Inherits: object
config.prefixVar.entityId* string config.prefixVar.variableId* string computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.inputVariable* object Inherits: object
computeConfig.inputVariable.entityId* string computeConfig.inputVariable.variableId* string computeConfig.valueSuffix* string
Type ExampleComputeVizSpec (object)
ExampleComputeVizSpecInherits: object
Model
Parameter Type Description prefixVar* object Inherits: object
prefixVar.entityId* string prefixVar.variableId* string
Type ExampleComputeVizPostResponse (object)
ExampleComputeVizPostResponseInherits: object
Model
Parameter Type Description countPluginResult* integer numEmptyValues* integer longestConcatenatedValue* string avgConcatenatedLength* number
Type MultiStreamPostRequest (object)
MultiStreamPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MultiStreamSpec
config.entityId* string
Type MultiStreamSpec (object)
MultiStreamSpecInherits: object
Model
Parameter Type Description entityId* string
Type RecordCountPostRequest (object)
RecordCountPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.RecordCountSpec
config.entityId* string
Type RecordCountSpec (object)
RecordCountSpecInherits: object
Model
Parameter Type Description entityId* string
Type RecordCountPostResponse (object)
RecordCountPostResponseInherits: object
Model
Parameter Type Description recordCount* integer
Type TestCollectionsPostRequest (object)
TestCollectionsPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: object
config.entityId* string config.collectionId* string
Type CollectionFloatingBarplotPostRequest (object)
CollectionFloatingBarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingBarplotSpec
config.outputEntityId* string config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.overlayConfig.selectedValues array config.overlayConfig.selectedValues[] string
Type CollectionFloatingBarplotSpec (object)
CollectionFloatingBarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string overlayConfig.selectedValues array overlayConfig.selectedValues[] string
Type CollectionFloatingBoxplotPostRequest (object)
CollectionFloatingBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingBoxplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type CollectionFloatingBoxplotSpec (object)
CollectionFloatingBoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string maxAllowedDataPoints integer Format: int64
Type CollectionFloatingContTablePostRequest (object)
CollectionFloatingContTablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingContTableSpec
config.outputEntityId* string config.xAxisVariable* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.xAxisVariable.collection* object Inherits: object
config.xAxisVariable.collection.entityId* string config.xAxisVariable.collection.collectionId* string config.xAxisVariable.selectedMembers* array config.xAxisVariable.selectedMembers[] object Inherits: object
config.xAxisVariable.selectedMembers[].entityId* string config.xAxisVariable.selectedMembers[].variableId* string config.xAxisVariable.selectedValues array config.xAxisVariable.selectedValues[] string
Type CollectionFloatingContTableSpec (object)
CollectionFloatingContTableSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
xAxisVariable.collection* object Inherits: object
xAxisVariable.collection.entityId* string xAxisVariable.collection.collectionId* string xAxisVariable.selectedMembers* array xAxisVariable.selectedMembers[] object Inherits: object
xAxisVariable.selectedMembers[].entityId* string xAxisVariable.selectedMembers[].variableId* string xAxisVariable.selectedValues array xAxisVariable.selectedValues[] string
Type CollectionFloatingHistogramPostRequest (object)
CollectionFloatingHistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingHistogramSpec
config.outputEntityId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.binSpec* object Inherits: lib.BinWidthSpec
config.binSpec.type string Enum:- binWidth
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type CollectionFloatingHistogramSpec (object)
CollectionFloatingHistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string binSpec* object Inherits: lib.BinWidthSpec
binSpec.type string Enum:- binWidth
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type CollectionFloatingLineplotPostRequest (object)
CollectionFloatingLineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingLineplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.overlayConfig.selectedValues array config.overlayConfig.selectedValues[] string config.binSpec object Inherits: lib.BinWidthSpec
config.binSpec.type string Enum:- binWidth
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type CollectionFloatingLineplotSpec (object)
CollectionFloatingLineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string overlayConfig.selectedValues array overlayConfig.selectedValues[] string binSpec object Inherits: lib.BinWidthSpec
binSpec.type string Enum:- binWidth
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type StandaloneCollectionMapMarkerPostRequest (object)
StandaloneCollectionMapMarkerPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Specification for a map marker
Inherits: lib.StandaloneCollectionMapMarkerSpec
config.outputEntityId* string Entity ID associated with collection variable of interest.
config.geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number config.collection* object Collection variable to use for markers.
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.collection.collection* object Inherits: object
config.collection.collection.entityId* string config.collection.collection.collectionId* string config.collection.selectedMembers* array config.collection.selectedMembers[] object Inherits: object
config.collection.selectedMembers[].entityId* string config.collection.selectedMembers[].variableId* string config.aggregatorConfig* object Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.
Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.aggregatorConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type StandaloneCollectionMapMarkerSpec (object)
StandaloneCollectionMapMarkerSpecSpecification for a map marker
Inherits: object
Model
Parameter Type Description outputEntityId* string Entity ID associated with collection variable of interest.
geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number collection* object Collection variable to use for markers.
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
collection.collection* object Inherits: object
collection.collection.entityId* string collection.collection.collectionId* string collection.selectedMembers* array collection.selectedMembers[] object Inherits: object
collection.selectedMembers[].entityId* string collection.selectedMembers[].variableId* string aggregatorConfig* object Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.
Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
aggregatorConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type CollectionOverlayConfig (object)
CollectionOverlayConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collection* object Inherits: object
collection.entityId* string collection.collectionId* string selectedMembers* array selectedMembers[] object Inherits: object
selectedMembers[].entityId* string selectedMembers[].variableId* string
Type CollectionMapMarkerElement (object)
CollectionMapMarkerElementData needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
Model
Parameter Type Description entityCount* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number values* array values[] object Additional properties: Yes
Inherits: lib.CollectionMemberAggregate
values[].variableId* string values[].value* number values[].confidenceInterval* object Inherits: lib.NumberRange
values[].confidenceInterval.min* number values[].confidenceInterval.max* number values[].n* number
Type CollectionMemberAggregate (object)
CollectionMemberAggregateAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variableId* string value* number confidenceInterval* object Inherits: lib.NumberRange
confidenceInterval.min* number confidenceInterval.max* number n* number
Type StandaloneCollectionMapMarkerPostResponse (object)
StandaloneCollectionMapMarkerPostResponseInherits: object
Model
Parameter Type Description markers* array markers[] object Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
markers[].entityCount* number markers[].avgLat* number markers[].avgLon* number markers[].minLat* number markers[].minLon* number markers[].maxLat* number markers[].maxLon* number markers[].values* array markers[].values[] object Additional properties: Yes
Inherits: lib.CollectionMemberAggregate
markers[].values[].variableId* string markers[].values[].value* number markers[].values[].confidenceInterval* object Inherits: lib.NumberRange
markers[].values[].confidenceInterval.min* number markers[].values[].confidenceInterval.max* number markers[].values[].n* number
Type FloatingBarplotPostRequest (object)
FloatingBarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingBarplotSpec
config.outputEntityId* string config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string
Type FloatingBarplotSpec (object)
FloatingBarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string
Type FloatingBarplot (object)
FloatingBarplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingBarplotPostResponse (object)
FloatingBarplotPostResponseInherits: object
Model
Parameter Type Description barplot* object Inherits: object
barplot.data* array barplot.data[] object Inherits: object
barplot.data[].overlayVariableDetails object Inherits: object
barplot.data[].overlayVariableDetails.entityId* string barplot.data[].overlayVariableDetails.variableId* string barplot.data[].overlayVariableDetails.value* string barplot.data[].facetVariableDetails array Max. items: 2
barplot.data[].facetVariableDetails[] object Inherits: object
barplot.data[].facetVariableDetails[].entityId* string barplot.data[].facetVariableDetails[].variableId* string barplot.data[].facetVariableDetails[].value* string barplot.data[].value* array barplot.data[].value[] number barplot.data[].label* array barplot.data[].label[] string barplot.variables* array barplot.variables[] object Inherits: object
barplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
barplot.variables[].variableSpec* object Inherits: lib.VariableSpec
barplot.variables[].variableSpec.entityId* string barplot.variables[].variableSpec.variableId* string barplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
barplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
barplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
barplot.variables[].displayName string barplot.variables[].displayRangeMin any barplot.variables[].displayRangeMax any barplot.variables[].vocabulary array barplot.variables[].vocabulary[] string barplot.variables[].imputeZero* boolean barplot.variables[].hasStudyDependentVocabulary boolean barplot.variables[].isCollection* boolean barplot.variables[].members array barplot.variables[].members[] object Inherits: lib.VariableSpec
barplot.variables[].members[].entityId* string barplot.variables[].members[].variableId* string
Type FloatingBoxplotPostRequest (object)
FloatingBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingBoxplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.maxAllowedDataPoints integer Format: int64
Type FloatingBoxplotSpec (object)
FloatingBoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string maxAllowedDataPoints integer Format: int64
Type FloatingBoxplot (object)
FloatingBoxplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].lowerfence* array data[].lowerfence[] number data[].upperfence* array data[].upperfence[] number data[].q1* array data[].q1[] number data[].q3* array data[].q3[] number data[].median* array data[].median[] number data[].outliers array data[].outliers[] array data[].outliers[][] number data[].rawData array data[].rawData[] array data[].rawData[][] number data[].mean array data[].mean[] number data[].label* array data[].label[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingBoxplotPostResponse (object)
FloatingBoxplotPostResponseInherits: object
Model
Parameter Type Description boxplot* object Inherits: object
boxplot.data* array boxplot.data[] object Inherits: object
boxplot.data[].overlayVariableDetails object Inherits: object
boxplot.data[].overlayVariableDetails.entityId* string boxplot.data[].overlayVariableDetails.variableId* string boxplot.data[].overlayVariableDetails.value* string boxplot.data[].facetVariableDetails array Max. items: 2
boxplot.data[].facetVariableDetails[] object Inherits: object
boxplot.data[].facetVariableDetails[].entityId* string boxplot.data[].facetVariableDetails[].variableId* string boxplot.data[].facetVariableDetails[].value* string boxplot.data[].lowerfence* array boxplot.data[].lowerfence[] number boxplot.data[].upperfence* array boxplot.data[].upperfence[] number boxplot.data[].q1* array boxplot.data[].q1[] number boxplot.data[].q3* array boxplot.data[].q3[] number boxplot.data[].median* array boxplot.data[].median[] number boxplot.data[].outliers array boxplot.data[].outliers[] array boxplot.data[].outliers[][] number boxplot.data[].rawData array boxplot.data[].rawData[] array boxplot.data[].rawData[][] number boxplot.data[].mean array boxplot.data[].mean[] number boxplot.data[].label* array boxplot.data[].label[] string boxplot.variables* array boxplot.variables[] object Inherits: object
boxplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
boxplot.variables[].variableSpec* object Inherits: lib.VariableSpec
boxplot.variables[].variableSpec.entityId* string boxplot.variables[].variableSpec.variableId* string boxplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
boxplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
boxplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
boxplot.variables[].displayName string boxplot.variables[].displayRangeMin any boxplot.variables[].displayRangeMax any boxplot.variables[].vocabulary array boxplot.variables[].vocabulary[] string boxplot.variables[].imputeZero* boolean boxplot.variables[].hasStudyDependentVocabulary boolean boxplot.variables[].isCollection* boolean boxplot.variables[].members array boxplot.variables[].members[] object Inherits: lib.VariableSpec
boxplot.variables[].members[].entityId* string boxplot.variables[].members[].variableId* string
Type FloatingContTablePostRequest (object)
FloatingContTablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingContTableSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string
Type FloatingContTableSpec (object)
FloatingContTableSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string
Type FloatingContTable (object)
FloatingContTableInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].xLabel* array data[].xLabel[] string data[].yLabel* array data[].yLabel[] array data[].yLabel[][] string data[].value* array data[].value[] array data[].value[][] number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingContTablePostResponse (object)
FloatingContTablePostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: object
mosaic.data* array mosaic.data[] object Inherits: object
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.variables* array mosaic.variables[] object Inherits: object
mosaic.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.variables[].variableSpec.entityId* string mosaic.variables[].variableSpec.variableId* string mosaic.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.variables[].displayName string mosaic.variables[].displayRangeMin any mosaic.variables[].displayRangeMax any mosaic.variables[].vocabulary array mosaic.variables[].vocabulary[] string mosaic.variables[].imputeZero* boolean mosaic.variables[].hasStudyDependentVocabulary boolean mosaic.variables[].isCollection* boolean mosaic.variables[].members array mosaic.variables[].members[] object Inherits: lib.VariableSpec
mosaic.variables[].members[].entityId* string mosaic.variables[].members[].variableId* string statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].chisq* object Inherits: object
statsTable[].chisq.value* number statsTable[].chisq.confidenceInterval string statsTable[].chisq.confidenceLevel number statsTable[].chisq.pvalue* string statsTable[].fisher* object Inherits: object
statsTable[].fisher.value* number statsTable[].fisher.confidenceInterval string statsTable[].fisher.confidenceLevel number statsTable[].fisher.pvalue* string statsTable[].prevalence object Inherits: object
statsTable[].prevalence.value* number statsTable[].prevalence.confidenceInterval string statsTable[].prevalence.confidenceLevel number statsTable[].prevalence.pvalue* string statsTable[].oddsratio object Inherits: object
statsTable[].oddsratio.value* number statsTable[].oddsratio.confidenceInterval string statsTable[].oddsratio.confidenceLevel number statsTable[].oddsratio.pvalue* string statsTable[].relativerisk object Inherits: object
statsTable[].relativerisk.value* number statsTable[].relativerisk.confidenceInterval string statsTable[].relativerisk.confidenceLevel number statsTable[].relativerisk.pvalue* string statsTable[].sensitivity object Inherits: object
statsTable[].sensitivity.value* number statsTable[].sensitivity.confidenceInterval string statsTable[].sensitivity.confidenceLevel number statsTable[].sensitivity.pvalue* string statsTable[].specificity object Inherits: object
statsTable[].specificity.value* number statsTable[].specificity.confidenceInterval string statsTable[].specificity.confidenceLevel number statsTable[].specificity.pvalue* string statsTable[].posPredictiveValue object Inherits: object
statsTable[].posPredictiveValue.value* number statsTable[].posPredictiveValue.confidenceInterval string statsTable[].posPredictiveValue.confidenceLevel number statsTable[].posPredictiveValue.pvalue* string statsTable[].negPredictiveValue object Inherits: object
statsTable[].negPredictiveValue.value* number statsTable[].negPredictiveValue.confidenceInterval string statsTable[].negPredictiveValue.confidenceLevel number statsTable[].negPredictiveValue.pvalue* string
Type FloatingHistogramPostRequest (object)
FloatingHistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingHistogramSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type FloatingHistogramSpec (object)
FloatingHistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type FloatingHistogram (object)
FloatingHistogramInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].binStart* array data[].binStart[] string data[].binEnd* array data[].binEnd[] string data[].binLabel* array data[].binLabel[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingHistogramPostResponse (object)
FloatingHistogramPostResponseInherits: object
Model
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: object
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.variables* array histogram.variables[] object Inherits: object
histogram.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.variables[].variableSpec.entityId* string histogram.variables[].variableSpec.variableId* string histogram.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.variables[].displayName string histogram.variables[].displayRangeMin any histogram.variables[].displayRangeMax any histogram.variables[].vocabulary array histogram.variables[].vocabulary[] string histogram.variables[].imputeZero* boolean histogram.variables[].hasStudyDependentVocabulary boolean histogram.variables[].isCollection* boolean histogram.variables[].members array histogram.variables[].members[] object Inherits: lib.VariableSpec
histogram.variables[].members[].entityId* string histogram.variables[].members[].variableId* string
Type FloatingLineplotPostRequest (object)
FloatingLineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingLineplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type FloatingLineplotSpec (object)
FloatingLineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type FloatingLineplot (object)
FloatingLineplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].binStart array data[].binStart[] string data[].binEnd array data[].binEnd[] string data[].binSampleSize array data[].binSampleSize[] union Inherits: lib.SampleSize
data[].binSampleSize[] anyOf Any of the following types. data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
data[].binSampleSize[]{SimpleSampleSize}..N* number data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number data[].errorBars array data[].errorBars[] object Inherits: lib.ErrorBar
data[].errorBars[].lowerBound* number data[].errorBars[].upperBound* number data[].errorBars[].error* string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingLineplotPostResponse (object)
FloatingLineplotPostResponseInherits: object
Model
Parameter Type Description lineplot* object Inherits: object
lineplot.data* array lineplot.data[] object Inherits: object
lineplot.data[].overlayVariableDetails object Inherits: object
lineplot.data[].overlayVariableDetails.entityId* string lineplot.data[].overlayVariableDetails.variableId* string lineplot.data[].overlayVariableDetails.value* string lineplot.data[].facetVariableDetails array Max. items: 2
lineplot.data[].facetVariableDetails[] object Inherits: object
lineplot.data[].facetVariableDetails[].entityId* string lineplot.data[].facetVariableDetails[].variableId* string lineplot.data[].facetVariableDetails[].value* string lineplot.data[].seriesY* array lineplot.data[].seriesY[] string lineplot.data[].seriesX* array lineplot.data[].seriesX[] string lineplot.data[].binStart array lineplot.data[].binStart[] string lineplot.data[].binEnd array lineplot.data[].binEnd[] string lineplot.data[].binSampleSize array lineplot.data[].binSampleSize[] union Inherits: lib.SampleSize
lineplot.data[].binSampleSize[] anyOf Any of the following types. lineplot.data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* number lineplot.data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number lineplot.data[].errorBars array lineplot.data[].errorBars[] object Inherits: lib.ErrorBar
lineplot.data[].errorBars[].lowerBound* number lineplot.data[].errorBars[].upperBound* number lineplot.data[].errorBars[].error* string lineplot.variables* array lineplot.variables[] object Inherits: object
lineplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
lineplot.variables[].variableSpec* object Inherits: lib.VariableSpec
lineplot.variables[].variableSpec.entityId* string lineplot.variables[].variableSpec.variableId* string lineplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
lineplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
lineplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
lineplot.variables[].displayName string lineplot.variables[].displayRangeMin any lineplot.variables[].displayRangeMax any lineplot.variables[].vocabulary array lineplot.variables[].vocabulary[] string lineplot.variables[].imputeZero* boolean lineplot.variables[].hasStudyDependentVocabulary boolean lineplot.variables[].isCollection* boolean lineplot.variables[].members array lineplot.variables[].members[] object Inherits: lib.VariableSpec
lineplot.variables[].members[].entityId* string lineplot.variables[].members[].variableId* string
Type FloatingScatterplotPostRequest (object)
FloatingScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingScatterplotSpec
config.outputEntityId* string config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.maxAllowedDataPoints integer Format: int64
Type FloatingScatterplotSpec (object)
FloatingScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string maxAllowedDataPoints integer Format: int64
Type FloatingScatterplot (object)
FloatingScatterplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].smoothedMeanX array data[].smoothedMeanX[] string data[].smoothedMeanY array data[].smoothedMeanY[] number data[].smoothedMeanSE array data[].smoothedMeanSE[] number data[].smoothedMeanError string data[].bestFitLineX array data[].bestFitLineX[] string data[].bestFitLineY array data[].bestFitLineY[] number data[].r2 number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingScatterplotPostResponse (object)
FloatingScatterplotPostResponseInherits: object
Model
Parameter Type Description scatterplot* object Inherits: object
scatterplot.data* array scatterplot.data[] object Inherits: object
scatterplot.data[].overlayVariableDetails object Inherits: object
scatterplot.data[].overlayVariableDetails.entityId* string scatterplot.data[].overlayVariableDetails.variableId* string scatterplot.data[].overlayVariableDetails.value* string scatterplot.data[].facetVariableDetails array Max. items: 2
scatterplot.data[].facetVariableDetails[] object Inherits: object
scatterplot.data[].facetVariableDetails[].entityId* string scatterplot.data[].facetVariableDetails[].variableId* string scatterplot.data[].facetVariableDetails[].value* string scatterplot.data[].seriesY* array scatterplot.data[].seriesY[] string scatterplot.data[].seriesX* array scatterplot.data[].seriesX[] string scatterplot.data[].smoothedMeanX array scatterplot.data[].smoothedMeanX[] string scatterplot.data[].smoothedMeanY array scatterplot.data[].smoothedMeanY[] number scatterplot.data[].smoothedMeanSE array scatterplot.data[].smoothedMeanSE[] number scatterplot.data[].smoothedMeanError string scatterplot.data[].bestFitLineX array scatterplot.data[].bestFitLineX[] string scatterplot.data[].bestFitLineY array scatterplot.data[].bestFitLineY[] number scatterplot.data[].r2 number scatterplot.variables* array scatterplot.variables[] object Inherits: object
scatterplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
scatterplot.variables[].variableSpec* object Inherits: lib.VariableSpec
scatterplot.variables[].variableSpec.entityId* string scatterplot.variables[].variableSpec.variableId* string scatterplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
scatterplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
scatterplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
scatterplot.variables[].displayName string scatterplot.variables[].displayRangeMin any scatterplot.variables[].displayRangeMax any scatterplot.variables[].vocabulary array scatterplot.variables[].vocabulary[] string scatterplot.variables[].imputeZero* boolean scatterplot.variables[].hasStudyDependentVocabulary boolean scatterplot.variables[].isCollection* boolean scatterplot.variables[].members array scatterplot.variables[].members[] object Inherits: lib.VariableSpec
scatterplot.variables[].members[].entityId* string scatterplot.variables[].members[].variableId* string
Type StandaloneMapBubblesLegendPostRequest (object)
StandaloneMapBubblesLegendPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.StandaloneMapBubblesLegendSpec
config.outputEntityId* string config.colorLegendConfig* object Inherits: lib.OverlayLegendConfig
config.colorLegendConfig.geoAggregateVariable* object Inherits: object
config.colorLegendConfig.geoAggregateVariable.entityId* string config.colorLegendConfig.geoAggregateVariable.variableId* string config.colorLegendConfig.quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* object Inherits: object
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* string config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* string config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.sizeConfig* object Inherits: lib.SizeLegendConfig
config.sizeConfig.geoAggregateVariable* object Inherits: object
config.sizeConfig.geoAggregateVariable.entityId* string config.sizeConfig.geoAggregateVariable.variableId* string
Type StandaloneMapBubblesLegendSpec (object)
StandaloneMapBubblesLegendSpecInherits: object
Model
Parameter Type Description outputEntityId* string colorLegendConfig* object Inherits: lib.OverlayLegendConfig
colorLegendConfig.geoAggregateVariable* object Inherits: object
colorLegendConfig.geoAggregateVariable.entityId* string colorLegendConfig.geoAggregateVariable.variableId* string colorLegendConfig.quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
colorLegendConfig.quantitativeOverlayConfig.overlayVariable* object Inherits: object
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* string colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* string colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
sizeConfig* object Inherits: lib.SizeLegendConfig
sizeConfig.geoAggregateVariable* object Inherits: object
sizeConfig.geoAggregateVariable.entityId* string sizeConfig.geoAggregateVariable.variableId* string
Type OverlayLegendConfig (object)
OverlayLegendConfigInherits: object
Model
Parameter Type Description geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
quantitativeOverlayConfig.overlayVariable* object Inherits: object
quantitativeOverlayConfig.overlayVariable.entityId* string quantitativeOverlayConfig.overlayVariable.variableId* string quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type SizeLegendConfig (object)
SizeLegendConfigInherits: object
Model
Parameter Type Description geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string
Type StandaloneMapBubblesLegendPostResponse (object)
StandaloneMapBubblesLegendPostResponseInherits: object
Model
Parameter Type Description minColorValue* string maxColorValue* string minSizeValue* number maxSizeValue* number
Type StandaloneMapBubblesPostRequest (object)
StandaloneMapBubblesPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Specification for map bubbles.
Inherits: lib.StandaloneMapBubblesSpec
config.outputEntityId* string Entity whose cardinality will be reported per marker.
config.geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.overlayConfig object Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.
Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.overlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.overlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type StandaloneMapBubblesSpec (object)
StandaloneMapBubblesSpecSpecification for map bubbles.
Inherits: object
Model
Parameter Type Description outputEntityId* string Entity whose cardinality will be reported per marker.
geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string overlayConfig object Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.
Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string overlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
overlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
valueSpec* string Enum:- count
- proportion
Inherits: string
viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type StandaloneMapBubblesPostResponse (object)
StandaloneMapBubblesPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.ColoredMapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].overlayValue* string mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number
Type ColoredMapElementInfo (object)
ColoredMapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number overlayValue* string avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type StandaloneMapMarkersPostRequest (object)
StandaloneMapMarkersPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.StandaloneMapMarkersSpec
config.outputEntityId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type StandaloneMapMarkersSpec (object)
StandaloneMapMarkersSpecInherits: object
Model
Parameter Type Description outputEntityId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string valueSpec* string Enum:- count
- proportion
Inherits: string
viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type StandaloneMapMarkersPostResponse (object)
StandaloneMapMarkersPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.StandaloneMapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].overlayValues* array mapElements[].overlayValues[] object Inherits: lib.LegacyLabeledRangeWithCountAndValue
mapElements[].overlayValues[].binStart* string mapElements[].overlayValues[].binEnd* string mapElements[].overlayValues[].binLabel* string mapElements[].overlayValues[].value* number mapElements[].overlayValues[].count* number mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number
Type OverlayType (string)
OverlayTypeEnum:- continuous
- categorical
Inherits: string
Type OverlayConfig (object)
OverlayConfigDiscriminator: overlayType
Inherits: object
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string
Type ContinousOverlayConfig (object)
ContinousOverlayConfigModel
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string overlayValues* array overlayValues[] object Inherits: lib.LegacyLabeledRange
overlayValues[].binStart* string overlayValues[].binEnd* string overlayValues[].binLabel* string
Type CategoricalOverlayConfig (object)
CategoricalOverlayConfigModel
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string overlayValues* array overlayValues[] string
Type StandaloneMapElementInfo (object)
StandaloneMapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number overlayValues* array overlayValues[] object Inherits: lib.LegacyLabeledRangeWithCountAndValue
overlayValues[].binStart* string overlayValues[].binEnd* string overlayValues[].binLabel* string overlayValues[].value* number overlayValues[].count* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type DataPluginRequestBase (object)
DataPluginRequestBaseInherits: object
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
Type EmptyDataPluginSpec (object)
EmptyDataPluginSpecInherits: object
Model
Parameter Type Description
Type StringBoolean (string)
StringBooleanEnum:- TRUE
- FALSE
Inherits: string
Type StrataVariableDetails (object)
StrataVariableDetailsInherits: lib.VariableSpec
Model
Parameter Type Description entityId* string variableId* string value* string
Type BinSpec (object)
BinSpecInherits: object
Model
Parameter Type Description type string Enum:- binWidth
- numBins
value number units string Enum:- day
- week
- month
- year
Inherits: string
range union range anyOf Any of the following types. range{NumberRange} object Inherits: lib.NumberRange
range{NumberRange}..min* number range{NumberRange}..max* number range{DateRange} object Inherits: lib.DateRange
range{DateRange}..min* string range{DateRange}..max* string
Type BinWidthSpec (object)
BinWidthSpecInherits: object
Model
Parameter Type Description type string Enum:- binWidth
value number units string Enum:- day
- week
- month
- year
Inherits: string
range union range anyOf Any of the following types. range{NumberRange} object Inherits: lib.NumberRange
range{NumberRange}..min* number range{NumberRange}..max* number range{DateRange} object Inherits: lib.DateRange
range{DateRange}..min* string range{DateRange}..max* string
Type NumberRange (object)
NumberRangeInherits: object
Model
Parameter Type Description min* number max* number
Type DateRange (object)
DateRangeInherits: object
Model
Parameter Type Description min* string max* string
Type NumericViewport (object)
NumericViewportInherits: object
Model
Parameter Type Description xMin* string xMax* string
Type LongitudeViewport (object)
LongitudeViewportInherits: object
Model
Parameter Type Description left* number right* number
Type GeolocationViewport (object)
GeolocationViewportInherits: object
Model
Parameter Type Description latitude* object Inherits: object
latitude.xMin* string latitude.xMax* string longitude* object Inherits: object
longitude.left* number longitude.right* number
Type ErrorBar (object)
ErrorBarInherits: object
Model
Parameter Type Description lowerBound* number upperBound* number error* string
Type SimpleSampleSize (object)
SimpleSampleSizeInherits: object
Model
Parameter Type Description N* number
Type ProportionSampleSize (object)
ProportionSampleSizeInherits: object
Model
Parameter Type Description numeratorN* number denominatorN* number
Type SampleSize (union)
SampleSizeInherits: lib.SimpleSampleSize | lib.ProportionSampleSize
Model
Parameter Type Description anyOf Any of the following types. {SimpleSampleSize} object Inherits: object
{SimpleSampleSize}.N* number {ProportionSampleSize} object Inherits: object
{ProportionSampleSize}.numeratorN* number {ProportionSampleSize}.denominatorN* number
Type ShowMissingness (string)
ShowMissingnessEnum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type ShowMissingnessNoAxes (string)
ShowMissingnessNoAxesEnum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type BoxplotWith1ComputeSpec (object)
BoxplotWith1ComputeSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
points* string Enum:- outliers
- all
mean* string Enum:- TRUE
- FALSE
Inherits: string
computeStats* string Enum:- TRUE
- FALSE
Inherits: string
xAxisVariable object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type ScatterplotWith1ComputeSpec (object)
ScatterplotWith1ComputeSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Aggregator (string)
AggregatorEnum:- mean
- median
Inherits: string
Type QuantitativeOverlayConfig (object)
QuantitativeOverlayConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: string
Type QuantitativeAggregationConfig (object)
QuantitativeAggregationConfigDiscriminator: overlayType
Inherits: object
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
Type ContinuousAggregationConfig (object)
ContinuousAggregationConfigDiscriminator: overlayType
Discriminator value: continuous
Inherits: lib.QuantitativeAggregationConfig
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
aggregator* string Enum:- mean
- median
Inherits: string
Type CategoricalAggregationConfig (object)
CategoricalAggregationConfigDiscriminator: overlayType
Discriminator value: categorical
Inherits: lib.QuantitativeAggregationConfig
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
numeratorValues* array numeratorValues[] string denominatorValues* array denominatorValues[] string
Type CollectionOverlayConfigWithValues (object)
CollectionOverlayConfigWithValuesAdditional properties: Yes
Inherits: lib.CollectionOverlayConfig
Model
Parameter Type Description collection* object Inherits: object
collection.entityId* string collection.collectionId* string selectedMembers* array selectedMembers[] object Inherits: object
selectedMembers[].entityId* string selectedMembers[].variableId* string selectedValues array selectedValues[] string
Type LegacyLabeledRange (object)
LegacyLabeledRangeInherits: object
Model
Parameter Type Description binStart* string binEnd* string binLabel* string
Type LegacyLabeledRangeWithCountAndValue (object)
LegacyLabeledRangeWithCountAndValueInherits: lib.LegacyLabeledRange
Model
Parameter Type Description binStart* string binEnd* string binLabel* string value* number count* number
Type Error (object)
ErrorDiscriminator: status
Inherits: object
Model
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: error.ErrorType
message* string
Type ErrorType (string)
ErrorTypeEnum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: string
Type BadRequestError (object)
Bad RequestRequest could not be parsed or was otherwise unusable.
Discriminator: status
Discriminator value: bad-request
Inherits: error.Error
Model
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: error.ErrorType
message* string
Examples
{
+ /<path>
Types
Type VariableClass (string)
VariableClassEnum:- native
- derived
- computed
Inherits: string
Type PlotReferenceValue (string)
PlotReferenceValueEnum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
Type VariableMapping (object)
VariableMappingInherits: object
Model
Parameter Type Description variableClass* string Enum:- native
- derived
- computed
Inherits: string
variableSpec* object Inherits: lib.VariableSpec
variableSpec.entityId* string variableSpec.variableId* string plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
displayName string displayRangeMin any displayRangeMax any vocabulary array vocabulary[] string imputeZero* boolean hasStudyDependentVocabulary boolean isCollection* boolean members array members[] object Inherits: lib.VariableSpec
members[].entityId* string members[].variableId* string
Type API_Filter (object)
API_FilterAdditional properties: Yes
Discriminator: type
Inherits: object
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
Type API_FilterType (string)
API_FilterTypeEnum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: string
Type API_BooleanOperationType (string)
API_BooleanOperationTypeEnum:- intersect
- union
Inherits: string
Type API_MultiFilterSubFilter (object)
API_MultiFilterSubFilterAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variableId* string stringSet* array stringSet[] string
Type API_MultiFilter (object)
API_MultiFilterAdditional properties: Yes
Discriminator: type
Discriminator value: multiFilter
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
operation* string Enum:- intersect
- union
Inherits: string
variableId* string subFilters* array subFilters[] object Additional properties: Yes
Inherits: object
subFilters[].variableId* string subFilters[].stringSet* array subFilters[].stringSet[] string
Type API_StringSetFilter (object)
API_StringSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string stringSet* array stringSet[] string
Type API_NumberSetFilter (object)
API_NumberSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string numberSet* array numberSet[] number
Type API_DateSetFilter (object)
API_DateSetFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string dateSet* array dateSet[] string
Type API_NumberRangeFilter (object)
API_NumberRangeFilterAdditional properties: Yes
Discriminator: type
Discriminator value: numberRange
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string min* number max* number
Type API_DateRangeFilter (object)
API_DateRangeFilterModel
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string min* string max* string
Type API_LongitudeRangeFilter (object)
API_LongitudeRangeFilterAdditional properties: Yes
Discriminator: type
Discriminator value: longitudeRange
Inherits: lib.API_Filter
Model
Parameter Type Description entityId* string type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
variableId* string left* number right* number
Type DerivedVariableSpec (object)
DerivedVariableSpecInherits: lib.VariableSpec
Model
Parameter Type Description entityId* string variableId* string functionName* string displayName* string config* object
Type VariableSpec (object)
VariableSpecInherits: object
Model
Parameter Type Description entityId* string variableId* string
Type CollectionSpec (object)
CollectionSpecInherits: object
Model
Parameter Type Description entityId* string collectionId* string
Type DataElementConstraint (object)
DataElementConstraintInherits: object
Model
Parameter Type Description isRequired* boolean isTemporal* boolean isCollection* boolean isCompositional* boolean isProportion* boolean allowedNormalizationMethods* array allowedNormalizationMethods[] string minNumVars* number maxNumVars* number minNumValues* number maxNumValues* number allowedTypes array allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
allowedShapes array allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
description* string
Type DataElementConstraintPattern (object)
DataElementConstraintPatternAdditional properties: Yes
Inherits: object
Model
Parameter Type Description //* object Inherits: object
//.isRequired* boolean //.isTemporal* boolean //.isCollection* boolean //.isCompositional* boolean //.isProportion* boolean //.allowedNormalizationMethods* array //.allowedNormalizationMethods[] string //.minNumVars* number //.maxNumVars* number //.minNumValues* number //.maxNumValues* number //.allowedTypes array //.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
//.allowedShapes array //.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
//.description* string
Type EntityTabularPostResponse (object)
EntityTabularPostResponseInherits: object
Model
Parameter Type Description tabular* array tabular[] array tabular[][] string
Type Range (object)
RangeInherits: object
Model
Parameter Type Description min* string max* string
Type LabeledRange (object)
LabeledRangeInherits: lib.Range
Model
Parameter Type Description min* string max* string label* string
Type API_VariableType (string)
API_VariableTypeEnum:- category
- string
- number
- date
- longitude
- integer
Inherits: string
Type API_VariableDataShape (string)
API_VariableDataShapeEnum:- continuous
- categorical
- ordinal
- binary
Inherits: string
Type API_PagingConfig (object)
API_PagingConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description numRows integer Format: int64
offset integer Format: int64
Type BinUnits (string)
BinUnitsEnum:- day
- week
- month
- year
Inherits: string
Type ValueSpec (string)
ValueSpecEnum:- count
- proportion
Inherits: string
Type AlphaDivComputeConfig (object)
AlphaDivComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
Type AlphaDivMethod (string)
AlphaDivMethodEnum:- shannon
- simpson
- evenness
Inherits: string
Type BetaDivComputeConfig (object)
BetaDivComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string betaDivDissimilarityMethod* string Enum:- bray
- jaccard
- jsd
Inherits: lib.BetaDivDissimilarityMethod
Type BetaDivDissimilarityMethod (string)
BetaDivDissimilarityMethodEnum:- bray
- jaccard
- jsd
Inherits: string
Type FeaturePrefilterThresholds (object)
FeaturePrefilterThresholdsInherits: object
Model
Parameter Type Description proportionNonZero number variance number standardDeviation number
Type CorrelationComputeConfig (object)
CorrelationComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
prefilterThresholds object Inherits: object
prefilterThresholds.proportionNonZero number prefilterThresholds.variance number prefilterThresholds.standardDeviation number
Type CorrelationMethod (string)
CorrelationMethodEnum:- spearman
- pearson
Inherits: string
Type Correlation1Collection (object)
Correlation1CollectionAdditional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
prefilterThresholds object Inherits: object
prefilterThresholds.proportionNonZero number prefilterThresholds.variance number prefilterThresholds.standardDeviation number collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string
Type Correlation2Collections (object)
Correlation2CollectionsAdditional properties: Yes
Inherits: lib.CorrelationComputeConfig
Model
Parameter Type Description correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
prefilterThresholds object Inherits: object
prefilterThresholds.proportionNonZero number prefilterThresholds.variance number prefilterThresholds.standardDeviation number collectionVariable1* object Inherits: object
collectionVariable1.entityId* string collectionVariable1.collectionId* string collectionVariable2* object Inherits: object
collectionVariable2.entityId* string collectionVariable2.collectionId* string
Type DifferentialAbundanceComputeConfig (object)
DifferentialAbundanceComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
comparator.variable* object Inherits: object
comparator.variable.entityId* string comparator.variable.variableId* string comparator.groupA* array comparator.groupA[] object Inherits: lib.Range
comparator.groupA[].min* string comparator.groupA[].max* string comparator.groupA[].label* string comparator.groupB* array comparator.groupB[] object Inherits: lib.Range
comparator.groupB[].min* string comparator.groupB[].max* string comparator.groupB[].label* string differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
pValueFloor string
Type DifferentialAbundanceMethod (string)
DifferentialAbundanceMethodEnum:- DESeq
- ANCOMBC
- Maaslin
Inherits: string
Type ComparatorSpec (object)
ComparatorSpecAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variable* object Inherits: object
variable.entityId* string variable.variableId* string groupA* array groupA[] object Inherits: lib.Range
groupA[].min* string groupA[].max* string groupA[].label* string groupB* array groupB[] object Inherits: lib.Range
groupB[].min* string groupB[].max* string groupB[].label* string
Type DifferentialAbundanceStats (object)
DifferentialAbundanceStatsAdditional properties: Yes
Inherits: object
Model
Parameter Type Description effectSize* array effectSize[] string pValue* array pValue[] string adjustedPValue* array adjustedPValue[] string pointId* array pointId[] string
Type DifferentialAbundanceStatsResponse (object)
DifferentialAbundanceStatsResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description effectSizeLabel* string statistics* object Additional properties: Yes
Inherits: object
statistics.effectSize* array statistics.effectSize[] string statistics.pValue* array statistics.pValue[] string statistics.adjustedPValue* array statistics.adjustedPValue[] string statistics.pointId* array statistics.pointId[] string pvalueFloor string adjustedPValueFloor string
Type ExampleComputeConfig (object)
ExampleComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description inputVariable* object Inherits: object
inputVariable.entityId* string inputVariable.variableId* string valueSuffix* string
Type RankedAbundanceComputeConfig (object)
RankedAbundanceComputeConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collectionVariable* object Inherits: object
collectionVariable.entityId* string collectionVariable.collectionId* string rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
Type RankingMethod (string)
RankingMethodEnum:- median
- q3
- variance
- max
Inherits: string
Type AbundanceBoxplotPostRequest (object)
AbundanceBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
config* object Inherits: lib.BoxplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AbundanceScatterplotPostRequest (object)
AbundanceScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.rankingMethod* string Enum:- median
- q3
- variance
- max
Inherits: lib.RankingMethod
config* object Inherits: lib.ScatterplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AlphaDivBoxplotPostRequest (object)
AlphaDivBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
config* object Inherits: lib.BoxplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AlphaDivScatterplotPostRequest (object)
AlphaDivScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.alphaDivMethod* string Enum:- shannon
- simpson
- evenness
Inherits: lib.AlphaDivMethod
config* object Inherits: lib.ScatterplotWith1ComputeSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type AppsGetResponse (object)
AppsGetResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description apps* array apps[] object Inherits: lib.AppOverview
apps[].name* string apps[].displayName* string apps[].description* string apps[].projects* array apps[].projects[] string apps[].computeName string apps[].visualizations* array apps[].visualizations[] object Inherits: lib.VisualizationOverview
apps[].visualizations[].name* string apps[].visualizations[].displayName* string apps[].visualizations[].description* string apps[].visualizations[].projects* array apps[].visualizations[].projects[] string apps[].visualizations[].maxPanels* number apps[].visualizations[].dataElementConstraints array apps[].visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
apps[].visualizations[].dataElementConstraints[].//* object Inherits: object
apps[].visualizations[].dataElementConstraints[].//.isRequired* boolean apps[].visualizations[].dataElementConstraints[].//.isTemporal* boolean apps[].visualizations[].dataElementConstraints[].//.isCollection* boolean apps[].visualizations[].dataElementConstraints[].//.isCompositional* boolean apps[].visualizations[].dataElementConstraints[].//.isProportion* boolean apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string apps[].visualizations[].dataElementConstraints[].//.minNumVars* number apps[].visualizations[].dataElementConstraints[].//.maxNumVars* number apps[].visualizations[].dataElementConstraints[].//.minNumValues* number apps[].visualizations[].dataElementConstraints[].//.maxNumValues* number apps[].visualizations[].dataElementConstraints[].//.allowedTypes array apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
apps[].visualizations[].dataElementConstraints[].//.allowedShapes array apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
apps[].visualizations[].dataElementConstraints[].//.description* string apps[].visualizations[].dataElementDependencyOrder array apps[].visualizations[].dataElementDependencyOrder[] array apps[].visualizations[].dataElementDependencyOrder[][] string
Type AppOverview (object)
AppOverviewInherits: object
Model
Parameter Type Description name* string displayName* string description* string projects* array projects[] string computeName string visualizations* array visualizations[] object Inherits: lib.VisualizationOverview
visualizations[].name* string visualizations[].displayName* string visualizations[].description* string visualizations[].projects* array visualizations[].projects[] string visualizations[].maxPanels* number visualizations[].dataElementConstraints array visualizations[].dataElementConstraints[] object Additional properties: Yes
Inherits: object
visualizations[].dataElementConstraints[].//* object Inherits: object
visualizations[].dataElementConstraints[].//.isRequired* boolean visualizations[].dataElementConstraints[].//.isTemporal* boolean visualizations[].dataElementConstraints[].//.isCollection* boolean visualizations[].dataElementConstraints[].//.isCompositional* boolean visualizations[].dataElementConstraints[].//.isProportion* boolean visualizations[].dataElementConstraints[].//.allowedNormalizationMethods* array visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[] string visualizations[].dataElementConstraints[].//.minNumVars* number visualizations[].dataElementConstraints[].//.maxNumVars* number visualizations[].dataElementConstraints[].//.minNumValues* number visualizations[].dataElementConstraints[].//.maxNumValues* number visualizations[].dataElementConstraints[].//.allowedTypes array visualizations[].dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
visualizations[].dataElementConstraints[].//.allowedShapes array visualizations[].dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
visualizations[].dataElementConstraints[].//.description* string visualizations[].dataElementDependencyOrder array visualizations[].dataElementDependencyOrder[] array visualizations[].dataElementDependencyOrder[][] string
Type VisualizationOverview (object)
VisualizationOverviewInherits: object
Model
Parameter Type Description name* string displayName* string description* string projects* array projects[] string maxPanels* number dataElementConstraints array dataElementConstraints[] object Additional properties: Yes
Inherits: object
dataElementConstraints[].//* object Inherits: object
dataElementConstraints[].//.isRequired* boolean dataElementConstraints[].//.isTemporal* boolean dataElementConstraints[].//.isCollection* boolean dataElementConstraints[].//.isCompositional* boolean dataElementConstraints[].//.isProportion* boolean dataElementConstraints[].//.allowedNormalizationMethods* array dataElementConstraints[].//.allowedNormalizationMethods[] string dataElementConstraints[].//.minNumVars* number dataElementConstraints[].//.maxNumVars* number dataElementConstraints[].//.minNumValues* number dataElementConstraints[].//.maxNumValues* number dataElementConstraints[].//.allowedTypes array dataElementConstraints[].//.allowedTypes[] string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
dataElementConstraints[].//.allowedShapes array dataElementConstraints[].//.allowedShapes[] string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
dataElementConstraints[].//.description* string dataElementDependencyOrder array dataElementDependencyOrder[] array dataElementDependencyOrder[][] string
Type BetaDivScatterplotPostRequest (object)
BetaDivScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.betaDivDissimilarityMethod* string Enum:- bray
- jaccard
- jsd
Inherits: lib.BetaDivDissimilarityMethod
config* object Inherits: lib.BetaDivScatterplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string
Type BetaDivScatterplotSpec (object)
BetaDivScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string
Type CorrelationBipartitenetworkSpec (object)
CorrelationBipartitenetworkSpecInherits: object
Model
Parameter Type Description significanceThreshold number correlationCoefThreshold number
Type CorrelationBipartiteNetworkPostResponse (object)
CorrelationBipartiteNetworkPostResponseInherits: lib.BipartiteNetworkPostResponse
Model
Parameter Type Description bipartitenetwork* object Inherits: lib.BipartiteNetwork
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.BipartiteNetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: lib.LinkData
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: lib.NodeIdList
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.BipartiteNetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string significanceThreshold* number correlationCoefThreshold* number
Type CorrelationAssayAssayBipartitenetworkPostRequest (object)
CorrelationAssayAssayBipartitenetworkPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable1* object Inherits: object
computeConfig.collectionVariable1.entityId* string computeConfig.collectionVariable1.collectionId* string computeConfig.collectionVariable2* object Inherits: object
computeConfig.collectionVariable2.entityId* string computeConfig.collectionVariable2.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)
CorrelationAssayMetadataBipartitenetworkPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: lib.CorrelationComputeConfig
computeConfig.correlationMethod* string Enum:- spearman
- pearson
Inherits: lib.CorrelationMethod
computeConfig.prefilterThresholds object Inherits: object
computeConfig.prefilterThresholds.proportionNonZero number computeConfig.prefilterThresholds.variance number computeConfig.prefilterThresholds.standardDeviation number computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string config* object Inherits: object
config.significanceThreshold number config.correlationCoefThreshold number
Type DifferentialAbundanceVolcanoplotPostRequest (object)
DifferentialAbundanceVolcanoplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.collectionVariable* object Inherits: object
computeConfig.collectionVariable.entityId* string computeConfig.collectionVariable.collectionId* string computeConfig.comparator* object Additional properties: Yes
Inherits: lib.ComparatorSpec
computeConfig.comparator.variable* object Inherits: object
computeConfig.comparator.variable.entityId* string computeConfig.comparator.variable.variableId* string computeConfig.comparator.groupA* array computeConfig.comparator.groupA[] object Inherits: lib.Range
computeConfig.comparator.groupA[].min* string computeConfig.comparator.groupA[].max* string computeConfig.comparator.groupA[].label* string computeConfig.comparator.groupB* array computeConfig.comparator.groupB[] object Inherits: lib.Range
computeConfig.comparator.groupB[].min* string computeConfig.comparator.groupB[].max* string computeConfig.comparator.groupB[].label* string computeConfig.differentialAbundanceMethod* string Enum:- DESeq
- ANCOMBC
- Maaslin
Inherits: lib.DifferentialAbundanceMethod
computeConfig.pValueFloor string config* object Inherits: lib.EmptyDataPluginSpec
Type ContinuousVariableMetadataPostRequest (object)
ContinuousVariableMetadataPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ContinuousVariableMetadataSpec
config.variable* object Inherits: object
config.variable.entityId* string config.variable.variableId* string config.metadata* array config.metadata[] string Enum:- binRanges
- median
Type ContinuousVariableMetadataSpec (object)
ContinuousVariableMetadataSpecInherits: object
Model
Parameter Type Description variable* object Inherits: object
variable.entityId* string variable.variableId* string metadata* array metadata[] string Enum:- binRanges
- median
Type AllBinRanges (object)
AllBinRangesInherits: object
Model
Parameter Type Description equalInterval* array equalInterval[] object Inherits: lib.Range
equalInterval[].min* string equalInterval[].max* string equalInterval[].label* string quantile* array quantile[] object Inherits: lib.Range
quantile[].min* string quantile[].max* string quantile[].label* string standardDeviation* array standardDeviation[] object Inherits: lib.Range
standardDeviation[].min* string standardDeviation[].max* string standardDeviation[].label* string
Type ContinuousVariableMetadataPostResponse (object)
ContinuousVariableMetadataPostResponseInherits: object
Model
Parameter Type Description binRanges object Inherits: object
binRanges.equalInterval* array binRanges.equalInterval[] object Inherits: lib.Range
binRanges.equalInterval[].min* string binRanges.equalInterval[].max* string binRanges.equalInterval[].label* string binRanges.quantile* array binRanges.quantile[] object Inherits: lib.Range
binRanges.quantile[].min* string binRanges.quantile[].max* string binRanges.quantile[].label* string binRanges.standardDeviation* array binRanges.standardDeviation[] object Inherits: lib.Range
binRanges.standardDeviation[].min* string binRanges.standardDeviation[].max* string binRanges.standardDeviation[].label* string median number
Type NodeData (object)
NodeDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description id* string
Type LinkData (object)
LinkDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description source* object Additional properties: Yes
Inherits: object
source.id* string target* object Additional properties: Yes
Inherits: object
target.id* string weight* string color* string
Type NetworkData (object)
NetworkDataAdditional properties: Yes
Inherits: object
Model
Parameter Type Description nodes* array nodes[] object Additional properties: Yes
Inherits: object
nodes[].id* string links* array links[] object Additional properties: Yes
Inherits: object
links[].source* object Additional properties: Yes
Inherits: object
links[].source.id* string links[].target* object Additional properties: Yes
Inherits: object
links[].target.id* string links[].weight* string links[].color* string
Type NetworkConfig (object)
NetworkConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variables array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type NodeIdList (object)
NodeIdListInherits: object
Model
Parameter Type Description nodeIds* array nodeIds[] string
Type BipartiteNetworkConfig (object)
BipartiteNetworkConfigAdditional properties: Yes
Inherits: lib.NetworkConfig
Model
Parameter Type Description variables array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string partitionsMetadata* array Max. items: 2
partitionsMetadata[] string
Type BipartiteNetworkData (object)
BipartiteNetworkDataAdditional properties: Yes
Inherits: lib.NetworkData
Model
Parameter Type Description nodes* array nodes[] object Additional properties: Yes
Inherits: object
nodes[].id* string links* array links[] object Additional properties: Yes
Inherits: object
links[].source* object Additional properties: Yes
Inherits: object
links[].source.id* string links[].target* object Additional properties: Yes
Inherits: object
links[].target.id* string links[].weight* string links[].color* string partitions* array Max. items: 2
partitions[] object Inherits: object
partitions[].nodeIds* array partitions[].nodeIds[] string
Type BipartiteNetwork (object)
BipartiteNetworkInherits: object
Model
Parameter Type Description data* object Additional properties: Yes
Inherits: lib.NetworkData
data.nodes* array data.nodes[] object Additional properties: Yes
Inherits: object
data.nodes[].id* string data.links* array data.links[] object Additional properties: Yes
Inherits: object
data.links[].source* object Additional properties: Yes
Inherits: object
data.links[].source.id* string data.links[].target* object Additional properties: Yes
Inherits: object
data.links[].target.id* string data.links[].weight* string data.links[].color* string data.partitions* array Max. items: 2
data.partitions[] object Inherits: object
data.partitions[].nodeIds* array data.partitions[].nodeIds[] string config* object Additional properties: Yes
Inherits: lib.NetworkConfig
config.variables array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.partitionsMetadata* array Max. items: 2
config.partitionsMetadata[] string
Type BipartiteNetworkPostResponse (object)
BipartiteNetworkPostResponseInherits: object
Model
Parameter Type Description bipartitenetwork* object Inherits: object
bipartitenetwork.data* object Additional properties: Yes
Inherits: lib.NetworkData
bipartitenetwork.data.nodes* array bipartitenetwork.data.nodes[] object Additional properties: Yes
Inherits: object
bipartitenetwork.data.nodes[].id* string bipartitenetwork.data.links* array bipartitenetwork.data.links[] object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].source* object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].source.id* string bipartitenetwork.data.links[].target* object Additional properties: Yes
Inherits: object
bipartitenetwork.data.links[].target.id* string bipartitenetwork.data.links[].weight* string bipartitenetwork.data.links[].color* string bipartitenetwork.data.partitions* array Max. items: 2
bipartitenetwork.data.partitions[] object Inherits: object
bipartitenetwork.data.partitions[].nodeIds* array bipartitenetwork.data.partitions[].nodeIds[] string bipartitenetwork.config* object Additional properties: Yes
Inherits: lib.NetworkConfig
bipartitenetwork.config.variables array bipartitenetwork.config.variables[] object Inherits: object
bipartitenetwork.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
bipartitenetwork.config.variables[].variableSpec* object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].variableSpec.entityId* string bipartitenetwork.config.variables[].variableSpec.variableId* string bipartitenetwork.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
bipartitenetwork.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
bipartitenetwork.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
bipartitenetwork.config.variables[].displayName string bipartitenetwork.config.variables[].displayRangeMin any bipartitenetwork.config.variables[].displayRangeMax any bipartitenetwork.config.variables[].vocabulary array bipartitenetwork.config.variables[].vocabulary[] string bipartitenetwork.config.variables[].imputeZero* boolean bipartitenetwork.config.variables[].hasStudyDependentVocabulary boolean bipartitenetwork.config.variables[].isCollection* boolean bipartitenetwork.config.variables[].members array bipartitenetwork.config.variables[].members[] object Inherits: lib.VariableSpec
bipartitenetwork.config.variables[].members[].entityId* string bipartitenetwork.config.variables[].members[].variableId* string bipartitenetwork.config.partitionsMetadata* array Max. items: 2
bipartitenetwork.config.partitionsMetadata[] string
Type BarplotPostRequest (object)
BarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.BarplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type BarplotSpec (object)
BarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Barplot (object)
BarplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.BarplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type BarplotPostResponse (object)
BarplotPostResponseInherits: object
Model
Parameter Type Description barplot* object Inherits: object
barplot.data* array barplot.data[] object Inherits: lib.BarplotData
barplot.data[].overlayVariableDetails object Inherits: object
barplot.data[].overlayVariableDetails.entityId* string barplot.data[].overlayVariableDetails.variableId* string barplot.data[].overlayVariableDetails.value* string barplot.data[].facetVariableDetails array Max. items: 2
barplot.data[].facetVariableDetails[] object Inherits: object
barplot.data[].facetVariableDetails[].entityId* string barplot.data[].facetVariableDetails[].variableId* string barplot.data[].facetVariableDetails[].value* string barplot.data[].value* array barplot.data[].value[] number barplot.data[].label* array barplot.data[].label[] string barplot.config* object Inherits: lib.PlotConfig
barplot.config.completeCasesAllVars* number barplot.config.completeCasesAxesVars* number barplot.config.variables* array barplot.config.variables[] object Inherits: object
barplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
barplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
barplot.config.variables[].variableSpec.entityId* string barplot.config.variables[].variableSpec.variableId* string barplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
barplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
barplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
barplot.config.variables[].displayName string barplot.config.variables[].displayRangeMin any barplot.config.variables[].displayRangeMax any barplot.config.variables[].vocabulary array barplot.config.variables[].vocabulary[] string barplot.config.variables[].imputeZero* boolean barplot.config.variables[].hasStudyDependentVocabulary boolean barplot.config.variables[].isCollection* boolean barplot.config.variables[].members array barplot.config.variables[].members[] object Inherits: lib.VariableSpec
barplot.config.variables[].members[].entityId* string barplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type BoxplotPostRequest (object)
BoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.BoxplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.points* string Enum:- outliers
- all
config.mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type BoxplotSpec (object)
BoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
points* string Enum:- outliers
- all
mean* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
computeStats* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string maxAllowedDataPoints integer Format: int64
Type Boxplot (object)
BoxplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.BoxplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].lowerfence* array data[].lowerfence[] number data[].upperfence* array data[].upperfence[] number data[].q1* array data[].q1[] number data[].q3* array data[].q3[] number data[].median* array data[].median[] number data[].outliers array data[].outliers[] array data[].outliers[][] number data[].rawData array data[].rawData[] array data[].rawData[][] number data[].mean array data[].mean[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type BoxplotPostResponse (object)
BoxplotPostResponseInherits: object
Model
Parameter Type Description boxplot* object Inherits: object
boxplot.data* array boxplot.data[] object Inherits: lib.BoxplotData
boxplot.data[].overlayVariableDetails object Inherits: object
boxplot.data[].overlayVariableDetails.entityId* string boxplot.data[].overlayVariableDetails.variableId* string boxplot.data[].overlayVariableDetails.value* string boxplot.data[].facetVariableDetails array Max. items: 2
boxplot.data[].facetVariableDetails[] object Inherits: object
boxplot.data[].facetVariableDetails[].entityId* string boxplot.data[].facetVariableDetails[].variableId* string boxplot.data[].facetVariableDetails[].value* string boxplot.data[].lowerfence* array boxplot.data[].lowerfence[] number boxplot.data[].upperfence* array boxplot.data[].upperfence[] number boxplot.data[].q1* array boxplot.data[].q1[] number boxplot.data[].q3* array boxplot.data[].q3[] number boxplot.data[].median* array boxplot.data[].median[] number boxplot.data[].outliers array boxplot.data[].outliers[] array boxplot.data[].outliers[][] number boxplot.data[].rawData array boxplot.data[].rawData[] array boxplot.data[].rawData[][] number boxplot.data[].mean array boxplot.data[].mean[] number boxplot.data[].label* array boxplot.data[].label[] string boxplot.config* object Inherits: lib.PlotConfig
boxplot.config.completeCasesAllVars* number boxplot.config.completeCasesAxesVars* number boxplot.config.variables* array boxplot.config.variables[] object Inherits: object
boxplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
boxplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
boxplot.config.variables[].variableSpec.entityId* string boxplot.config.variables[].variableSpec.variableId* string boxplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
boxplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
boxplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
boxplot.config.variables[].displayName string boxplot.config.variables[].displayRangeMin any boxplot.config.variables[].displayRangeMax any boxplot.config.variables[].vocabulary array boxplot.config.variables[].vocabulary[] string boxplot.config.variables[].imputeZero* boolean boxplot.config.variables[].hasStudyDependentVocabulary boolean boxplot.config.variables[].isCollection* boolean boxplot.config.variables[].members array boxplot.config.variables[].members[] object Inherits: lib.VariableSpec
boxplot.config.variables[].members[].entityId* string boxplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number statsTable array statsTable[] object Inherits: lib.BoxplotStatsTable
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].xVariableDetails object Inherits: object
statsTable[].xVariableDetails.entityId* string statsTable[].xVariableDetails.variableId* string statsTable[].xVariableDetails.value* string statsTable[].statistic* string statsTable[].pvalue* number statsTable[].parameter* array statsTable[].parameter[] number statsTable[].method* string statsTable[].statsError* string
Type ContTableStatsTable (object)
ContTableStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string pvalue* array pvalue[] number degreesFreedom* array degreesFreedom[] number chisq* array chisq[] number
Type ContTablePostResponse (object)
ContTablePostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: lib.Mosaic
mosaic.data* array mosaic.data[] object Inherits: lib.MosaicData
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.config* object Inherits: lib.PlotConfig
mosaic.config.completeCasesAllVars* number mosaic.config.completeCasesAxesVars* number mosaic.config.variables* array mosaic.config.variables[] object Inherits: object
mosaic.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.config.variables[].variableSpec.entityId* string mosaic.config.variables[].variableSpec.variableId* string mosaic.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.config.variables[].displayName string mosaic.config.variables[].displayRangeMin any mosaic.config.variables[].displayRangeMax any mosaic.config.variables[].vocabulary array mosaic.config.variables[].vocabulary[] string mosaic.config.variables[].imputeZero* boolean mosaic.config.variables[].hasStudyDependentVocabulary boolean mosaic.config.variables[].isCollection* boolean mosaic.config.variables[].members array mosaic.config.variables[].members[] object Inherits: lib.VariableSpec
mosaic.config.variables[].members[].entityId* string mosaic.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].pvalue* array statsTable[].pvalue[] number statsTable[].degreesFreedom* array statsTable[].degreesFreedom[] number statsTable[].chisq* array statsTable[].chisq[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type DensityplotPostRequest (object)
DensityplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.DensityplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type DensityplotSpec (object)
DensityplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Densityplot (object)
DensityplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.DensityplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].densityY* array data[].densityY[] number data[].densityX* array data[].densityX[] number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type DensityplotPostResponse (object)
DensityplotPostResponseInherits: object
Model
Parameter Type Description densityplot* object Inherits: object
densityplot.data* array densityplot.data[] object Inherits: lib.DensityplotData
densityplot.data[].overlayVariableDetails object Inherits: object
densityplot.data[].overlayVariableDetails.entityId* string densityplot.data[].overlayVariableDetails.variableId* string densityplot.data[].overlayVariableDetails.value* string densityplot.data[].facetVariableDetails array Max. items: 2
densityplot.data[].facetVariableDetails[] object Inherits: object
densityplot.data[].facetVariableDetails[].entityId* string densityplot.data[].facetVariableDetails[].variableId* string densityplot.data[].facetVariableDetails[].value* string densityplot.data[].densityY* array densityplot.data[].densityY[] number densityplot.data[].densityX* array densityplot.data[].densityX[] number densityplot.config* object Inherits: lib.PlotConfig
densityplot.config.completeCasesAllVars* number densityplot.config.completeCasesAxesVars* number densityplot.config.variables* array densityplot.config.variables[] object Inherits: object
densityplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
densityplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
densityplot.config.variables[].variableSpec.entityId* string densityplot.config.variables[].variableSpec.variableId* string densityplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
densityplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
densityplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
densityplot.config.variables[].displayName string densityplot.config.variables[].displayRangeMin any densityplot.config.variables[].displayRangeMax any densityplot.config.variables[].vocabulary array densityplot.config.variables[].vocabulary[] string densityplot.config.variables[].imputeZero* boolean densityplot.config.variables[].hasStudyDependentVocabulary boolean densityplot.config.variables[].isCollection* boolean densityplot.config.variables[].members array densityplot.config.variables[].members[] object Inherits: lib.VariableSpec
densityplot.config.variables[].members[].entityId* string densityplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type HeatmapPostRequest (object)
HeatmapPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HeatmapSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- collection
- series
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.zAxisVariable object Inherits: object
config.zAxisVariable.entityId* string config.zAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type HeatmapSpec (object)
HeatmapSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
valueSpec* string Enum:- collection
- series
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string zAxisVariable object Inherits: object
zAxisVariable.entityId* string zAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Heatmap (object)
HeatmapInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.HeatmapData
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] array data[].value[][] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type HeatmapPostResponse (object)
HeatmapPostResponseInherits: object
Model
Parameter Type Description heatmap* object Inherits: object
heatmap.data* array heatmap.data[] object Inherits: lib.HeatmapData
heatmap.data[].facetVariableDetails array Max. items: 2
heatmap.data[].facetVariableDetails[] object Inherits: object
heatmap.data[].facetVariableDetails[].entityId* string heatmap.data[].facetVariableDetails[].variableId* string heatmap.data[].facetVariableDetails[].value* string heatmap.data[].value* array heatmap.data[].value[] array heatmap.data[].value[][] number heatmap.data[].label* array heatmap.data[].label[] string heatmap.config* object Inherits: lib.PlotConfig
heatmap.config.completeCasesAllVars* number heatmap.config.completeCasesAxesVars* number heatmap.config.variables* array heatmap.config.variables[] object Inherits: object
heatmap.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
heatmap.config.variables[].variableSpec* object Inherits: lib.VariableSpec
heatmap.config.variables[].variableSpec.entityId* string heatmap.config.variables[].variableSpec.variableId* string heatmap.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
heatmap.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
heatmap.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
heatmap.config.variables[].displayName string heatmap.config.variables[].displayRangeMin any heatmap.config.variables[].displayRangeMax any heatmap.config.variables[].vocabulary array heatmap.config.variables[].vocabulary[] string heatmap.config.variables[].imputeZero* boolean heatmap.config.variables[].hasStudyDependentVocabulary boolean heatmap.config.variables[].isCollection* boolean heatmap.config.variables[].members array heatmap.config.variables[].members[] object Inherits: lib.VariableSpec
heatmap.config.variables[].members[].entityId* string heatmap.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type HistogramPostRequest (object)
HistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.HistogramSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type HistogramSpec (object)
HistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type HistogramSummary (object)
HistogramSummaryAdditional properties: Yes
Inherits: object
Model
Parameter Type Description min* string q1* string median* string mean* string q3* string max* string
Type HistogramConfig (object)
HistogramConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string binSlider* object Inherits: lib.BinSlider
binSlider.min* number binSlider.max* number binSlider.step* number binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string summary* object Additional properties: Yes
Inherits: object
summary.min* string summary.q1* string summary.median* string summary.mean* string summary.q3* string summary.max* string viewport* object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type Histogram (object)
HistogramInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.HistogramData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].binStart* array data[].binStart[] string data[].binEnd* array data[].binEnd[] string data[].binLabel* array data[].binLabel[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.binSlider* object Inherits: lib.BinSlider
config.binSlider.min* number config.binSlider.max* number config.binSlider.step* number config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.summary* object Additional properties: Yes
Inherits: object
config.summary.min* string config.summary.q1* string config.summary.median* string config.summary.mean* string config.summary.q3* string config.summary.max* string config.viewport* object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type HistogramPostResponse (object)
HistogramPostResponseInherits: object
Model
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: lib.HistogramData
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.config* object Inherits: lib.PlotConfig
histogram.config.completeCasesAllVars* number histogram.config.completeCasesAxesVars* number histogram.config.variables* array histogram.config.variables[] object Inherits: object
histogram.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.config.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.config.variables[].variableSpec.entityId* string histogram.config.variables[].variableSpec.variableId* string histogram.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.config.variables[].displayName string histogram.config.variables[].displayRangeMin any histogram.config.variables[].displayRangeMax any histogram.config.variables[].vocabulary array histogram.config.variables[].vocabulary[] string histogram.config.variables[].imputeZero* boolean histogram.config.variables[].hasStudyDependentVocabulary boolean histogram.config.variables[].isCollection* boolean histogram.config.variables[].members array histogram.config.variables[].members[] object Inherits: lib.VariableSpec
histogram.config.variables[].members[].entityId* string histogram.config.variables[].members[].variableId* string histogram.config.binSlider* object Inherits: lib.BinSlider
histogram.config.binSlider.min* number histogram.config.binSlider.max* number histogram.config.binSlider.step* number histogram.config.binSpec* object Inherits: lib.BinSpec
histogram.config.binSpec.type string Enum:- binWidth
- numBins
histogram.config.binSpec.value number histogram.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
histogram.config.binSpec.range union histogram.config.binSpec.range anyOf Any of the following types. histogram.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
histogram.config.binSpec.range{NumberRange}..min* number histogram.config.binSpec.range{NumberRange}..max* number histogram.config.binSpec.range{DateRange} object Inherits: lib.DateRange
histogram.config.binSpec.range{DateRange}..min* string histogram.config.binSpec.range{DateRange}..max* string histogram.config.summary* object Additional properties: Yes
Inherits: object
histogram.config.summary.min* string histogram.config.summary.q1* string histogram.config.summary.median* string histogram.config.summary.mean* string histogram.config.summary.q3* string histogram.config.summary.max* string histogram.config.viewport* object Inherits: lib.NumericViewport
histogram.config.viewport.xMin* string histogram.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type LineplotPostRequest (object)
LineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.LineplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type LineplotSpec (object)
LineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type LineplotConfig (object)
LineplotConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string binSlider object Inherits: lib.BinSlider
binSlider.min* number binSlider.max* number binSlider.step* number binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type Lineplot (object)
LineplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.LineplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].binStart array data[].binStart[] string data[].binEnd array data[].binEnd[] string data[].binSampleSize array data[].binSampleSize[] union Inherits: lib.SampleSize
data[].binSampleSize[] anyOf Any of the following types. data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
data[].binSampleSize[]{SimpleSampleSize}..N* number data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number data[].errorBars array data[].errorBars[] object Inherits: lib.ErrorBar
data[].errorBars[].lowerBound* number data[].errorBars[].upperBound* number data[].errorBars[].error* string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.binSlider object Inherits: lib.BinSlider
config.binSlider.min* number config.binSlider.max* number config.binSlider.step* number config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type LineplotPostResponse (object)
LineplotPostResponseInherits: object
Model
Parameter Type Description lineplot* object Inherits: object
lineplot.data* array lineplot.data[] object Inherits: lib.LineplotData
lineplot.data[].overlayVariableDetails object Inherits: object
lineplot.data[].overlayVariableDetails.entityId* string lineplot.data[].overlayVariableDetails.variableId* string lineplot.data[].overlayVariableDetails.value* string lineplot.data[].facetVariableDetails array Max. items: 2
lineplot.data[].facetVariableDetails[] object Inherits: object
lineplot.data[].facetVariableDetails[].entityId* string lineplot.data[].facetVariableDetails[].variableId* string lineplot.data[].facetVariableDetails[].value* string lineplot.data[].seriesY* array lineplot.data[].seriesY[] string lineplot.data[].seriesX* array lineplot.data[].seriesX[] string lineplot.data[].binStart array lineplot.data[].binStart[] string lineplot.data[].binEnd array lineplot.data[].binEnd[] string lineplot.data[].binSampleSize array lineplot.data[].binSampleSize[] union Inherits: lib.SampleSize
lineplot.data[].binSampleSize[] anyOf Any of the following types. lineplot.data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* number lineplot.data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number lineplot.data[].errorBars array lineplot.data[].errorBars[] object Inherits: lib.ErrorBar
lineplot.data[].errorBars[].lowerBound* number lineplot.data[].errorBars[].upperBound* number lineplot.data[].errorBars[].error* string lineplot.config* object Inherits: lib.PlotConfig
lineplot.config.completeCasesAllVars* number lineplot.config.completeCasesAxesVars* number lineplot.config.variables* array lineplot.config.variables[] object Inherits: object
lineplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
lineplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
lineplot.config.variables[].variableSpec.entityId* string lineplot.config.variables[].variableSpec.variableId* string lineplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
lineplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
lineplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
lineplot.config.variables[].displayName string lineplot.config.variables[].displayRangeMin any lineplot.config.variables[].displayRangeMax any lineplot.config.variables[].vocabulary array lineplot.config.variables[].vocabulary[] string lineplot.config.variables[].imputeZero* boolean lineplot.config.variables[].hasStudyDependentVocabulary boolean lineplot.config.variables[].isCollection* boolean lineplot.config.variables[].members array lineplot.config.variables[].members[] object Inherits: lib.VariableSpec
lineplot.config.variables[].members[].entityId* string lineplot.config.variables[].members[].variableId* string lineplot.config.binSlider object Inherits: lib.BinSlider
lineplot.config.binSlider.min* number lineplot.config.binSlider.max* number lineplot.config.binSlider.step* number lineplot.config.binSpec object Inherits: lib.BinSpec
lineplot.config.binSpec.type string Enum:- binWidth
- numBins
lineplot.config.binSpec.value number lineplot.config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
lineplot.config.binSpec.range union lineplot.config.binSpec.range anyOf Any of the following types. lineplot.config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
lineplot.config.binSpec.range{NumberRange}..min* number lineplot.config.binSpec.range{NumberRange}..max* number lineplot.config.binSpec.range{DateRange} object Inherits: lib.DateRange
lineplot.config.binSpec.range{DateRange}..min* string lineplot.config.binSpec.range{DateRange}..max* string lineplot.config.viewport object Inherits: lib.NumericViewport
lineplot.config.viewport.xMin* string lineplot.config.viewport.xMax* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type MapMarkersOverlayPostRequest (object)
MapMarkersOverlayPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MapMarkersOverlaySpec
config.outputEntityId* string config.showMissingness string Enum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingness
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.longitudeVariable object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapMarkersOverlaySpec (object)
MapMarkersOverlaySpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingness
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string valueSpec* string Enum:- count
- proportion
Inherits: string
longitudeVariable object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapMarkersOverlayConfig (object)
MapMarkersOverlayConfigInherits: lib.PlotConfig
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapMarkersOverlay (object)
MapMarkersOverlayInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.MapMarkersOverlayData
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapMarkersOverlayPostResponse (object)
MapMarkersOverlayPostResponseInherits: object
Model
Parameter Type Description mapMarkers* object Inherits: object
mapMarkers.data* array mapMarkers.data[] object Inherits: lib.MapMarkersOverlayData
mapMarkers.data[].facetVariableDetails array Max. items: 2
mapMarkers.data[].facetVariableDetails[] object Inherits: object
mapMarkers.data[].facetVariableDetails[].entityId* string mapMarkers.data[].facetVariableDetails[].variableId* string mapMarkers.data[].facetVariableDetails[].value* string mapMarkers.data[].value* array mapMarkers.data[].value[] number mapMarkers.data[].label* array mapMarkers.data[].label[] string mapMarkers.config* object Inherits: lib.PlotConfig
mapMarkers.config.completeCasesAllVars* number mapMarkers.config.completeCasesAxesVars* number mapMarkers.config.variables* array mapMarkers.config.variables[] object Inherits: object
mapMarkers.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mapMarkers.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mapMarkers.config.variables[].variableSpec.entityId* string mapMarkers.config.variables[].variableSpec.variableId* string mapMarkers.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mapMarkers.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mapMarkers.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mapMarkers.config.variables[].displayName string mapMarkers.config.variables[].displayRangeMin any mapMarkers.config.variables[].displayRangeMax any mapMarkers.config.variables[].vocabulary array mapMarkers.config.variables[].vocabulary[] string mapMarkers.config.variables[].imputeZero* boolean mapMarkers.config.variables[].hasStudyDependentVocabulary boolean mapMarkers.config.variables[].isCollection* boolean mapMarkers.config.variables[].members array mapMarkers.config.variables[].members[] object Inherits: lib.VariableSpec
mapMarkers.config.variables[].members[].entityId* string mapMarkers.config.variables[].members[].variableId* string mapMarkers.config.viewport* object Inherits: lib.GeolocationViewport
mapMarkers.config.viewport.latitude* object Inherits: lib.NumericViewport
mapMarkers.config.viewport.latitude.xMin* string mapMarkers.config.viewport.latitude.xMax* string mapMarkers.config.viewport.longitude* object Inherits: lib.LongitudeViewport
mapMarkers.config.viewport.longitude.left* number mapMarkers.config.viewport.longitude.right* number sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type MapPostRequest (object)
MapPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MapSpec
config.outputEntityId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type MapSpec (object)
MapSpecInherits: object
Model
Parameter Type Description outputEntityId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type MapConfig (object)
MapConfigInherits: object
Model
Parameter Type Description completeCasesGeoVar* number
Type MapPostResponse (object)
MapPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.MapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number config* object Inherits: object
config.completeCasesGeoVar* number
Type MapElementInfo (object)
MapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type ScatterplotPostRequest (object)
ScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ScatterplotSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayVariable object Inherits: object
config.overlayVariable.entityId* string config.overlayVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type ScatterplotSpec (object)
ScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string maxAllowedDataPoints integer Format: int64
Type Scatterplot (object)
ScatterplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: lib.ScatterplotData
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].smoothedMeanX array data[].smoothedMeanX[] string data[].smoothedMeanY array data[].smoothedMeanY[] number data[].smoothedMeanSE array data[].smoothedMeanSE[] number data[].smoothedMeanError string data[].bestFitLineX array data[].bestFitLineX[] string data[].bestFitLineY array data[].bestFitLineY[] number data[].r2 number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type ScatterplotPostResponse (object)
ScatterplotPostResponseInherits: object
Model
Parameter Type Description scatterplot* object Inherits: object
scatterplot.data* array scatterplot.data[] object Inherits: lib.ScatterplotData
scatterplot.data[].overlayVariableDetails object Inherits: object
scatterplot.data[].overlayVariableDetails.entityId* string scatterplot.data[].overlayVariableDetails.variableId* string scatterplot.data[].overlayVariableDetails.value* string scatterplot.data[].facetVariableDetails array Max. items: 2
scatterplot.data[].facetVariableDetails[] object Inherits: object
scatterplot.data[].facetVariableDetails[].entityId* string scatterplot.data[].facetVariableDetails[].variableId* string scatterplot.data[].facetVariableDetails[].value* string scatterplot.data[].seriesY* array scatterplot.data[].seriesY[] string scatterplot.data[].seriesX* array scatterplot.data[].seriesX[] string scatterplot.data[].smoothedMeanX array scatterplot.data[].smoothedMeanX[] string scatterplot.data[].smoothedMeanY array scatterplot.data[].smoothedMeanY[] number scatterplot.data[].smoothedMeanSE array scatterplot.data[].smoothedMeanSE[] number scatterplot.data[].smoothedMeanError string scatterplot.data[].bestFitLineX array scatterplot.data[].bestFitLineX[] string scatterplot.data[].bestFitLineY array scatterplot.data[].bestFitLineY[] number scatterplot.data[].r2 number scatterplot.config* object Inherits: lib.PlotConfig
scatterplot.config.completeCasesAllVars* number scatterplot.config.completeCasesAxesVars* number scatterplot.config.variables* array scatterplot.config.variables[] object Inherits: object
scatterplot.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
scatterplot.config.variables[].variableSpec* object Inherits: lib.VariableSpec
scatterplot.config.variables[].variableSpec.entityId* string scatterplot.config.variables[].variableSpec.variableId* string scatterplot.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
scatterplot.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
scatterplot.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
scatterplot.config.variables[].displayName string scatterplot.config.variables[].displayRangeMin any scatterplot.config.variables[].displayRangeMax any scatterplot.config.variables[].vocabulary array scatterplot.config.variables[].vocabulary[] string scatterplot.config.variables[].imputeZero* boolean scatterplot.config.variables[].hasStudyDependentVocabulary boolean scatterplot.config.variables[].isCollection* boolean scatterplot.config.variables[].members array scatterplot.config.variables[].members[] object Inherits: lib.VariableSpec
scatterplot.config.variables[].members[].entityId* string scatterplot.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type TablePostRequest (object)
TablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.TableSpec
config.outputEntityId* string config.outputVariable* array config.outputVariable[] object Inherits: object
config.outputVariable[].entityId* string config.outputVariable[].variableId* string config.pagingConfig* object Additional properties: Yes
Inherits: object
config.pagingConfig.numRows integer Format: int64
config.pagingConfig.offset integer Format: int64
Type TableSpec (object)
TableSpecInherits: object
Model
Parameter Type Description outputEntityId* string outputVariable* array outputVariable[] object Inherits: object
outputVariable[].entityId* string outputVariable[].variableId* string pagingConfig* object Additional properties: Yes
Inherits: object
pagingConfig.numRows integer Format: int64
pagingConfig.offset integer Format: int64
Type TablePostResponse (object)
TablePostResponseInherits: object
Model
Parameter Type Description columns* array columns[] object Inherits: object
columns[].entityId* string columns[].variableId* string rows* array rows[] array rows[][] string
Type TwoByTwoSpec (object)
TwoByTwoSpecInherits: lib.MosaicSpec
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string xAxisReferenceValue* string yAxisReferenceValue* string
Type TwoByTwoPostRequest (object)
TwoByTwoPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MosaicSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string config.xAxisReferenceValue* string config.yAxisReferenceValue* string
Type Statistic (object)
StatisticInherits: object
Model
Parameter Type Description value* number confidenceInterval string confidenceLevel number pvalue* string
Type TwoByTwoStatsTable (object)
TwoByTwoStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string chisq* object Inherits: object
chisq.value* number chisq.confidenceInterval string chisq.confidenceLevel number chisq.pvalue* string fisher* object Inherits: object
fisher.value* number fisher.confidenceInterval string fisher.confidenceLevel number fisher.pvalue* string prevalence object Inherits: object
prevalence.value* number prevalence.confidenceInterval string prevalence.confidenceLevel number prevalence.pvalue* string oddsratio object Inherits: object
oddsratio.value* number oddsratio.confidenceInterval string oddsratio.confidenceLevel number oddsratio.pvalue* string relativerisk object Inherits: object
relativerisk.value* number relativerisk.confidenceInterval string relativerisk.confidenceLevel number relativerisk.pvalue* string sensitivity object Inherits: object
sensitivity.value* number sensitivity.confidenceInterval string sensitivity.confidenceLevel number sensitivity.pvalue* string specificity object Inherits: object
specificity.value* number specificity.confidenceInterval string specificity.confidenceLevel number specificity.pvalue* string posPredictiveValue object Inherits: object
posPredictiveValue.value* number posPredictiveValue.confidenceInterval string posPredictiveValue.confidenceLevel number posPredictiveValue.pvalue* string negPredictiveValue object Inherits: object
negPredictiveValue.value* number negPredictiveValue.confidenceInterval string negPredictiveValue.confidenceLevel number negPredictiveValue.pvalue* string
Type TwoByTwoPostResponse (object)
TwoByTwoPostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: lib.Mosaic
mosaic.data* array mosaic.data[] object Inherits: lib.MosaicData
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.config* object Inherits: lib.PlotConfig
mosaic.config.completeCasesAllVars* number mosaic.config.completeCasesAxesVars* number mosaic.config.variables* array mosaic.config.variables[] object Inherits: object
mosaic.config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.config.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.config.variables[].variableSpec.entityId* string mosaic.config.variables[].variableSpec.variableId* string mosaic.config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.config.variables[].displayName string mosaic.config.variables[].displayRangeMin any mosaic.config.variables[].displayRangeMax any mosaic.config.variables[].vocabulary array mosaic.config.variables[].vocabulary[] string mosaic.config.variables[].imputeZero* boolean mosaic.config.variables[].hasStudyDependentVocabulary boolean mosaic.config.variables[].isCollection* boolean mosaic.config.variables[].members array mosaic.config.variables[].members[] object Inherits: lib.VariableSpec
mosaic.config.variables[].members[].entityId* string mosaic.config.variables[].members[].variableId* string sampleSizeTable* array sampleSizeTable[] object Inherits: lib.SampleSizeTable
sampleSizeTable[].xVariableDetails array sampleSizeTable[].xVariableDetails[] object Inherits: object
sampleSizeTable[].xVariableDetails[].entityId* string sampleSizeTable[].xVariableDetails[].variableId* string sampleSizeTable[].xVariableDetails[].value* string sampleSizeTable[].overlayVariableDetails object Inherits: object
sampleSizeTable[].overlayVariableDetails.entityId* string sampleSizeTable[].overlayVariableDetails.variableId* string sampleSizeTable[].overlayVariableDetails.value* string sampleSizeTable[].facetVariableDetails array Max. items: 2
sampleSizeTable[].facetVariableDetails[] object Inherits: object
sampleSizeTable[].facetVariableDetails[].entityId* string sampleSizeTable[].facetVariableDetails[].variableId* string sampleSizeTable[].facetVariableDetails[].value* string sampleSizeTable[].size* array sampleSizeTable[].size[] number statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].chisq* object Inherits: object
statsTable[].chisq.value* number statsTable[].chisq.confidenceInterval string statsTable[].chisq.confidenceLevel number statsTable[].chisq.pvalue* string statsTable[].fisher* object Inherits: object
statsTable[].fisher.value* number statsTable[].fisher.confidenceInterval string statsTable[].fisher.confidenceLevel number statsTable[].fisher.pvalue* string statsTable[].prevalence object Inherits: object
statsTable[].prevalence.value* number statsTable[].prevalence.confidenceInterval string statsTable[].prevalence.confidenceLevel number statsTable[].prevalence.pvalue* string statsTable[].oddsratio object Inherits: object
statsTable[].oddsratio.value* number statsTable[].oddsratio.confidenceInterval string statsTable[].oddsratio.confidenceLevel number statsTable[].oddsratio.pvalue* string statsTable[].relativerisk object Inherits: object
statsTable[].relativerisk.value* number statsTable[].relativerisk.confidenceInterval string statsTable[].relativerisk.confidenceLevel number statsTable[].relativerisk.pvalue* string statsTable[].sensitivity object Inherits: object
statsTable[].sensitivity.value* number statsTable[].sensitivity.confidenceInterval string statsTable[].sensitivity.confidenceLevel number statsTable[].sensitivity.pvalue* string statsTable[].specificity object Inherits: object
statsTable[].specificity.value* number statsTable[].specificity.confidenceInterval string statsTable[].specificity.confidenceLevel number statsTable[].specificity.pvalue* string statsTable[].posPredictiveValue object Inherits: object
statsTable[].posPredictiveValue.value* number statsTable[].posPredictiveValue.confidenceInterval string statsTable[].posPredictiveValue.confidenceLevel number statsTable[].posPredictiveValue.pvalue* string statsTable[].negPredictiveValue object Inherits: object
statsTable[].negPredictiveValue.value* number statsTable[].negPredictiveValue.confidenceInterval string statsTable[].negPredictiveValue.confidenceLevel number statsTable[].negPredictiveValue.pvalue* string completeCasesTable* array completeCasesTable[] object Inherits: lib.VariableCompleteCases
completeCasesTable[].variableDetails* object Inherits: object
completeCasesTable[].variableDetails.entityId* string completeCasesTable[].variableDetails.variableId* string completeCasesTable[].completeCases* number
Type BarplotData (object)
BarplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number label* array label[] string
Type MapMarkersOverlayData (object)
MapMarkersOverlayDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number label* array label[] string
Type BoxplotData (object)
BoxplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string lowerfence* array lowerfence[] number upperfence* array upperfence[] number q1* array q1[] number q3* array q3[] number median* array median[] number outliers array outliers[] array outliers[][] number rawData array rawData[] array rawData[][] number mean array mean[] number label* array label[] string
Type BoxplotStatsTable (object)
BoxplotStatsTableInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string xVariableDetails object Inherits: object
xVariableDetails.entityId* string xVariableDetails.variableId* string xVariableDetails.value* string statistic* string pvalue* number parameter* array parameter[] number method* string statsError* string
Type HistogramData (object)
HistogramDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] number binStart* array binStart[] string binEnd* array binEnd[] string binLabel* array binLabel[] string
Type BinSlider (object)
BinSliderInherits: object
Model
Parameter Type Description min* number max* number step* number
Type HeatmapData (object)
HeatmapDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string value* array value[] array value[][] number label* array label[] string
Type MosaicPostRequest (object)
MosaicPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MosaicSpec
config.outputEntityId* string config.showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.facetVariable array Max. items: 2
config.facetVariable[] object Inherits: object
config.facetVariable[].entityId* string config.facetVariable[].variableId* string
Type MosaicSpec (object)
MosaicSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: lib.ShowMissingnessNoAxes
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type MosaicData (object)
MosaicDataInherits: object
Model
Parameter Type Description facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string xLabel* array xLabel[] string yLabel* array yLabel[] array yLabel[][] string value* array value[] array value[][] number
Type Mosaic (object)
MosaicInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].xLabel* array data[].xLabel[] string data[].yLabel* array data[].yLabel[] array data[].yLabel[][] string data[].value* array data[].value[] array data[].value[][] number config* object Inherits: lib.PlotConfig
config.completeCasesAllVars* number config.completeCasesAxesVars* number config.variables* array config.variables[] object Inherits: object
config.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
config.variables[].variableSpec* object Inherits: lib.VariableSpec
config.variables[].variableSpec.entityId* string config.variables[].variableSpec.variableId* string config.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
config.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
config.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
config.variables[].displayName string config.variables[].displayRangeMin any config.variables[].displayRangeMax any config.variables[].vocabulary array config.variables[].vocabulary[] string config.variables[].imputeZero* boolean config.variables[].hasStudyDependentVocabulary boolean config.variables[].isCollection* boolean config.variables[].members array config.variables[].members[] object Inherits: lib.VariableSpec
config.variables[].members[].entityId* string config.variables[].members[].variableId* string
Type ScatterplotData (object)
ScatterplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string seriesY* array seriesY[] string seriesX* array seriesX[] string smoothedMeanX array smoothedMeanX[] string smoothedMeanY array smoothedMeanY[] number smoothedMeanSE array smoothedMeanSE[] number smoothedMeanError string bestFitLineX array bestFitLineX[] string bestFitLineY array bestFitLineY[] number r2 number
Type DensityplotData (object)
DensityplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string densityY* array densityY[] number densityX* array densityX[] number
Type LineplotData (object)
LineplotDataInherits: object
Model
Parameter Type Description overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string seriesY* array seriesY[] string seriesX* array seriesX[] string binStart array binStart[] string binEnd array binEnd[] string binSampleSize array binSampleSize[] union Inherits: lib.SampleSize
binSampleSize[] anyOf Any of the following types. binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
binSampleSize[]{SimpleSampleSize}..N* number binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
binSampleSize[]{ProportionSampleSize}..numeratorN* number binSampleSize[]{ProportionSampleSize}..denominatorN* number errorBars array errorBars[] object Inherits: lib.ErrorBar
errorBars[].lowerBound* number errorBars[].upperBound* number errorBars[].error* string
Type PlotConfig (object)
PlotConfigInherits: object
Model
Parameter Type Description completeCasesAllVars* number completeCasesAxesVars* number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type SampleSizeTable (object)
SampleSizeTableInherits: object
Model
Parameter Type Description xVariableDetails array xVariableDetails[] object Inherits: object
xVariableDetails[].entityId* string xVariableDetails[].variableId* string xVariableDetails[].value* string overlayVariableDetails object Inherits: object
overlayVariableDetails.entityId* string overlayVariableDetails.variableId* string overlayVariableDetails.value* string facetVariableDetails array Max. items: 2
facetVariableDetails[] object Inherits: object
facetVariableDetails[].entityId* string facetVariableDetails[].variableId* string facetVariableDetails[].value* string size* array size[] number
Type VariableCompleteCases (object)
VariableCompleteCasesInherits: object
Model
Parameter Type Description variableDetails* object Inherits: object
variableDetails.entityId* string variableDetails.variableId* string completeCases* number
Type CategoricalDistributionPostRequest (object)
CategoricalDistributionPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: object
config.entityId* string config.variableId* string
Type CategoricalDistributionBin (object)
CategoricalDistributionBinAdditional properties: Yes
Inherits: object
Model
Parameter Type Description label* string value* number
Type CategoricalDistributionPostResponse (object)
CategoricalDistributionPostResponseAdditional properties: Yes
Inherits: object
Model
Parameter Type Description countDistribution* array countDistribution[] object Additional properties: Yes
Inherits: object
countDistribution[].label* string countDistribution[].value* number proportionDistribution* array proportionDistribution[] object Additional properties: Yes
Inherits: object
proportionDistribution[].label* string proportionDistribution[].value* number
Type ExampleComputeVizPostRequest (object)
ExampleComputeVizPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.ExampleComputeVizSpec
config.prefixVar* object Inherits: object
config.prefixVar.entityId* string config.prefixVar.variableId* string computeConfig* object Additional properties: Yes
Inherits: object
computeConfig.inputVariable* object Inherits: object
computeConfig.inputVariable.entityId* string computeConfig.inputVariable.variableId* string computeConfig.valueSuffix* string
Type ExampleComputeVizSpec (object)
ExampleComputeVizSpecInherits: object
Model
Parameter Type Description prefixVar* object Inherits: object
prefixVar.entityId* string prefixVar.variableId* string
Type ExampleComputeVizPostResponse (object)
ExampleComputeVizPostResponseInherits: object
Model
Parameter Type Description countPluginResult* integer numEmptyValues* integer longestConcatenatedValue* string avgConcatenatedLength* number
Type MultiStreamPostRequest (object)
MultiStreamPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.MultiStreamSpec
config.entityId* string
Type MultiStreamSpec (object)
MultiStreamSpecInherits: object
Model
Parameter Type Description entityId* string
Type RecordCountPostRequest (object)
RecordCountPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.RecordCountSpec
config.entityId* string
Type RecordCountSpec (object)
RecordCountSpecInherits: object
Model
Parameter Type Description entityId* string
Type RecordCountPostResponse (object)
RecordCountPostResponseInherits: object
Model
Parameter Type Description recordCount* integer
Type TestCollectionsPostRequest (object)
TestCollectionsPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: object
config.entityId* string config.collectionId* string
Type CollectionFloatingBarplotPostRequest (object)
CollectionFloatingBarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingBarplotSpec
config.outputEntityId* string config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.overlayConfig.selectedValues array config.overlayConfig.selectedValues[] string
Type CollectionFloatingBarplotSpec (object)
CollectionFloatingBarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string overlayConfig.selectedValues array overlayConfig.selectedValues[] string
Type CollectionFloatingBoxplotPostRequest (object)
CollectionFloatingBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingBoxplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.maxAllowedDataPoints integer Format: int64
Type CollectionFloatingBoxplotSpec (object)
CollectionFloatingBoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string maxAllowedDataPoints integer Format: int64
Type CollectionFloatingContTablePostRequest (object)
CollectionFloatingContTablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingContTableSpec
config.outputEntityId* string config.xAxisVariable* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.xAxisVariable.collection* object Inherits: object
config.xAxisVariable.collection.entityId* string config.xAxisVariable.collection.collectionId* string config.xAxisVariable.selectedMembers* array config.xAxisVariable.selectedMembers[] object Inherits: object
config.xAxisVariable.selectedMembers[].entityId* string config.xAxisVariable.selectedMembers[].variableId* string config.xAxisVariable.selectedValues array config.xAxisVariable.selectedValues[] string
Type CollectionFloatingContTableSpec (object)
CollectionFloatingContTableSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
xAxisVariable.collection* object Inherits: object
xAxisVariable.collection.entityId* string xAxisVariable.collection.collectionId* string xAxisVariable.selectedMembers* array xAxisVariable.selectedMembers[] object Inherits: object
xAxisVariable.selectedMembers[].entityId* string xAxisVariable.selectedMembers[].variableId* string xAxisVariable.selectedValues array xAxisVariable.selectedValues[] string
Type CollectionFloatingHistogramPostRequest (object)
CollectionFloatingHistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingHistogramSpec
config.outputEntityId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.binSpec* object Inherits: lib.BinWidthSpec
config.binSpec.type string Enum:- binWidth
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type CollectionFloatingHistogramSpec (object)
CollectionFloatingHistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string binSpec* object Inherits: lib.BinWidthSpec
binSpec.type string Enum:- binWidth
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type CollectionFloatingLineplotPostRequest (object)
CollectionFloatingLineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.CollectionFloatingLineplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
config.overlayConfig.collection* object Inherits: object
config.overlayConfig.collection.entityId* string config.overlayConfig.collection.collectionId* string config.overlayConfig.selectedMembers* array config.overlayConfig.selectedMembers[] object Inherits: object
config.overlayConfig.selectedMembers[].entityId* string config.overlayConfig.selectedMembers[].variableId* string config.overlayConfig.selectedValues array config.overlayConfig.selectedValues[] string config.binSpec object Inherits: lib.BinWidthSpec
config.binSpec.type string Enum:- binWidth
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type CollectionFloatingLineplotSpec (object)
CollectionFloatingLineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayConfig* object Additional properties: Yes
Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection* object Inherits: object
overlayConfig.collection.entityId* string overlayConfig.collection.collectionId* string overlayConfig.selectedMembers* array overlayConfig.selectedMembers[] object Inherits: object
overlayConfig.selectedMembers[].entityId* string overlayConfig.selectedMembers[].variableId* string overlayConfig.selectedValues array overlayConfig.selectedValues[] string binSpec object Inherits: lib.BinWidthSpec
binSpec.type string Enum:- binWidth
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type StandaloneCollectionMapMarkerPostRequest (object)
StandaloneCollectionMapMarkerPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Specification for a map marker
Inherits: lib.StandaloneCollectionMapMarkerSpec
config.outputEntityId* string Entity ID associated with collection variable of interest.
config.geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number config.collection* object Collection variable to use for markers.
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
config.collection.collection* object Inherits: object
config.collection.collection.entityId* string config.collection.collection.collectionId* string config.collection.selectedMembers* array config.collection.selectedMembers[] object Inherits: object
config.collection.selectedMembers[].entityId* string config.collection.selectedMembers[].variableId* string config.aggregatorConfig* object Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.
Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.aggregatorConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type StandaloneCollectionMapMarkerSpec (object)
StandaloneCollectionMapMarkerSpecSpecification for a map marker
Inherits: object
Model
Parameter Type Description outputEntityId* string Entity ID associated with collection variable of interest.
geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number collection* object Collection variable to use for markers.
Additional properties: Yes
Inherits: lib.CollectionOverlayConfig
collection.collection* object Inherits: object
collection.collection.entityId* string collection.collection.collectionId* string collection.selectedMembers* array collection.selectedMembers[] object Inherits: object
collection.selectedMembers[].entityId* string collection.selectedMembers[].variableId* string aggregatorConfig* object Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.
Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
aggregatorConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type CollectionOverlayConfig (object)
CollectionOverlayConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description collection* object Inherits: object
collection.entityId* string collection.collectionId* string selectedMembers* array selectedMembers[] object Inherits: object
selectedMembers[].entityId* string selectedMembers[].variableId* string
Type CollectionMapMarkerElement (object)
CollectionMapMarkerElementData needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
Model
Parameter Type Description entityCount* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number values* array values[] object Additional properties: Yes
Inherits: lib.CollectionMemberAggregate
values[].variableId* string values[].value* number values[].confidenceInterval* object Inherits: lib.NumberRange
values[].confidenceInterval.min* number values[].confidenceInterval.max* number values[].n* number
Type CollectionMemberAggregate (object)
CollectionMemberAggregateAdditional properties: Yes
Inherits: object
Model
Parameter Type Description variableId* string value* number confidenceInterval* object Inherits: lib.NumberRange
confidenceInterval.min* number confidenceInterval.max* number n* number
Type StandaloneCollectionMapMarkerPostResponse (object)
StandaloneCollectionMapMarkerPostResponseInherits: object
Model
Parameter Type Description markers* array markers[] object Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
markers[].entityCount* number markers[].avgLat* number markers[].avgLon* number markers[].minLat* number markers[].minLon* number markers[].maxLat* number markers[].maxLon* number markers[].values* array markers[].values[] object Additional properties: Yes
Inherits: lib.CollectionMemberAggregate
markers[].values[].variableId* string markers[].values[].value* number markers[].values[].confidenceInterval* object Inherits: lib.NumberRange
markers[].values[].confidenceInterval.min* number markers[].values[].confidenceInterval.max* number markers[].values[].n* number
Type FloatingBarplotPostRequest (object)
FloatingBarplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingBarplotSpec
config.outputEntityId* string config.barMode* string Enum:- group
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string
Type FloatingBarplotSpec (object)
FloatingBarplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string barMode* string Enum:- group
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string
Type FloatingBarplot (object)
FloatingBarplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].label* array data[].label[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingBarplotPostResponse (object)
FloatingBarplotPostResponseInherits: object
Model
Parameter Type Description barplot* object Inherits: object
barplot.data* array barplot.data[] object Inherits: object
barplot.data[].overlayVariableDetails object Inherits: object
barplot.data[].overlayVariableDetails.entityId* string barplot.data[].overlayVariableDetails.variableId* string barplot.data[].overlayVariableDetails.value* string barplot.data[].facetVariableDetails array Max. items: 2
barplot.data[].facetVariableDetails[] object Inherits: object
barplot.data[].facetVariableDetails[].entityId* string barplot.data[].facetVariableDetails[].variableId* string barplot.data[].facetVariableDetails[].value* string barplot.data[].value* array barplot.data[].value[] number barplot.data[].label* array barplot.data[].label[] string barplot.variables* array barplot.variables[] object Inherits: object
barplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
barplot.variables[].variableSpec* object Inherits: lib.VariableSpec
barplot.variables[].variableSpec.entityId* string barplot.variables[].variableSpec.variableId* string barplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
barplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
barplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
barplot.variables[].displayName string barplot.variables[].displayRangeMin any barplot.variables[].displayRangeMax any barplot.variables[].vocabulary array barplot.variables[].vocabulary[] string barplot.variables[].imputeZero* boolean barplot.variables[].hasStudyDependentVocabulary boolean barplot.variables[].isCollection* boolean barplot.variables[].members array barplot.variables[].members[] object Inherits: lib.VariableSpec
barplot.variables[].members[].entityId* string barplot.variables[].members[].variableId* string
Type FloatingBoxplotPostRequest (object)
FloatingBoxplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingBoxplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.maxAllowedDataPoints integer Format: int64
Type FloatingBoxplotSpec (object)
FloatingBoxplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string maxAllowedDataPoints integer Format: int64
Type FloatingBoxplot (object)
FloatingBoxplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].lowerfence* array data[].lowerfence[] number data[].upperfence* array data[].upperfence[] number data[].q1* array data[].q1[] number data[].q3* array data[].q3[] number data[].median* array data[].median[] number data[].outliers array data[].outliers[] array data[].outliers[][] number data[].rawData array data[].rawData[] array data[].rawData[][] number data[].mean array data[].mean[] number data[].label* array data[].label[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingBoxplotPostResponse (object)
FloatingBoxplotPostResponseInherits: object
Model
Parameter Type Description boxplot* object Inherits: object
boxplot.data* array boxplot.data[] object Inherits: object
boxplot.data[].overlayVariableDetails object Inherits: object
boxplot.data[].overlayVariableDetails.entityId* string boxplot.data[].overlayVariableDetails.variableId* string boxplot.data[].overlayVariableDetails.value* string boxplot.data[].facetVariableDetails array Max. items: 2
boxplot.data[].facetVariableDetails[] object Inherits: object
boxplot.data[].facetVariableDetails[].entityId* string boxplot.data[].facetVariableDetails[].variableId* string boxplot.data[].facetVariableDetails[].value* string boxplot.data[].lowerfence* array boxplot.data[].lowerfence[] number boxplot.data[].upperfence* array boxplot.data[].upperfence[] number boxplot.data[].q1* array boxplot.data[].q1[] number boxplot.data[].q3* array boxplot.data[].q3[] number boxplot.data[].median* array boxplot.data[].median[] number boxplot.data[].outliers array boxplot.data[].outliers[] array boxplot.data[].outliers[][] number boxplot.data[].rawData array boxplot.data[].rawData[] array boxplot.data[].rawData[][] number boxplot.data[].mean array boxplot.data[].mean[] number boxplot.data[].label* array boxplot.data[].label[] string boxplot.variables* array boxplot.variables[] object Inherits: object
boxplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
boxplot.variables[].variableSpec* object Inherits: lib.VariableSpec
boxplot.variables[].variableSpec.entityId* string boxplot.variables[].variableSpec.variableId* string boxplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
boxplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
boxplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
boxplot.variables[].displayName string boxplot.variables[].displayRangeMin any boxplot.variables[].displayRangeMax any boxplot.variables[].vocabulary array boxplot.variables[].vocabulary[] string boxplot.variables[].imputeZero* boolean boxplot.variables[].hasStudyDependentVocabulary boolean boxplot.variables[].isCollection* boolean boxplot.variables[].members array boxplot.variables[].members[] object Inherits: lib.VariableSpec
boxplot.variables[].members[].entityId* string boxplot.variables[].members[].variableId* string
Type FloatingContTablePostRequest (object)
FloatingContTablePostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingContTableSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string
Type FloatingContTableSpec (object)
FloatingContTableSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string
Type FloatingContTable (object)
FloatingContTableInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].xLabel* array data[].xLabel[] string data[].yLabel* array data[].yLabel[] array data[].yLabel[][] string data[].value* array data[].value[] array data[].value[][] number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingContTablePostResponse (object)
FloatingContTablePostResponseInherits: object
Model
Parameter Type Description mosaic* object Inherits: object
mosaic.data* array mosaic.data[] object Inherits: object
mosaic.data[].facetVariableDetails array Max. items: 2
mosaic.data[].facetVariableDetails[] object Inherits: object
mosaic.data[].facetVariableDetails[].entityId* string mosaic.data[].facetVariableDetails[].variableId* string mosaic.data[].facetVariableDetails[].value* string mosaic.data[].xLabel* array mosaic.data[].xLabel[] string mosaic.data[].yLabel* array mosaic.data[].yLabel[] array mosaic.data[].yLabel[][] string mosaic.data[].value* array mosaic.data[].value[] array mosaic.data[].value[][] number mosaic.variables* array mosaic.variables[] object Inherits: object
mosaic.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
mosaic.variables[].variableSpec* object Inherits: lib.VariableSpec
mosaic.variables[].variableSpec.entityId* string mosaic.variables[].variableSpec.variableId* string mosaic.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
mosaic.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
mosaic.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
mosaic.variables[].displayName string mosaic.variables[].displayRangeMin any mosaic.variables[].displayRangeMax any mosaic.variables[].vocabulary array mosaic.variables[].vocabulary[] string mosaic.variables[].imputeZero* boolean mosaic.variables[].hasStudyDependentVocabulary boolean mosaic.variables[].isCollection* boolean mosaic.variables[].members array mosaic.variables[].members[] object Inherits: lib.VariableSpec
mosaic.variables[].members[].entityId* string mosaic.variables[].members[].variableId* string statsTable array statsTable[] object Inherits: object
statsTable[].facetVariableDetails array Max. items: 2
statsTable[].facetVariableDetails[] object Inherits: object
statsTable[].facetVariableDetails[].entityId* string statsTable[].facetVariableDetails[].variableId* string statsTable[].facetVariableDetails[].value* string statsTable[].chisq* object Inherits: object
statsTable[].chisq.value* number statsTable[].chisq.confidenceInterval string statsTable[].chisq.confidenceLevel number statsTable[].chisq.pvalue* string statsTable[].fisher* object Inherits: object
statsTable[].fisher.value* number statsTable[].fisher.confidenceInterval string statsTable[].fisher.confidenceLevel number statsTable[].fisher.pvalue* string statsTable[].prevalence object Inherits: object
statsTable[].prevalence.value* number statsTable[].prevalence.confidenceInterval string statsTable[].prevalence.confidenceLevel number statsTable[].prevalence.pvalue* string statsTable[].oddsratio object Inherits: object
statsTable[].oddsratio.value* number statsTable[].oddsratio.confidenceInterval string statsTable[].oddsratio.confidenceLevel number statsTable[].oddsratio.pvalue* string statsTable[].relativerisk object Inherits: object
statsTable[].relativerisk.value* number statsTable[].relativerisk.confidenceInterval string statsTable[].relativerisk.confidenceLevel number statsTable[].relativerisk.pvalue* string statsTable[].sensitivity object Inherits: object
statsTable[].sensitivity.value* number statsTable[].sensitivity.confidenceInterval string statsTable[].sensitivity.confidenceLevel number statsTable[].sensitivity.pvalue* string statsTable[].specificity object Inherits: object
statsTable[].specificity.value* number statsTable[].specificity.confidenceInterval string statsTable[].specificity.confidenceLevel number statsTable[].specificity.pvalue* string statsTable[].posPredictiveValue object Inherits: object
statsTable[].posPredictiveValue.value* number statsTable[].posPredictiveValue.confidenceInterval string statsTable[].posPredictiveValue.confidenceLevel number statsTable[].posPredictiveValue.pvalue* string statsTable[].negPredictiveValue object Inherits: object
statsTable[].negPredictiveValue.value* number statsTable[].negPredictiveValue.confidenceInterval string statsTable[].negPredictiveValue.confidenceLevel number statsTable[].negPredictiveValue.pvalue* string
Type FloatingHistogramPostRequest (object)
FloatingHistogramPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingHistogramSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.barMode* string Enum:- overlay
- stack
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.binSpec* object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type FloatingHistogramSpec (object)
FloatingHistogramSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string barMode* string Enum:- overlay
- stack
valueSpec* string Enum:- count
- proportion
Inherits: string
overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string binSpec* object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type FloatingHistogram (object)
FloatingHistogramInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].value* array data[].value[] number data[].binStart* array data[].binStart[] string data[].binEnd* array data[].binEnd[] string data[].binLabel* array data[].binLabel[] string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingHistogramPostResponse (object)
FloatingHistogramPostResponseInherits: object
Model
Parameter Type Description histogram* object Inherits: object
histogram.data* array histogram.data[] object Inherits: object
histogram.data[].overlayVariableDetails object Inherits: object
histogram.data[].overlayVariableDetails.entityId* string histogram.data[].overlayVariableDetails.variableId* string histogram.data[].overlayVariableDetails.value* string histogram.data[].facetVariableDetails array Max. items: 2
histogram.data[].facetVariableDetails[] object Inherits: object
histogram.data[].facetVariableDetails[].entityId* string histogram.data[].facetVariableDetails[].variableId* string histogram.data[].facetVariableDetails[].value* string histogram.data[].value* array histogram.data[].value[] number histogram.data[].binStart* array histogram.data[].binStart[] string histogram.data[].binEnd* array histogram.data[].binEnd[] string histogram.data[].binLabel* array histogram.data[].binLabel[] string histogram.variables* array histogram.variables[] object Inherits: object
histogram.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
histogram.variables[].variableSpec* object Inherits: lib.VariableSpec
histogram.variables[].variableSpec.entityId* string histogram.variables[].variableSpec.variableId* string histogram.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
histogram.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
histogram.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
histogram.variables[].displayName string histogram.variables[].displayRangeMin any histogram.variables[].displayRangeMax any histogram.variables[].vocabulary array histogram.variables[].vocabulary[] string histogram.variables[].imputeZero* boolean histogram.variables[].hasStudyDependentVocabulary boolean histogram.variables[].isCollection* boolean histogram.variables[].members array histogram.variables[].members[] object Inherits: lib.VariableSpec
histogram.variables[].members[].entityId* string histogram.variables[].members[].variableId* string
Type FloatingLineplotPostRequest (object)
FloatingLineplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingLineplotSpec
config.outputEntityId* string config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.yAxisNumeratorValues array config.yAxisNumeratorValues[] string config.yAxisDenominatorValues array config.yAxisDenominatorValues[] string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.binSpec object Inherits: lib.BinSpec
config.binSpec.type string Enum:- binWidth
- numBins
config.binSpec.value number config.binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
config.binSpec.range union config.binSpec.range anyOf Any of the following types. config.binSpec.range{NumberRange} object Inherits: lib.NumberRange
config.binSpec.range{NumberRange}..min* number config.binSpec.range{NumberRange}..max* number config.binSpec.range{DateRange} object Inherits: lib.DateRange
config.binSpec.range{DateRange}..min* string config.binSpec.range{DateRange}..max* string config.valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
config.errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
config.viewport object Inherits: lib.NumericViewport
config.viewport.xMin* string config.viewport.xMax* string
Type FloatingLineplotSpec (object)
FloatingLineplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string yAxisNumeratorValues array yAxisNumeratorValues[] string yAxisDenominatorValues array yAxisDenominatorValues[] string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string binSpec object Inherits: lib.BinSpec
binSpec.type string Enum:- binWidth
- numBins
binSpec.value number binSpec.units string Enum:- day
- week
- month
- year
Inherits: string
binSpec.range union binSpec.range anyOf Any of the following types. binSpec.range{NumberRange} object Inherits: lib.NumberRange
binSpec.range{NumberRange}..min* number binSpec.range{NumberRange}..max* number binSpec.range{DateRange} object Inherits: lib.DateRange
binSpec.range{DateRange}..min* string binSpec.range{DateRange}..max* string valueSpec* string Enum:- median
- mean
- geometricMean
- proportion
errorBars* string Enum:- TRUE
- FALSE
Inherits: lib.StringBoolean
viewport object Inherits: lib.NumericViewport
viewport.xMin* string viewport.xMax* string
Type FloatingLineplot (object)
FloatingLineplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].binStart array data[].binStart[] string data[].binEnd array data[].binEnd[] string data[].binSampleSize array data[].binSampleSize[] union Inherits: lib.SampleSize
data[].binSampleSize[] anyOf Any of the following types. data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
data[].binSampleSize[]{SimpleSampleSize}..N* number data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number data[].errorBars array data[].errorBars[] object Inherits: lib.ErrorBar
data[].errorBars[].lowerBound* number data[].errorBars[].upperBound* number data[].errorBars[].error* string variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingLineplotPostResponse (object)
FloatingLineplotPostResponseInherits: object
Model
Parameter Type Description lineplot* object Inherits: object
lineplot.data* array lineplot.data[] object Inherits: object
lineplot.data[].overlayVariableDetails object Inherits: object
lineplot.data[].overlayVariableDetails.entityId* string lineplot.data[].overlayVariableDetails.variableId* string lineplot.data[].overlayVariableDetails.value* string lineplot.data[].facetVariableDetails array Max. items: 2
lineplot.data[].facetVariableDetails[] object Inherits: object
lineplot.data[].facetVariableDetails[].entityId* string lineplot.data[].facetVariableDetails[].variableId* string lineplot.data[].facetVariableDetails[].value* string lineplot.data[].seriesY* array lineplot.data[].seriesY[] string lineplot.data[].seriesX* array lineplot.data[].seriesX[] string lineplot.data[].binStart array lineplot.data[].binStart[] string lineplot.data[].binEnd array lineplot.data[].binEnd[] string lineplot.data[].binSampleSize array lineplot.data[].binSampleSize[] union Inherits: lib.SampleSize
lineplot.data[].binSampleSize[] anyOf Any of the following types. lineplot.data[].binSampleSize[]{SimpleSampleSize} object Inherits: lib.SimpleSampleSize
lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* number lineplot.data[].binSampleSize[]{ProportionSampleSize} object Inherits: lib.ProportionSampleSize
lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* number lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* number lineplot.data[].errorBars array lineplot.data[].errorBars[] object Inherits: lib.ErrorBar
lineplot.data[].errorBars[].lowerBound* number lineplot.data[].errorBars[].upperBound* number lineplot.data[].errorBars[].error* string lineplot.variables* array lineplot.variables[] object Inherits: object
lineplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
lineplot.variables[].variableSpec* object Inherits: lib.VariableSpec
lineplot.variables[].variableSpec.entityId* string lineplot.variables[].variableSpec.variableId* string lineplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
lineplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
lineplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
lineplot.variables[].displayName string lineplot.variables[].displayRangeMin any lineplot.variables[].displayRangeMax any lineplot.variables[].vocabulary array lineplot.variables[].vocabulary[] string lineplot.variables[].imputeZero* boolean lineplot.variables[].hasStudyDependentVocabulary boolean lineplot.variables[].isCollection* boolean lineplot.variables[].members array lineplot.variables[].members[] object Inherits: lib.VariableSpec
lineplot.variables[].members[].entityId* string lineplot.variables[].members[].variableId* string
Type FloatingScatterplotPostRequest (object)
FloatingScatterplotPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.FloatingScatterplotSpec
config.outputEntityId* string config.valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
config.xAxisVariable* object Inherits: object
config.xAxisVariable.entityId* string config.xAxisVariable.variableId* string config.yAxisVariable* object Inherits: object
config.yAxisVariable.entityId* string config.yAxisVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.maxAllowedDataPoints integer Format: int64
Type FloatingScatterplotSpec (object)
FloatingScatterplotSpecInherits: object
Model
Parameter Type Description outputEntityId* string valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string yAxisVariable* object Inherits: object
yAxisVariable.entityId* string yAxisVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string maxAllowedDataPoints integer Format: int64
Type FloatingScatterplot (object)
FloatingScatterplotInherits: object
Model
Parameter Type Description data* array data[] object Inherits: object
data[].overlayVariableDetails object Inherits: object
data[].overlayVariableDetails.entityId* string data[].overlayVariableDetails.variableId* string data[].overlayVariableDetails.value* string data[].facetVariableDetails array Max. items: 2
data[].facetVariableDetails[] object Inherits: object
data[].facetVariableDetails[].entityId* string data[].facetVariableDetails[].variableId* string data[].facetVariableDetails[].value* string data[].seriesY* array data[].seriesY[] string data[].seriesX* array data[].seriesX[] string data[].smoothedMeanX array data[].smoothedMeanX[] string data[].smoothedMeanY array data[].smoothedMeanY[] number data[].smoothedMeanSE array data[].smoothedMeanSE[] number data[].smoothedMeanError string data[].bestFitLineX array data[].bestFitLineX[] string data[].bestFitLineY array data[].bestFitLineY[] number data[].r2 number variables* array variables[] object Inherits: object
variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
variables[].variableSpec* object Inherits: lib.VariableSpec
variables[].variableSpec.entityId* string variables[].variableSpec.variableId* string variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
variables[].displayName string variables[].displayRangeMin any variables[].displayRangeMax any variables[].vocabulary array variables[].vocabulary[] string variables[].imputeZero* boolean variables[].hasStudyDependentVocabulary boolean variables[].isCollection* boolean variables[].members array variables[].members[] object Inherits: lib.VariableSpec
variables[].members[].entityId* string variables[].members[].variableId* string
Type FloatingScatterplotPostResponse (object)
FloatingScatterplotPostResponseInherits: object
Model
Parameter Type Description scatterplot* object Inherits: object
scatterplot.data* array scatterplot.data[] object Inherits: object
scatterplot.data[].overlayVariableDetails object Inherits: object
scatterplot.data[].overlayVariableDetails.entityId* string scatterplot.data[].overlayVariableDetails.variableId* string scatterplot.data[].overlayVariableDetails.value* string scatterplot.data[].facetVariableDetails array Max. items: 2
scatterplot.data[].facetVariableDetails[] object Inherits: object
scatterplot.data[].facetVariableDetails[].entityId* string scatterplot.data[].facetVariableDetails[].variableId* string scatterplot.data[].facetVariableDetails[].value* string scatterplot.data[].seriesY* array scatterplot.data[].seriesY[] string scatterplot.data[].seriesX* array scatterplot.data[].seriesX[] string scatterplot.data[].smoothedMeanX array scatterplot.data[].smoothedMeanX[] string scatterplot.data[].smoothedMeanY array scatterplot.data[].smoothedMeanY[] number scatterplot.data[].smoothedMeanSE array scatterplot.data[].smoothedMeanSE[] number scatterplot.data[].smoothedMeanError string scatterplot.data[].bestFitLineX array scatterplot.data[].bestFitLineX[] string scatterplot.data[].bestFitLineY array scatterplot.data[].bestFitLineY[] number scatterplot.data[].r2 number scatterplot.variables* array scatterplot.variables[] object Inherits: object
scatterplot.variables[].variableClass* string Enum:- native
- derived
- computed
Inherits: string
scatterplot.variables[].variableSpec* object Inherits: lib.VariableSpec
scatterplot.variables[].variableSpec.entityId* string scatterplot.variables[].variableSpec.variableId* string scatterplot.variables[].plotReference* string Enum:- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
scatterplot.variables[].dataType* string Enum:- category
- string
- number
- date
- longitude
- integer
Inherits: lib.API_VariableType
scatterplot.variables[].dataShape* string Enum:- continuous
- categorical
- ordinal
- binary
Inherits: lib.API_VariableDataShape
scatterplot.variables[].displayName string scatterplot.variables[].displayRangeMin any scatterplot.variables[].displayRangeMax any scatterplot.variables[].vocabulary array scatterplot.variables[].vocabulary[] string scatterplot.variables[].imputeZero* boolean scatterplot.variables[].hasStudyDependentVocabulary boolean scatterplot.variables[].isCollection* boolean scatterplot.variables[].members array scatterplot.variables[].members[] object Inherits: lib.VariableSpec
scatterplot.variables[].members[].entityId* string scatterplot.variables[].members[].variableId* string
Type StandaloneMapBubblesLegendPostRequest (object)
StandaloneMapBubblesLegendPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.StandaloneMapBubblesLegendSpec
config.outputEntityId* string config.colorLegendConfig* object Inherits: lib.OverlayLegendConfig
config.colorLegendConfig.geoAggregateVariable* object Inherits: object
config.colorLegendConfig.geoAggregateVariable.entityId* string config.colorLegendConfig.geoAggregateVariable.variableId* string config.colorLegendConfig.quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* object Inherits: object
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* string config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* string config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.sizeConfig* object Inherits: lib.SizeLegendConfig
config.sizeConfig.geoAggregateVariable* object Inherits: object
config.sizeConfig.geoAggregateVariable.entityId* string config.sizeConfig.geoAggregateVariable.variableId* string
Type StandaloneMapBubblesLegendSpec (object)
StandaloneMapBubblesLegendSpecInherits: object
Model
Parameter Type Description outputEntityId* string colorLegendConfig* object Inherits: lib.OverlayLegendConfig
colorLegendConfig.geoAggregateVariable* object Inherits: object
colorLegendConfig.geoAggregateVariable.entityId* string colorLegendConfig.geoAggregateVariable.variableId* string colorLegendConfig.quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
colorLegendConfig.quantitativeOverlayConfig.overlayVariable* object Inherits: object
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* string colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* string colorLegendConfig.quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
sizeConfig* object Inherits: lib.SizeLegendConfig
sizeConfig.geoAggregateVariable* object Inherits: object
sizeConfig.geoAggregateVariable.entityId* string sizeConfig.geoAggregateVariable.variableId* string
Type OverlayLegendConfig (object)
OverlayLegendConfigInherits: object
Model
Parameter Type Description geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string quantitativeOverlayConfig* object Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
quantitativeOverlayConfig.overlayVariable* object Inherits: object
quantitativeOverlayConfig.overlayVariable.entityId* string quantitativeOverlayConfig.overlayVariable.variableId* string quantitativeOverlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
quantitativeOverlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
Type SizeLegendConfig (object)
SizeLegendConfigInherits: object
Model
Parameter Type Description geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string
Type StandaloneMapBubblesLegendPostResponse (object)
StandaloneMapBubblesLegendPostResponseInherits: object
Model
Parameter Type Description minColorValue* string maxColorValue* string minSizeValue* number maxSizeValue* number
Type StandaloneMapBubblesPostRequest (object)
StandaloneMapBubblesPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Specification for map bubbles.
Inherits: lib.StandaloneMapBubblesSpec
config.outputEntityId* string Entity whose cardinality will be reported per marker.
config.geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.overlayConfig object Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.
Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.overlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
config.overlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type StandaloneMapBubblesSpec (object)
StandaloneMapBubblesSpecSpecification for map bubbles.
Inherits: object
Model
Parameter Type Description outputEntityId* string Entity whose cardinality will be reported per marker.
geoAggregateVariable* object Geohash component variable to group markers by. This is usually determined by zoom level of the client application.
Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Variable representing longitude of output entity.
Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Variable representing latitude of output entity.
Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string overlayConfig object Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.
Additional properties: Yes
Inherits: lib.QuantitativeOverlayConfig
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string overlayConfig.aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
overlayConfig.aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
valueSpec* string Enum:- count
- proportion
Inherits: string
viewport* object Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.
Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type StandaloneMapBubblesPostResponse (object)
StandaloneMapBubblesPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.ColoredMapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].overlayValue* string mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number
Type ColoredMapElementInfo (object)
ColoredMapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number overlayValue* string avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type StandaloneMapMarkersPostRequest (object)
StandaloneMapMarkersPostRequestInherits: lib.DataPluginRequestBase
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
config* object Inherits: lib.StandaloneMapMarkersSpec
config.outputEntityId* string config.geoAggregateVariable* object Inherits: object
config.geoAggregateVariable.entityId* string config.geoAggregateVariable.variableId* string config.longitudeVariable* object Inherits: object
config.longitudeVariable.entityId* string config.longitudeVariable.variableId* string config.latitudeVariable* object Inherits: object
config.latitudeVariable.entityId* string config.latitudeVariable.variableId* string config.overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
config.overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
config.overlayConfig.overlayVariable* object Inherits: object
config.overlayConfig.overlayVariable.entityId* string config.overlayConfig.overlayVariable.variableId* string config.valueSpec* string Enum:- count
- proportion
Inherits: string
config.viewport* object Inherits: lib.GeolocationViewport
config.viewport.latitude* object Inherits: lib.NumericViewport
config.viewport.latitude.xMin* string config.viewport.latitude.xMax* string config.viewport.longitude* object Inherits: lib.LongitudeViewport
config.viewport.longitude.left* number config.viewport.longitude.right* number
Type StandaloneMapMarkersSpec (object)
StandaloneMapMarkersSpecInherits: object
Model
Parameter Type Description outputEntityId* string geoAggregateVariable* object Inherits: object
geoAggregateVariable.entityId* string geoAggregateVariable.variableId* string longitudeVariable* object Inherits: object
longitudeVariable.entityId* string longitudeVariable.variableId* string latitudeVariable* object Inherits: object
latitudeVariable.entityId* string latitudeVariable.variableId* string overlayConfig object Discriminator: overlayType
Inherits: lib.OverlayConfig
overlayConfig.overlayType* string Enum:- continuous
- categorical
Inherits: lib.OverlayType
overlayConfig.overlayVariable* object Inherits: object
overlayConfig.overlayVariable.entityId* string overlayConfig.overlayVariable.variableId* string valueSpec* string Enum:- count
- proportion
Inherits: string
viewport* object Inherits: lib.GeolocationViewport
viewport.latitude* object Inherits: lib.NumericViewport
viewport.latitude.xMin* string viewport.latitude.xMax* string viewport.longitude* object Inherits: lib.LongitudeViewport
viewport.longitude.left* number viewport.longitude.right* number
Type StandaloneMapMarkersPostResponse (object)
StandaloneMapMarkersPostResponseInherits: object
Model
Parameter Type Description mapElements* array mapElements[] object Inherits: lib.StandaloneMapElementInfo
mapElements[].geoAggregateValue* string mapElements[].entityCount* number mapElements[].overlayValues* array mapElements[].overlayValues[] object Inherits: lib.LegacyLabeledRangeWithCountAndValue
mapElements[].overlayValues[].binStart* string mapElements[].overlayValues[].binEnd* string mapElements[].overlayValues[].binLabel* string mapElements[].overlayValues[].value* number mapElements[].overlayValues[].count* number mapElements[].avgLat* number mapElements[].avgLon* number mapElements[].minLat* number mapElements[].minLon* number mapElements[].maxLat* number mapElements[].maxLon* number
Type OverlayType (string)
OverlayTypeEnum:- continuous
- categorical
Inherits: string
Type OverlayConfig (object)
OverlayConfigDiscriminator: overlayType
Inherits: object
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string
Type ContinousOverlayConfig (object)
ContinousOverlayConfigModel
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string overlayValues* array overlayValues[] object Inherits: lib.LegacyLabeledRange
overlayValues[].binStart* string overlayValues[].binEnd* string overlayValues[].binLabel* string
Type CategoricalOverlayConfig (object)
CategoricalOverlayConfigModel
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string overlayValues* array overlayValues[] string
Type StandaloneMapElementInfo (object)
StandaloneMapElementInfoInherits: object
Model
Parameter Type Description geoAggregateValue* string entityCount* number overlayValues* array overlayValues[] object Inherits: lib.LegacyLabeledRangeWithCountAndValue
overlayValues[].binStart* string overlayValues[].binEnd* string overlayValues[].binLabel* string overlayValues[].value* number overlayValues[].count* number avgLat* number avgLon* number minLat* number minLon* number maxLat* number maxLon* number
Type DataPluginRequestBase (object)
DataPluginRequestBaseInherits: object
Model
Parameter Type Description studyId* string filters array filters[] object Additional properties: Yes
Discriminator: type
Inherits: object
filters[].entityId* string filters[].type* string Enum:- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: lib.API_FilterType
derivedVariables array derivedVariables[] object Inherits: lib.VariableSpec
derivedVariables[].entityId* string derivedVariables[].variableId* string derivedVariables[].functionName* string derivedVariables[].displayName* string derivedVariables[].config* object Additional properties: Yes
Type EmptyDataPluginSpec (object)
EmptyDataPluginSpecInherits: object
Model
Parameter Type Description
Type StringBoolean (string)
StringBooleanEnum:- TRUE
- FALSE
Inherits: string
Type StrataVariableDetails (object)
StrataVariableDetailsInherits: lib.VariableSpec
Model
Parameter Type Description entityId* string variableId* string value* string
Type BinSpec (object)
BinSpecInherits: object
Model
Parameter Type Description type string Enum:- binWidth
- numBins
value number units string Enum:- day
- week
- month
- year
Inherits: string
range union range anyOf Any of the following types. range{NumberRange} object Inherits: lib.NumberRange
range{NumberRange}..min* number range{NumberRange}..max* number range{DateRange} object Inherits: lib.DateRange
range{DateRange}..min* string range{DateRange}..max* string
Type BinWidthSpec (object)
BinWidthSpecInherits: object
Model
Parameter Type Description type string Enum:- binWidth
value number units string Enum:- day
- week
- month
- year
Inherits: string
range union range anyOf Any of the following types. range{NumberRange} object Inherits: lib.NumberRange
range{NumberRange}..min* number range{NumberRange}..max* number range{DateRange} object Inherits: lib.DateRange
range{DateRange}..min* string range{DateRange}..max* string
Type NumberRange (object)
NumberRangeInherits: object
Model
Parameter Type Description min* number max* number
Type DateRange (object)
DateRangeInherits: object
Model
Parameter Type Description min* string max* string
Type NumericViewport (object)
NumericViewportInherits: object
Model
Parameter Type Description xMin* string xMax* string
Type LongitudeViewport (object)
LongitudeViewportInherits: object
Model
Parameter Type Description left* number right* number
Type GeolocationViewport (object)
GeolocationViewportInherits: object
Model
Parameter Type Description latitude* object Inherits: object
latitude.xMin* string latitude.xMax* string longitude* object Inherits: object
longitude.left* number longitude.right* number
Type ErrorBar (object)
ErrorBarInherits: object
Model
Parameter Type Description lowerBound* number upperBound* number error* string
Type SimpleSampleSize (object)
SimpleSampleSizeInherits: object
Model
Parameter Type Description N* number
Type ProportionSampleSize (object)
ProportionSampleSizeInherits: object
Model
Parameter Type Description numeratorN* number denominatorN* number
Type SampleSize (union)
SampleSizeInherits: lib.SimpleSampleSize | lib.ProportionSampleSize
Model
Parameter Type Description anyOf Any of the following types. {SimpleSampleSize} object Inherits: object
{SimpleSampleSize}.N* number {ProportionSampleSize} object Inherits: object
{ProportionSampleSize}.numeratorN* number {ProportionSampleSize}.denominatorN* number
Type ShowMissingness (string)
ShowMissingnessEnum:- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type ShowMissingnessNoAxes (string)
ShowMissingnessNoAxesEnum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type BoxplotWith1ComputeSpec (object)
BoxplotWith1ComputeSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
points* string Enum:- outliers
- all
mean* string Enum:- TRUE
- FALSE
Inherits: string
computeStats* string Enum:- TRUE
- FALSE
Inherits: string
xAxisVariable object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type ScatterplotWith1ComputeSpec (object)
ScatterplotWith1ComputeSpecInherits: object
Model
Parameter Type Description outputEntityId* string showMissingness string Enum:- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
valueSpec* string Enum:- raw
- smoothedMeanWithRaw
- bestFitLineWithRaw
xAxisVariable* object Inherits: object
xAxisVariable.entityId* string xAxisVariable.variableId* string overlayVariable object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string facetVariable array Max. items: 2
facetVariable[] object Inherits: object
facetVariable[].entityId* string facetVariable[].variableId* string
Type Aggregator (string)
AggregatorEnum:- mean
- median
Inherits: string
Type QuantitativeOverlayConfig (object)
QuantitativeOverlayConfigAdditional properties: Yes
Inherits: object
Model
Parameter Type Description overlayVariable* object Inherits: object
overlayVariable.entityId* string overlayVariable.variableId* string aggregationConfig* object Discriminator: overlayType
Inherits: lib.QuantitativeAggregationConfig
aggregationConfig.overlayType* string Enum:- continuous
- categorical
Inherits: string
Type QuantitativeAggregationConfig (object)
QuantitativeAggregationConfigDiscriminator: overlayType
Inherits: object
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
Type ContinuousAggregationConfig (object)
ContinuousAggregationConfigDiscriminator: overlayType
Discriminator value: continuous
Inherits: lib.QuantitativeAggregationConfig
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
aggregator* string Enum:- mean
- median
Inherits: string
Type CategoricalAggregationConfig (object)
CategoricalAggregationConfigDiscriminator: overlayType
Discriminator value: categorical
Inherits: lib.QuantitativeAggregationConfig
Model
Parameter Type Description overlayType* string Enum:- continuous
- categorical
Inherits: string
numeratorValues* array numeratorValues[] string denominatorValues* array denominatorValues[] string
Type CollectionOverlayConfigWithValues (object)
CollectionOverlayConfigWithValuesAdditional properties: Yes
Inherits: lib.CollectionOverlayConfig
Model
Parameter Type Description collection* object Inherits: object
collection.entityId* string collection.collectionId* string selectedMembers* array selectedMembers[] object Inherits: object
selectedMembers[].entityId* string selectedMembers[].variableId* string selectedValues array selectedValues[] string
Type LegacyLabeledRange (object)
LegacyLabeledRangeInherits: object
Model
Parameter Type Description binStart* string binEnd* string binLabel* string
Type LegacyLabeledRangeWithCountAndValue (object)
LegacyLabeledRangeWithCountAndValueInherits: lib.LegacyLabeledRange
Model
Parameter Type Description binStart* string binEnd* string binLabel* string value* number count* number
Type Error (object)
ErrorDiscriminator: status
Inherits: object
Model
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: error.ErrorType
message* string
Type ErrorType (string)
ErrorTypeEnum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: string
Type BadRequestError (object)
Bad RequestRequest could not be parsed or was otherwise unusable.
Discriminator: status
Discriminator value: bad-request
Inherits: error.Error
Model
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: error.ErrorType
message* string
Examples
{
"status": "bad-request",
"message": "malformed JSON"
}
Type UnauthorizedError (object)
UnauthorizedUnauthenticated client requested a resource that requires authentication.
Discriminator: status
Discriminator value: unauthorized
Inherits: error.Error
Model
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: error.ErrorType
message* string
Examples
{