EDA Workspace Data Service API vv1.0.0

Resources

Inherits: object

Parameter	Type	Description
studies*	array
studies[]	object	Additional properties: Yes Inherits: lib.API_StudyOverview
studies[].id*	string
studies[].datasetId*	string
studies[].sha1hash*	string
studies[].sourceType*	string	Enum: curated user_submitted Inherits: lib.StudySourceType
studies[].displayName*	string
studies[].shortDisplayName*	string
studies[].lastModified*	datetime
studies[].description*	string

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest

curl -X GET \
  undefined/studies/{study-id}

Inherits: object

Parameter	Type	Description
study*	object	Additional properties: Yes Inherits: lib.API_StudyDetail
study.id*	string
study.isUserStudy*	boolean
study.hasMap*	boolean
study.rootEntity*	object	Additional properties: Yes Inherits: lib.API_Entity
study.rootEntity.id*	string
study.rootEntity.idColumnName*	string
study.rootEntity.displayName*	string
study.rootEntity.displayNamePlural*	string
study.rootEntity.description*	string
study.rootEntity.isManyToOneWithParent*	boolean
study.rootEntity.variables*	array
study.rootEntity.variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
study.rootEntity.variables[].id*	string
study.rootEntity.variables[].parentId	string
study.rootEntity.variables[].providerLabel*	string
study.rootEntity.variables[].displayName*	string
study.rootEntity.variables[].definition	string
study.rootEntity.variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
study.rootEntity.variables[].displayOrder	integer	Format: int64
study.rootEntity.variables[].isCategory*	string
study.rootEntity.variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
study.rootEntity.variables[].hideFrom*	array
study.rootEntity.variables[].hideFrom[]	string
study.rootEntity.collections*	array
study.rootEntity.collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
study.rootEntity.collections[].id*	string
study.rootEntity.collections[].displayName*	string
study.rootEntity.collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
study.rootEntity.collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
study.rootEntity.collections[].vocabulary	array
study.rootEntity.collections[].vocabulary[]	string
study.rootEntity.collections[].distinctValuesCount	integer	Format: int64
study.rootEntity.collections[].memberVariableIds*	array
study.rootEntity.collections[].memberVariableIds[]	string
study.rootEntity.collections[].imputeZero*	boolean
study.rootEntity.collections[].normalizationMethod*	string
study.rootEntity.collections[].isCompositional*	boolean
study.rootEntity.collections[].isProportion*	boolean
study.rootEntity.collections[].variableSpecToImputeZeroesFor	object	Inherits: object
study.rootEntity.collections[].variableSpecToImputeZeroesFor.entityId*	string
study.rootEntity.collections[].variableSpecToImputeZeroesFor.variableId*	string
study.rootEntity.collections[].member*	string
study.rootEntity.collections[].memberPlural*	string
study.rootEntity.children	array
study.rootEntity.children[]	$recur

Returns entity details, not including its children (which it may or may not have; see study endpoint)

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest
entity-id*	string	ID of the entity of interest

curl -X GET \
  undefined/studies/{study-id}/entities/{entity-id}

Additional properties: Yes

Inherits: object

Parameter	Type	Description
id*	string
idColumnName*	string
displayName*	string
displayNamePlural*	string
description*	string
isManyToOneWithParent*	boolean
variables*	array
variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
variables[].id*	string
variables[].parentId	string
variables[].providerLabel*	string
variables[].displayName*	string
variables[].definition	string
variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
variables[].displayOrder	integer	Format: int64
variables[].isCategory*	string
variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
variables[].hideFrom*	array
variables[].hideFrom[]	string
collections*	array
collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
collections[].id*	string
collections[].displayName*	string
collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
collections[].vocabulary	array
collections[].vocabulary[]	string
collections[].distinctValuesCount	integer	Format: int64
collections[].memberVariableIds*	array
collections[].memberVariableIds[]	string
collections[].imputeZero*	boolean
collections[].normalizationMethod*	string
collections[].isCompositional*	boolean
collections[].isProportion*	boolean
collections[].variableSpecToImputeZeroesFor	object	Inherits: object
collections[].variableSpecToImputeZeroesFor.entityId*	string
collections[].variableSpecToImputeZeroesFor.variableId*	string
collections[].member*	string
collections[].memberPlural*	string

Return a count of entities in this subset. In the request, filters must be a subclass of Filter

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest
entity-id*	string	ID of the entity of interest

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/studies/{study-id}/entities/{entity-id}/count

Inherits: object

Parameter	Type	Description
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

Inherits: object

Parameter	Type	Description
count*	integer	Format: int64

Return a tabular report of one or more variables belonging to this entity. The output will also include all ancestor primary keys. In the request, filters must be a subclass of Filter

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest
entity-id*	string	ID of the entity of interest

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/studies/{study-id}/entities/{entity-id}/tabular

Inherits: object

Parameter	Type	Description
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
outputVariableIds*	array
outputVariableIds[]	string
reportConfig	object	Additional properties: Yes Inherits: object
reportConfig.sorting	array
reportConfig.sorting[]	object	Inherits: object
reportConfig.sorting[].key*	string
reportConfig.sorting[].direction*	string	Enum: asc desc Inherits: string
reportConfig.paging	object	Additional properties: Yes Inherits: object
reportConfig.paging.numRows	integer	Format: int64
reportConfig.paging.offset	integer	Format: int64
reportConfig.headerFormat	string	Enum: standard display Inherits: string
reportConfig.trimTimeFromDateVars	boolean
reportConfig.dataSource	string	Enum: database file Inherits: string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest
entity-id*	string	ID of the entity of interest
variable-id*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/studies/{study-id}/entities/{entity-id}/variables/{variable-id}/root-vocab

Inherits: object

Parameter	Type	Description
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

Inherits: lib.EntityTabularPostResponse

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Return the count of entities in the subset that have a value for this variable, and | a distribution for this variable, i.e., entity counts for each value of this | variable. In the request, filters must be a subclass of Filter

Parameters

Parameter	Type	Description
Path
study-id*	string	ID of the study of interest
entity-id*	string	ID of the entity of interest
variable-id*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/studies/{study-id}/entities/{entity-id}/variables/{variable-id}/distribution

Inherits: object

Parameter	Type	Description
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
binSpec	object	Inherits: object
binSpec.displayRangeMin*	any
binSpec.displayRangeMax*	any
binSpec.binWidth*	number
binSpec.binUnits	string	Enum: day week month year Inherits: string
valueSpec*	string	Enum: count proportion Inherits: string

Inherits: object

Parameter	Type	Description
histogram*	array
histogram[]	object	Inherits: object
histogram[].value*	number
histogram[].binStart*	string
histogram[].binEnd*	string
histogram[].binLabel*	string
statistics*	object	Inherits: object
statistics.subsetSize*	integer	Format: int64
statistics.subsetMin	any
statistics.subsetMax	any
statistics.subsetMean	any
statistics.numVarValues*	integer	Format: int64
statistics.numDistinctValues*	integer	Format: int64
statistics.numDistinctEntityRecords*	integer	Format: int64
statistics.numMissingCases*	integer	Format: int64

Return a count of entities in this subset. In the request, filters must be a subclass of Filter

Parameters

Parameter	Type	Description
Path
study-id*	string
entity-id*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/ss-internal/studies/{study-id}/entities/{entity-id}/count

Inherits: object

Parameter	Type	Description
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

Inherits: object

Parameter	Type	Description
count*	integer	Format: int64

Return a tabular report of one or more variables belonging to this entity. The output will also include all ancestor primary keys. In the request, filters must be a subclass of Filter

Parameters

Parameter	Type	Description
Path
study-id*	string
entity-id*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/ss-internal/studies/{study-id}/entities/{entity-id}/tabular

Inherits: object

Parameter	Type	Description
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
outputVariableIds*	array
outputVariableIds[]	string
reportConfig	object	Additional properties: Yes Inherits: object
reportConfig.sorting	array
reportConfig.sorting[]	object	Inherits: object
reportConfig.sorting[].key*	string
reportConfig.sorting[].direction*	string	Enum: asc desc Inherits: string
reportConfig.paging	object	Additional properties: Yes Inherits: object
reportConfig.paging.numRows	integer	Format: int64
reportConfig.paging.offset	integer	Format: int64
reportConfig.headerFormat	string	Enum: standard display Inherits: string
reportConfig.trimTimeFromDateVars	boolean
reportConfig.dataSource	string	Enum: database file Inherits: string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Parameters

Parameter	Type	Description
Path
study-id*	string
entity-id*	string
variable-id*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/ss-internal/studies/{study-id}/entities/{entity-id}/variables/{variable-id}/distribution

Inherits: object

Parameter	Type	Description
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
binSpec	object	Inherits: object
binSpec.displayRangeMin*	any
binSpec.displayRangeMax*	any
binSpec.binWidth*	number
binSpec.binUnits	string	Enum: day week month year Inherits: string
valueSpec*	string	Enum: count proportion Inherits: string

Inherits: object

Parameter	Type	Description
histogram*	array
histogram[]	object	Inherits: object
histogram[].value*	number
histogram[].binStart*	string
histogram[].binEnd*	string
histogram[].binLabel*	string
statistics*	object	Inherits: object
statistics.subsetSize*	integer	Format: int64
statistics.subsetMin	any
statistics.subsetMax	any
statistics.subsetMean	any
statistics.numVarValues*	integer	Format: int64
statistics.numDistinctValues*	integer	Format: int64
statistics.numDistinctEntityRecords*	integer	Format: int64
statistics.numMissingCases*	integer	Format: int64

Additional properties: Yes

Inherits: object

Parameter	Type	Description
mean*	object	Additional properties: Yes Inherits: lib.SingleNumericVarReductionConfig
mean.inputVariable*	object	Inherits: object
mean.inputVariable.entityId*	string
mean.inputVariable.variableId*	string
mean.imputeZero	boolean
sum*	object	Additional properties: Yes Inherits: lib.SingleNumericVarReductionConfig
sum.inputVariable*	object	Inherits: object
sum.inputVariable.entityId*	string
sum.inputVariable.variableId*	string
sum.imputeZero	boolean
concatenation*	object	Additional properties: Yes Inherits: lib.ConcatenationConfig
concatenation.prefix	string
concatenation.delimiter	string
concatenation.suffix	string
concatenation.inputVariables*	array
concatenation.inputVariables[]	object	Inherits: object
concatenation.inputVariables[].entityId*	string
concatenation.inputVariables[].variableId*	string
subsetMembership*	object	Additional properties: Yes Inherits: lib.SubsetMembershipConfig
subsetMembership.subsetFilters*	array
subsetMembership.subsetFilters[]	object	Additional properties: Yes Discriminator: type Inherits: object
subsetMembership.subsetFilters[].entityId*	string
subsetMembership.subsetFilters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
advancedSubset*	object	Additional properties: Yes Inherits: lib.AdvancedSubsetConfig
advancedSubset.rootStepKey*	string
advancedSubset.steps*	array
advancedSubset.steps[]	object	Additional properties: Yes Inherits: lib.Step
advancedSubset.steps[].key*	string
advancedSubset.steps[].operation*	string	Enum: intersect union minus Inherits: lib.SetOperation
advancedSubset.steps[].leftStepKey	string
advancedSubset.steps[].leftVariable	object	Inherits: object
advancedSubset.steps[].leftVariable.entityId*	string
advancedSubset.steps[].leftVariable.variableId*	string
advancedSubset.steps[].leftVariableTrueValues	array
advancedSubset.steps[].leftVariableTrueValues[]	string
advancedSubset.steps[].rightStepKey	string
advancedSubset.steps[].rightVariable	object	Inherits: object
advancedSubset.steps[].rightVariable.entityId*	string
advancedSubset.steps[].rightVariable.variableId*	string
advancedSubset.steps[].rightVariableTrueValues	array
advancedSubset.steps[].rightVariableTrueValues[]	string
unitConversion*	object	Additional properties: Yes Inherits: lib.UnitConversionConfig
unitConversion.inputVariable*	object	Inherits: object
unitConversion.inputVariable.entityId*	string
unitConversion.inputVariable.variableId*	string
unitConversion.outputUnits*	string
bodyMassIndex*	object	Additional properties: Yes Inherits: lib.BodyMassIndexConfig
bodyMassIndex.heightVariable*	object	Inherits: object
bodyMassIndex.heightVariable.entityId*	string
bodyMassIndex.heightVariable.variableId*	string
bodyMassIndex.weightVariable*	object	Inherits: object
bodyMassIndex.weightVariable.entityId*	string
bodyMassIndex.weightVariable.variableId*	string
categoricalRecoding*	object	Additional properties: Yes Inherits: lib.CategoricalRecodingConfig
categoricalRecoding.inputVariable*	object	Inherits: object
categoricalRecoding.inputVariable.entityId*	string
categoricalRecoding.inputVariable.variableId*	string
categoricalRecoding.rules*	array
categoricalRecoding.rules[]	object	Additional properties: Yes Inherits: lib.CategoricalRecodingRule
categoricalRecoding.rules[].inputValues*	array
categoricalRecoding.rules[].inputValues[]	string
categoricalRecoding.rules[].outputValue*	string
categoricalRecoding.unmappedValue	string
continuousToOrdinal*	object	Additional properties: Yes Inherits: lib.ContinuousNumericRecodingConfig
continuousToOrdinal.inputVariable*	object	Inherits: object
continuousToOrdinal.inputVariable.entityId*	string
continuousToOrdinal.inputVariable.variableId*	string
continuousToOrdinal.rules*	array
continuousToOrdinal.rules[]	object	Additional properties: Yes Inherits: lib.ContinuousNumericRule
continuousToOrdinal.rules[].minInclusive	number
continuousToOrdinal.rules[].maxExclusive	number
continuousToOrdinal.rules[].outputValue*	string
continuousToOrdinal.unmappedValue	string
ecmaScriptExpressionEval*	object	Additional properties: Yes Inherits: lib.EcmaScriptExpressionEvalConfig
ecmaScriptExpressionEval.ecmaScriptExpression*	string
ecmaScriptExpressionEval.nullResultOnAnyMissingInput*	boolean
ecmaScriptExpressionEval.inputVariables*	array
ecmaScriptExpressionEval.inputVariables[]	object	Additional properties: Yes Inherits: lib.VariableReference
ecmaScriptExpressionEval.inputVariables[].name*	string
ecmaScriptExpressionEval.inputVariables[].variable*	object	Inherits: object
ecmaScriptExpressionEval.inputVariables[].variable.entityId*	string
ecmaScriptExpressionEval.inputVariables[].variable.variableId*	string
ecmaScriptExpressionEval.expectedType*	string	Enum: category string number date longitude integer Inherits: string
ecmaScriptExpressionEval.expectedShape*	string	Enum: continuous categorical ordinal binary Inherits: string
relativeObservationMinTimeInterval*	object	Additional properties: Yes Inherits: lib.RelatedObservationMinTimeIntervalConfig
relativeObservationMinTimeInterval.relatedObservationsSubset*	array
relativeObservationMinTimeInterval.relatedObservationsSubset[]	object	Additional properties: Yes Discriminator: type Inherits: object
relativeObservationMinTimeInterval.relatedObservationsSubset[].entityId*	string
relativeObservationMinTimeInterval.relatedObservationsSubset[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
relativeObservationMinTimeInterval.anchorVariable*	object	Inherits: object
relativeObservationMinTimeInterval.anchorVariable.entityId*	string
relativeObservationMinTimeInterval.anchorVariable.variableId*	string
relativeObservationMinTimeInterval.anchorVariableTrueValues*	array
relativeObservationMinTimeInterval.anchorVariableTrueValues[]	string
relativeObservationMinTimeInterval.anchorTimestampVariable*	object	Inherits: object
relativeObservationMinTimeInterval.anchorTimestampVariable.entityId*	string
relativeObservationMinTimeInterval.anchorTimestampVariable.variableId*	string
relativeObservationMinTimeInterval.targetVariable*	object	Inherits: object
relativeObservationMinTimeInterval.targetVariable.entityId*	string
relativeObservationMinTimeInterval.targetVariable.variableId*	string
relativeObservationMinTimeInterval.targetVariableTrueValues*	array
relativeObservationMinTimeInterval.targetVariableTrueValues[]	string
relativeObservationMinTimeInterval.targetTimestampVariable*	object	Inherits: object
relativeObservationMinTimeInterval.targetTimestampVariable.entityId*	string
relativeObservationMinTimeInterval.targetTimestampVariable.variableId*	string
relativeObservationMinTimeInterval.minimumTimeIntervalDays*	integer

Inherits: object

Parameter	Type	Description
studyId*	string
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

Parameter	Type	Description
[]	object	Inherits: lib.VariableSpec
[].entityId*	string
[].variableId*	string
[].derivationType*	string	Enum: transform reduction Inherits: string
[].variableType*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
[].vocabulary	array
[].vocabulary[]	string
[].units	string
[].dataRange	object	Inherits: lib.Range
[].dataRange.min*	string
[].dataRange.max*	string

Additional properties: Yes

Inherits: object

Parameter	Type	Description
types*	array
types[]	object	Additional properties: Yes Inherits: object
types[].displayName*	string
types[].units*	array
types[].units[]	object	Additional properties: Yes Inherits: object
types[].units[].displayName*	string
types[].units[].values*	array
types[].units[].values[]	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/merging/query

Inherits: lib.DerivedVariableBulkMetadataRequest

Parameter	Type	Description
studyId*	string
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
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
entityId*	string
outputVariables*	array
outputVariables[]	object	Inherits: lib.VariableSpec
outputVariables[].entityId*	string
outputVariables[].variableId*	string
computeSpec	object	Inherits: object
computeSpec.computeName*	string
computeSpec.computeConfig*	object	Additional properties: Yes

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Bad Request BadRequestError

application/json

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unprocessable Entity UnprocessableEntityError

application/json

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Response Body

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Inherits: object

Parameter	Type	Description
studyId*	string
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

Parameter	Type	Description
[]	object	Inherits: lib.VariableSpec
[].entityId*	string
[].variableId*	string
[].derivationType*	string	Enum: transform reduction Inherits: string
[].variableType*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
[].vocabulary	array
[].vocabulary[]	string
[].units	string
[].dataRange	object	Inherits: lib.Range
[].dataRange.min*	string
[].dataRange.max*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/merging-internal/query

Inherits: lib.DerivedVariableBulkMetadataRequest

Parameter	Type	Description
studyId*	string
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
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
entityId*	string
outputVariables*	array
outputVariables[]	object	Inherits: lib.VariableSpec
outputVariables[].entityId*	string
outputVariables[].variableId*	string
computeSpec	object	Inherits: object
computeSpec.computeName*	string
computeSpec.computeConfig*	object	Additional properties: Yes

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Bad Request BadRequestError

application/json

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unprocessable Entity UnprocessableEntityError

application/json

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Response Body

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Parameter	Type	Description
[] Plugin Overview	object	Inherits: object
[].name*	string
[].displayName*	string
[].description*	string
[].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

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/example?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.ExampleComputeConfig
config.inputVariable*	object	Inherits: object
config.inputVariable.entityId*	string
config.inputVariable.variableId*	string
config.valueSuffix*	string
config.failureProbability*	number

Inherits: object

Parameter	Type	Description
jobID*	string	128-bit digest based identifier. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32 Inherits: string
status*	string	Enum: no-such-job queued in-progress complete failed expired Inherits: string
queuePosition	integer	Format: int32

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Parameters

Parameter	Type	Description
Path
file*	string	MUST be one of "meta", "tabular", "statistics".

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/example/{file}

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.ExampleComputeConfig
config.inputVariable*	object	Inherits: object
config.inputVariable.entityId*	string
config.inputVariable.variableId*	string
config.valueSuffix*	string
config.failureProbability*	number

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/betadiv?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BetaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.betaDivDissimilarityMethod*	string	Enum: bray jaccard jsd Inherits: lib.BetaDivDissimilarityMethod

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Parameters

Parameter	Type	Description
Path
file*	string	MUST be one of "meta", "tabular", "statistics".

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/betadiv/{file}

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BetaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.betaDivDissimilarityMethod*	string	Enum: bray jaccard jsd Inherits: lib.BetaDivDissimilarityMethod

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/alphadiv?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.AlphaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.alphaDivMethod*	string	Enum: shannon simpson evenness Inherits: lib.AlphaDivMethod

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Parameters

Parameter	Type	Description
Path
file*	string	MUST be one of "meta", "tabular", "statistics".

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/alphadiv/{file}

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.AlphaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.alphaDivMethod*	string	Enum: shannon simpson evenness Inherits: lib.AlphaDivMethod

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/rankedabundance?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.RankedAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.rankingMethod*	string	Enum: median q3 variance max Inherits: lib.RankingMethod

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Parameters

Parameter	Type	Description
Path
file*	string	MUST be one of "meta", "tabular", "statistics".

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/rankedabundance/{file}

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.RankedAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.rankingMethod*	string	Enum: median q3 variance max Inherits: lib.RankingMethod

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/differentialabundance?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.DifferentialAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.comparator*	object	Additional properties: Yes Inherits: lib.ComparatorSpec
config.comparator.variable*	object	Inherits: object
config.comparator.variable.entityId*	string
config.comparator.variable.variableId*	string
config.comparator.groupA*	array
config.comparator.groupA[]	object	Inherits: lib.Range
config.comparator.groupA[].min*	string
config.comparator.groupA[].max*	string
config.comparator.groupA[].label*	string
config.comparator.groupB*	array
config.comparator.groupB[]	object	Inherits: lib.Range
config.comparator.groupB[].min*	string
config.comparator.groupB[].max*	string
config.comparator.groupB[].label*	string
config.differentialAbundanceMethod*	string	Enum: DESeq ANCOMBC Maaslin Inherits: lib.DifferentialAbundanceMethod
config.pValueFloor	string

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.DifferentialAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.comparator*	object	Additional properties: Yes Inherits: lib.ComparatorSpec
config.comparator.variable*	object	Inherits: object
config.comparator.variable.entityId*	string
config.comparator.variable.variableId*	string
config.comparator.groupA*	array
config.comparator.groupA[]	object	Inherits: lib.Range
config.comparator.groupA[].min*	string
config.comparator.groupA[].max*	string
config.comparator.groupA[].label*	string
config.comparator.groupB*	array
config.comparator.groupB[]	object	Inherits: lib.Range
config.comparator.groupB[].min*	string
config.comparator.groupB[].max*	string
config.comparator.groupB[].label*	string
config.differentialAbundanceMethod*	string	Enum: DESeq ANCOMBC Maaslin Inherits: lib.DifferentialAbundanceMethod
config.pValueFloor	string

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

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/correlation?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson Inherits: string
config.data1*	object	Additional properties: Yes Inherits: object
config.data1.dataType*	string	Enum: metadata collection Inherits: string
config.data1.collectionSpec	object	Inherits: object
config.data1.collectionSpec.entityId*	string
config.data1.collectionSpec.collectionId*	string
config.data2*	object	Additional properties: Yes Inherits: object
config.data2.dataType*	string	Enum: metadata collection Inherits: string
config.data2.collectionSpec	object	Inherits: object
config.data2.collectionSpec.entityId*	string
config.data2.collectionSpec.collectionId*	string

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson Inherits: string
config.data1*	object	Additional properties: Yes Inherits: object
config.data1.dataType*	string	Enum: metadata collection Inherits: string
config.data1.collectionSpec	object	Inherits: object
config.data1.collectionSpec.entityId*	string
config.data1.collectionSpec.collectionId*	string
config.data2*	object	Additional properties: Yes Inherits: object
config.data2.dataType*	string	Enum: metadata collection Inherits: string
config.data2.collectionSpec	object	Inherits: object
config.data2.collectionSpec.entityId*	string
config.data2.collectionSpec.collectionId*	string

Inherits: object

Parameter	Type	Description
statistics*	array
statistics[]	object	Additional properties: Yes Inherits: lib.CorrelationPoint
statistics[].data1*	string
statistics[].data2*	string
statistics[].correlationCoef	string
statistics[].pValue	string
statistics[].adjustedPValue	string
data1Metadata*	string
data2Metadata*	string

Parameters

Parameter	Type	Description
Query
autostart	boolean	Default value: true

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/computes/selfcorrelation?autostart=<value>

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
config.data1*	object	Inherits: object
config.data1.entityId*	string
config.data1.collectionId*	string

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
config.data1*	object	Inherits: object
config.data1.entityId*	string
config.data1.collectionId*	string

Inherits: object

Parameter	Type	Description
statistics*	array
statistics[]	object	Additional properties: Yes Inherits: lib.CorrelationPoint
statistics[].data1*	string
statistics[].data2*	string
statistics[].correlationCoef	string
statistics[].pValue	string
statistics[].adjustedPValue	string
data1Metadata*	string
data2Metadata*	string

Returns a list of job IDs for compute jobs whose workspaces are in a state where the jobs appear to be running, however no record of them is present in the local postgres database.

NOTE: A job ID appearing in this list DOES NOT mean that they are actually dead. Jobs that are actively being run by another campus will also appear in this list.

This list may be used as a starting point in the process of locating dead workspaces.

curl -X GET \
  undefined/admin/compute/list-possible-dead-workspaces

Deletes the contents of a workspace by force. The target workspace need not be valid for this operation.

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X DELETE \
  undefined/admin/compute/workspaces/{job-id}

Expire jobs based on criteria

Parameters

Parameter	Type	Description
Query
job-id*	string
study-id*	string
plugin-name*	string
admin-auth-token*	string

curl -X GET \
  undefined/expire-compute-jobs?job-id=<value>&study-id=<value>&plugin-name=<value>&admin-auth-token=<value>

Additional properties: Yes

Inherits: object

Parameter	Type	Description
numJobsExpired*	integer

Parameter	Type	Description
[]	object	Additional properties: Yes Inherits: object
[].jobId*	string	128-bit digest based identifier. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32 Inherits: string
[].status*	string	Enum: no-such-job queued in-progress complete failed expired Inherits: string
[].owned*	boolean
[].created*	datetime
[].grabbed*	datetime
[].finished*	datetime

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X GET \
  undefined/internal-jobs/{job-id}

Additional properties: Yes

Inherits: object

Parameter	Type	Description
jobId*	string	128-bit digest based identifier. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32 Inherits: string
status*	string	Enum: no-such-job queued in-progress complete failed expired Inherits: string
owned*	boolean
created*	datetime
grabbed*	datetime
finished*	datetime

Deletes a target job by ID

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X DELETE \
  undefined/jobs/{job-id}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Gets the status of the target job.

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X GET \
  undefined/jobs/{job-id}

Inherits: object

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Response Body

queued

{
  "jobID": "9ab9a5886d6abb9ebc82a40f770a1db3",
  "status": "queued",
  "queuePosition": 3
}

in-progress

{
  "jobID": "9ab9a5886d6abb9ebc82a40f770a1db3",
  "status": "in-progress"
}

complete

{
  "jobID": "9ab9a5886d6abb9ebc82a40f770a1db3",
  "status": "complete"
}

failed

{
  "jobID": "9ab9a5886d6abb9ebc82a40f770a1db3",
  "status": "failed"
}

expired

{
  "jobID": "9ab9a5886d6abb9ebc82a40f770a1db3",
  "status": "expired"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Lists the files available for a completed job.

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X GET \
  undefined/jobs/{job-id}/files

Parameter	Type	Description
[]

Response Body

[
  "output"
]

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Returns the target file from a completed job.

Parameters

Parameter

Type

Description

Path

job-id*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

file-name*

string

Min. length: 1

curl -X GET \
  undefined/jobs/{job-id}/files/{file-name}

Response Body

dlrow olleh

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

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

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

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

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

Returns data required to make Standalone Map markers

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map/visualizations/map-markers

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

Inherits: object

Parameter	Type	Description
mapElements*	array
mapElements[]	object	Inherits: object
mapElements[].geoAggregateValue*	string
mapElements[].entityCount*	number
mapElements[].avgLat*	number
mapElements[].avgLon*	number
mapElements[].minLat*	number
mapElements[].minLon*	number
mapElements[].maxLat*	number
mapElements[].maxLon*	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

Returns data required to make bubble markers.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map/visualizations/map-markers/bubbles

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

Inherits: object

Parameter	Type	Description
mapElements*	array
mapElements[]	object	Inherits: object
mapElements[].geoAggregateValue*	string
mapElements[].entityCount*	number
mapElements[].avgLat*	number
mapElements[].avgLon*	number
mapElements[].minLat*	number
mapElements[].minLon*	number
mapElements[].maxLat*	number
mapElements[].maxLon*	number
mapElements[].overlayValue*	string

Returns data required to make bubble marker legends

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map/visualizations/map-markers/bubbles/legend

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

Inherits: object

Parameter	Type	Description
minColorValue*	string
maxColorValue*	string
minSizeValue*	number
maxSizeValue*	number

Map marker endpoint for collection variables.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map/visualizations/map-markers/collections

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	Specification for a collection-level map marker visualization. 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.collectionOverlay*	object	Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig
config.collectionOverlay.collection*	object	Inherits: object
config.collectionOverlay.collection.entityId*	string
config.collectionOverlay.collection.collectionId*	string
config.collectionOverlay.selectedMembers*	array
config.collectionOverlay.selectedMembers[]	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

Inherits: object

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. Inherits: lib.BaseMarker
markers[].geoAggregateValue*	string
markers[].entityCount*	number
markers[].avgLat*	number
markers[].avgLon*	number
markers[].minLat*	number
markers[].minLon*	number
markers[].maxLat*	number
markers[].maxLon*	number
markers[].overlayValues*	array
markers[].overlayValues[]	object	Additional properties: Yes Inherits: lib.CollectionMemberAggregate
markers[].overlayValues[].variableId*	string
markers[].overlayValues[].value*	number
markers[].overlayValues[].confidenceInterval*	object	Inherits: lib.NumberRange
markers[].overlayValues[].confidenceInterval.min*	number
markers[].overlayValues[].confidenceInterval.max*	number
markers[].overlayValues[].n*	number

Returns data required to create a floating scatterplot visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-xyrelationships/visualizations/scatterplot

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

Inherits: object

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

Returns data required to create a floating lineplot visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-xyrelationships/visualizations/lineplot

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

Inherits: object

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

Returns data required to create a floating time series visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-xyrelationships/visualizations/timeseries

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

Inherits: object

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

Returns data required to create a floating histogram visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-distributions/visualizations/histogram

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

Inherits: object

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

Returns data required to create a floating histogram visualization for date variables only in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-distributions/visualizations/timeline

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

Inherits: object

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

Returns data required to create a floating boxplot visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-distributions/visualizations/boxplot

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

Inherits: object

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

Returns data required to create a floating bar plot visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-countsandproportions/visualizations/barplot

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

Inherits: object

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

Returns data required to create a floating RxC mosaic plot visualization in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-countsandproportions/visualizations/conttable

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

Inherits: object

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

Returns data required to create a floating line plot visualization for continuous variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-continuous-collections/visualizations/lineplot

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.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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

Inherits: object

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

Returns data required to create a floating time series visualization for continuous variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-continuous-collections/visualizations/timeseries

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.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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

Inherits: object

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

Returns data required to create a floating box plot visualization for continuous variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-continuous-collections/visualizations/boxplot

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.CollectionFloatingBoxplotSpec
config.outputEntityId*	string
config.xAxisVariable*	object	Inherits: object
config.xAxisVariable.entityId*	string
config.xAxisVariable.variableId*	string
config.overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.maxAllowedDataPoints	integer	Format: int64

Inherits: object

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

Returns data required to create a floating histogram visualization for continuous variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-continuous-collections/visualizations/histogram

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.CollectionFloatingHistogramSpec
config.outputEntityId*	string
config.barMode*	string	Enum: overlay stack
config.valueSpec*	string	Enum: count proportion Inherits: string
config.overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

Inherits: object

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

Returns data required to create a floating line plot visualization for categorical variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-categorical-collections/visualizations/lineplot

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.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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

Inherits: object

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

Returns data required to create a floating bar plot visualization for categorical variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-categorical-collections/visualizations/barplot

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.CollectionFloatingBarplotSpec
config.outputEntityId*	string
config.barMode*	string	Enum: group stack
config.valueSpec*	string	Enum: count proportion Inherits: string
config.overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.overlayConfig.selectedValues	array
config.overlayConfig.selectedValues[]	string

Inherits: object

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

Returns data required to create a floating RxC mosaic plot visualization for categorical variable collections in the Standalone Map

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/standalone-map-categorical-collections/visualizations/conttable

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.CollectionFloatingContTableSpec
config.outputEntityId*	string
config.xAxisVariable*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.xAxisVariable.selectedValues	array
config.xAxisVariable.selectedValues[]	string

Inherits: object

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

Returns data required to make MapVeu markers
Java impl- working
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/map-markers

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

Inherits: object

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

Return a tabular report of one or more variables. In the request, filters must be a subclass of Filter

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/table

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

Inherits: object

Parameter	Type	Description
columns*	array
columns[]	object	Inherits: object
columns[].entityId*	string
columns[].variableId*	string
rows*	array
rows[]	array
rows[][]	string

Returns data required to create a scatterplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/scatterplot

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.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
config.correlationMethod*	string	Enum: none spearman pearson sparcc Inherits: lib.ScatterCorrelationMethod

Inherits: object

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

Returns data required to create a densityplot visualization
Java impl- NA
R impl- drafted, passing unit tests, not confirmed working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/densityplot

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

Inherits: object

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

Returns data required to create a Time Series visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/timeseries

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

Inherits: object

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

Returns data required to create a lineplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/lineplot

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

Inherits: object

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

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/pass/visualizations/histogram

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

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

Returns data required to create a boxplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/boxplot

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

Inherits: object

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

Returns data required to create a heatmap visualization
Java impl- NA
R impl- drafted

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/heatmap

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

Inherits: object

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

Returns data required to create a bar plot visualization
Java impl- drafted, not working
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/barplot

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

Inherits: object

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

Returns data required to create a pie plot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/map-markers-overlay

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

Inherits: object

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

Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/twobytwo

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

Inherits: object

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

Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- drafted

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/pass/visualizations/conttable

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

Inherits: object

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

Returns data required to create a box plot with alpha diversity as dependent axis
Java impl- NA
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/alphadiv/visualizations/boxplot

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

Inherits: object

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

Returns data required to create a scatterplot that explores the relationship between a continuous variable and alpha diversity
Java impl- NA
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/alphadiv/visualizations/scatterplot

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

Inherits: object

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

Returns data required to create a box plot with abundance as dependent axis
Java impl- NA
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/abundance/visualizations/boxplot

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

Inherits: object

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

Returns data required to create a scatterplot that explores the relationship between a continuous variable and alpha diversity
Java impl- NA
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/abundance/visualizations/scatterplot

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

Inherits: object

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

Returns data required to create a scatterplot that explores the differences between samples in a dataset as described by beta diversity
Java impl- NA
R impl- NA

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/betadiv/visualizations/scatterplot

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

Inherits: object

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

Returns data required to create a volcanoplot from a differential abundance analysis.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/differentialabundance/visualizations/volcanoplot

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

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

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/correlation/visualizations/bipartitenetwork

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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: metadata collection Inherits: string
computeConfig.data1.collectionSpec	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: metadata collection Inherits: string
computeConfig.data2.collectionSpec	object	Inherits: object
computeConfig.data2.collectionSpec.entityId*	string
computeConfig.data2.collectionSpec.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

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.nodes[].degree	number
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[].source.degree	number
bipartitenetwork.data.links[].target*	object	Additional properties: Yes Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id*	string
bipartitenetwork.data.links[].target.degree	number
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

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

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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: collection
computeConfig.data1.collectionSpec*	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: collection
computeConfig.data2.collectionSpec*	object	Inherits: object
computeConfig.data2.collectionSpec.entityId*	string
computeConfig.data2.collectionSpec.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

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.nodes[].degree	number
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[].source.degree	number
bipartitenetwork.data.links[].target*	object	Additional properties: Yes Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id*	string
bipartitenetwork.data.links[].target.degree	number
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

Returns data required to create a unipartite network from a correlation matrix.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/selfcorrelation/visualizations/unipartitenetwork

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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
computeConfig.data1*	object	Inherits: object
computeConfig.data1.entityId*	string
computeConfig.data1.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

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

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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: collection
computeConfig.data1.collectionSpec*	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: metadata
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

Inherits: object

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.nodes[].degree	number
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[].source.degree	number
bipartitenetwork.data.links[].target*	object	Additional properties: Yes Inherits: object
bipartitenetwork.data.links[].target.id*	string
bipartitenetwork.data.links[].target.degree	number
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

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

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

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

Returns data required to create a boxplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/distributions/visualizations/boxplot

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

Inherits: object

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

Returns data required to create a bar or pie plot visualization
Java impl- drafted, not working
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/countsandproportions/visualizations/barplot

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

Inherits: object

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

Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/countsandproportions/visualizations/twobytwo

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

Inherits: object

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

Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- drafted

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/countsandproportions/visualizations/conttable

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

Inherits: object

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

Returns data required to create a scatterplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/xyrelationships/visualizations/scatterplot

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.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
config.correlationMethod*	string	Enum: none spearman pearson sparcc Inherits: lib.ScatterCorrelationMethod

Inherits: object

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

Returns data required to create a lineplot visualization
Java impl- NA
R impl- working

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/xyrelationships/visualizations/lineplot

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

Inherits: object

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

Returns a count of the records in the subset

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/sample/visualizations/record-count

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.RecordCountSpec
config.entityId*	string

Inherits: object

Parameter	Type	Description
recordCount*	integer

Returns a stream of records with its first two attributes (combined from parallel streams)

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/sample/visualizations/multi-stream

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.MultiStreamSpec
config.entityId*	string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Returns a tabular response for the subset with all vars in the requested collection

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/sample/visualizations/collections-test

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: object
config.entityId*	string
config.collectionId*	string

Inherits: object

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Returns a set of count and proportion distributions for a native categorical variable

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/sample/visualizations/categorical-distribution

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: object
config.entityId*	string
config.variableId*	string

Additional properties: Yes

Inherits: object

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

Sample visualization plugin that uses data from a compute

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/apps/samplewithcompute/visualizations/viz-with-compute

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.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
computeConfig.failureProbability*	number

Inherits: object

Parameter	Type	Description
countPluginResult*	integer
numEmptyValues*	integer
longestConcatenatedValue*	string
avgConcatenatedLength*	number

List dataset staff in ascending order by ID.

Parameters

Parameter

Type

Description

Query

limit

integer

Number of rows to include in the result

Format: int64

Default value: 1000

offset

integer

Number of rows to skip from the result

Format: int64

curl -X GET \
  undefined/staff?limit=<value>&offset=<value>

Inherits: object

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].staffId*	integer	Min. value: 1 Format: int64 Inherits: integer
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].isOwner*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Create a new dataset staff record.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/staff

Additional properties: Yes

Inherits: object

Parameter

Type

Description

userId*

integer

Min. value: 1

Format: int64

isOwner*

boolean

Inherits: object

Parameter

Type

Description

staffId*

integer

Min. value: 1

Format: int64

Update dataset staff.

Parameters

Parameter

Type

Description

Path

staff-id* DatastoreId

integer

Min. value: 1

Format: int64

Inherits: integer

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/staff/{staff-id}

Parameter	Type	Description
[]	object	Inherits: object
[].op*	string	Pattern: ^replace$
[].path*	string	Pattern: ^/isOwner$
[].value*	boolean

Delete dataset staff.

Parameters

Parameter

Type

Description

Path

staff-id* DatastoreId

integer

Min. value: 1

Format: int64

Inherits: integer

curl -X DELETE \
  undefined/staff/{staff-id}

Get a list of providers for this dataset.

Parameters

Parameter	Type	Description
Query
datasetId*	string
limit	integer	Number of rows to include in the result Format: int64 Default value: 1000
offset	integer	Number of rows to skip from the result Format: int64

curl -X GET \
  undefined/dataset-providers?datasetId=<value>&limit=<value>&offset=<value>

Inherits: object

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].providerId*	integer	Min. value: 1 Format: int64 Inherits: integer
data[].datasetId*	string
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].isManager*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Create a new dataset provider record.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/dataset-providers

Inherits: object

Parameter	Type	Description
datasetId*	string
userId	integer	Min. value: 1 Format: int64
email	string
isManager*	boolean

Inherits: object

Parameter Type Description

created*

boolean

Indicates whether a new provider record was created or not.

If this value is false the "providerId" property will not be set. This happens when the request was sent using an email address that is not in our user database. In this case no provider record was created but instead an email was sent to the given address requesting that the user register.

If this value is true the "providerId" property will be set containing the primary key value of the newly created provider record.

providerId

integer

Min. value: 1

Format: int64

Update a dataset provider record.

Parameters

Parameter

Type

Description

Path

provider-id* DatastoreId

integer

Dataset provider ID.

Min. value: 1

Format: int64

Inherits: integer

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/dataset-providers/{provider-id}

Parameter	Type	Description
[]	object	Inherits: object
[].op*	string	Pattern: ^replace$
[].path*	string	Pattern: ^/isManager$
[].value*	boolean

Delete a dataset provider record.

Parameters

Parameter

Type

Description

Path

provider-id* DatastoreId

integer

Dataset provider ID.

Min. value: 1

Format: int64

Inherits: integer

curl -X DELETE \
  undefined/dataset-providers/{provider-id}

Get a list of all end-users for the specified dataset.

Parameters

Parameter	Type	Description
Query
datasetId* Dataset ID	string
limit Result Limit	integer	Number of rows to include in the result Format: int64 Default value: 100
offset Result Offset	integer	Number of rows to skip from the result Format: int64
approval ApprovalStatus	string	Filter results by the approval status of the users. Enum: unrequested approved requested denied Inherits: string

curl -X GET \
  undefined/dataset-end-users?datasetId=<value>&limit=<value>&offset=<value>&ApprovalStatus=<value>

Inherits: object

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].datasetId*	string
data[].startDate	datetime
data[].duration	integer	Format: int64
data[].restrictionLevel*	string	Enum: public prerelease protected controlled private Inherits: string
data[].purpose*	string
data[].researchQuestion*	string
data[].analysisPlan*	string
data[].disseminationPlan*	string
data[].approvalStatus*	string	Enum: unrequested approved requested denied Inherits: string
data[].denialReason	string
data[].priorAuth*	string
data[].allowEdit*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Create a new dataset end-user record.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/dataset-end-users

EndUserCreateRequest EndUserCreateRequest

application/json

New end user request body.

Body MUST contain either userId property or the email property.

If the email property is used, the service will attempt to locate a user account with that email. If one is found, a new record will be created and it's ID returned in the response. If one is not found, an email will be sent to the given address requesting the user create an account and NO NEW RECORD WILL BE CREATED.

Inherits: object

Parameter	Type	Description
userId	integer	Min. value: 1 Format: int64
email	string
purpose*	string
researchQuestion*	string
analysisPlan*	string
disseminationPlan*	string
priorAuth*	string
datasetId*	string
startDate	datetime
duration	integer
restrictionLevel	string	Enum: public prerelease protected controlled private Inherits: string
approvalStatus	string	Enum: unrequested approved requested denied Inherits: string
denialReason	string

EndUserCreateResponse EndUserCreateResponse

application/json

End user creation response.

Returns a flag indicating whether or not the record was actually created or not. If created == true then the endUserId property will be present and contain the new end user record's ID. If created == false then the endUserId property will NOT be present, and the successful response indicates that an email was sent to the email address given in the request.

If the creation request used the userId property instead of the email property, a new record will always have been created on a success response.

Inherits: object

Parameter	Type	Description
created*	boolean
endUserId	string

Get the details of an end-user record.

Parameters

Parameter	Type	Description
Path
end-user-id*	string	ID of a specific end-user record. This ID consists of the WDK user ID for the user followed by a single dash (`-`) character followed by the dataset ID. Example: `82-DS_897fe55e6f`. Pattern: ^\d+-\w+$

curl -X GET \
  undefined/dataset-end-users/{end-user-id}

Inherits: object

Parameter	Type	Description
user*	object	Inherits: object
user.userId*	integer	Min. value: 1 Format: int64
user.firstName*	string
user.lastName*	string
user.organization*	string
user.email*	string
datasetId*	string
startDate	datetime
duration	integer	Format: int64
restrictionLevel*	string	Enum: public prerelease protected controlled private Inherits: string
purpose*	string
researchQuestion*	string
analysisPlan*	string
disseminationPlan*	string
approvalStatus*	string	Enum: unrequested approved requested denied Inherits: string
denialReason	string
priorAuth*	string
allowEdit*	boolean

Delete an end user access grant.

Parameters

Parameter	Type	Description
Path
end-user-id*	string	ID of a specific end-user record. This ID consists of the WDK user ID for the user followed by a single dash (`-`) character followed by the dataset ID. Example: `82-DS_897fe55e6f`. Pattern: ^\d+-\w+$

curl -X DELETE \
  undefined/dataset-end-users/{end-user-id}

Update an end user record.

The following rules apply to end user self updates:

The user may only submit updates while their access request is in the "requested" status.
Only the following fields may be updated:
purpose
researchQuestion
analysisPlan
disseminationPlan

This endpoint supports only the listed JSON Patch operations on the listed paths. All other JSON paths or operations will result in a 403 error.

/startDate

add
remove
replace

This field may only be altered by site owners and dataset managers.

/duration

add
remove
replace

This field may only be altered by site owners and dataset managers.

/restrictionLevel

replace

This field may only be altered by site owners and dataset managers.

/purpose

replace

Type: string

This field may be altered by site owners and dataset managers at any time.

This field may only be altered by end users while their access request is in the "requested" status.

/researchQuestion

replace

Type: string

This field may be altered by site owners and dataset managers at any time.

This field may only be altered by end users while their access request is in the "requested" status.

/analysisPlan

replace

Type: string

This field may be altered by site owners and dataset managers at any time.

This field may only be altered by end users while their access request is in the "requested" status.

/disseminationPlan

replace

Type: string

This field may be altered by site owners and dataset managers at any time.

This field may only be altered by end users while their access request is in the "requested" status.

priorAuth

replace

Type: string

This field may be altered by site owners and dataset managers at any time.

This field may only be altered by end users while their access request is in the "requested" status.

/approvalStatus

replace

This field may only be altered by site owners and dataset managers.

/denialReason

add
remove
replace

This field may only be altered by site owners and dataset managers.

Parameters

Parameter	Type	Description
Path
end-user-id*	string	ID of a specific end-user record. This ID consists of the WDK user ID for the user followed by a single dash (`-`) character followed by the dataset ID. Example: `82-DS_897fe55e6f`. Pattern: ^\d+-\w+$

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/dataset-end-users/{end-user-id}

Parameter	Type	Description
[]	object	Inherits: object
[].op*	string	Enum: add remove replace
[].path*	string	Pattern: ^/.+$
[].value	any
[].from	string

Inherits: object

Parameter	Type	Description
isStaff	boolean	Indicates whether the current user is listed in the service's staff entries.
isOwner	boolean	Indicates whether the current user is listed in the service's staff entries and is marked as a site owner.
perDataset	object	If the current user is a provider or an end user of one or more datasets, these datasets will be listed here with the user's permission level for each specific dataset. If the user is not a provider or end user for any datasets, this field will be omitted.
perDataset.//*	object	Inherits: lib.DatasetPermissionEntry
perDataset.//.studyId*	string
perDataset.//.sha1Hash*	string
perDataset.//.isUserStudy*	boolean
perDataset.//.displayName*	string
perDataset.//.shortDisplayName*	string
perDataset.//.description*	string
perDataset.//.type*	string	Enum: provider end-user Inherits: lib.DatasetPermissionLevel
perDataset.//.actionAuthorization*	object	Inherits: lib.ActionList
perDataset.//.actionAuthorization.studyMetadata*	boolean	study metadata
perDataset.//.actionAuthorization.subsetting*	boolean	count, distribution
perDataset.//.actionAuthorization.visualizations*	boolean	all viz plugins
perDataset.//.actionAuthorization.resultsFirstPage*	boolean	offset:0, numRecords: <=20
perDataset.//.actionAuthorization.resultsAll*	boolean	any other tabular response
perDataset.//.isManager	boolean	For providers, this field indicates whether the current user is marked as a manager for the dataset represented by the containing permission entry. This field will only be present if the containing permission entry type = `provider`.
perDataset.//.accessRequestStatus*	string	Enum: unrequested approved requested denied Inherits: string

Parameters

Parameter	Type	Description
Path
dataset-id*	string

curl -X GET \
  undefined/permissions/{dataset-id}

Inherits: object

Parameter	Type	Description
studyId*	string
datasetId*	string
isUserStudy*	boolean
actionAuthorization*	object	Inherits: object
actionAuthorization.studyMetadata*	boolean	study metadata
actionAuthorization.subsetting*	boolean	count, distribution
actionAuthorization.visualizations*	boolean	all viz plugins
actionAuthorization.resultsFirstPage*	boolean	offset:0, numRecords: <=20
actionAuthorization.resultsAll*	boolean	any other tabular response

Parameters

Parameter

Type

Description

Query

limit*

integer

Min. value: 1

Max. value: 999

Format: int64

Default value: 999

offset*

integer

Format: int64

curl -X GET \
  undefined/history?limit=<value>&offset=<value>

Inherits: object

Parameter	Type	Description
meta*	object	Inherits: lib.HistoryMeta
meta.rows*	integer	Format: int64
meta.offset*	integer	Format: int64
results*	array
results[]	object	Inherits: lib.HistoryResult
results[].cause*	object	Inherits: lib.HistoryCause
results[].cause.user*	object	Inherits: lib.HistoryUser
results[].cause.user.userID*	integer	Format: int64
results[].cause.user.firstName*	string
results[].cause.user.lastName*	string
results[].cause.user.email*	string
results[].cause.user.organization*	string
results[].cause.action*	string	Enum: CREATE UPDATE DELETE
results[].cause.timestamp*	datetime-only
results[].row*	object	Inherits: lib.HistoryRow
results[].row.endUserID*	integer	Format: int64
results[].row.user*	object	Inherits: lib.HistoryUser
results[].row.user.userID*	integer	Format: int64
results[].row.user.firstName*	string
results[].row.user.lastName*	string
results[].row.user.email*	string
results[].row.user.organization*	string
results[].row.datasetPresenterID*	string
results[].row.restrictionLevel*	string	Enum: PUBLIC PRERELEASE PROTECTED CONTROLLED PRIVATE
results[].row.approvalStatus*	string	Enum: APPROVED REQUESTED DENIED
results[].row.startDate*	datetime-only
results[].row.duration*	integer	Format: int64
results[].row.purpose*	string
results[].row.researchQuestion*	string
results[].row.analysisPlan*	string
results[].row.priorAuth*	string
results[].row.denialReason*	string
results[].row.dateDenied*	datetime-only
results[].row.allowSelfEdits*	boolean

Approve protected study requests in which auto-approval duration has elapsed

curl -X POST \
  undefined/approve-eligible-access-requests

Parameters

Parameter	Type	Description
Path
project*	string
study-id*	string

curl -X GET \
  undefined/download/{project}/{study-id}

Parameter	Type	Description
[]

Parameters

Parameter	Type	Description
Path
project*	string
study-id*	string
release*	string

curl -X GET \
  undefined/download/{project}/{study-id}/{release}

Parameter	Type	Description
[]	object	Inherits: object
[].name*	string
[].modifiedDate*	string
[].size*	string

Parameters

Parameter	Type	Description
Path
project*	string
study-id*	string
release*	string
file*	string

Secured By

header-auth header-auth

Authentication based on a WDK auth cookie.

curl -X GET \
  undefined/download/{project}/{study-id}/{release}/{file}

Additional properties: Yes

Inherits: object

Parameter	Type	Description
//*	any

Parameters

Parameter	Type	Description
Path
project-id*	string

curl -X GET \
  undefined/public/analyses/{project-id}

Parameter	Type	Description
[]	object	Inherits: lib.AnalysisSummary
[].displayName*	string
[].description*	string
[].studyId*	string
[].studyVersion*	string
[].apiVersion*	string
[].isPublic*	boolean
[].analysisId*	string
[].creationTime*	string
[].modificationTime*	string
[].numFilters*	integer
[].numComputations*	integer
[].numVisualizations*	integer
[].provenance	object	Inherits: object
[].provenance.onImport*	object	Inherits: object
[].provenance.onImport.ownerId*	integer	Format: int64
[].provenance.onImport.ownerName*	string
[].provenance.onImport.ownerOrganization*	string
[].provenance.onImport.analysisId*	string
[].provenance.onImport.analysisName*	string
[].provenance.onImport.creationTime*	string
[].provenance.onImport.modificationTime*	string
[].provenance.onImport.isPublic*	boolean
[].provenance.current*	object	Inherits: object
[].provenance.current.isDeleted*	boolean
[].provenance.current.modificationTime	string
[].provenance.current.isPublic	boolean
[].userId*	number
[].userName*	string
[].userOrganization*	string

Parameters

Parameter	Type	Description
Path
project-id*	string
analysis-id*	string

curl -X GET \
  undefined/import-analysis/{project-id}/{analysis-id}

Inherits: object

Parameter	Type	Description
analysisId*	string

Parameters

Parameter	Type	Description
Path
project-id*	string
analysis-id*	string

curl -X GET \
  undefined/import-analysis/{project-id}/{analysis-id}/info

Inherits: object

Parameter	Type	Description
studyId*	string

Parameters

Parameter	Type	Description
Path
project-id*	string
Query
startDate*	string	optional start date (yyyy-mm-dd)
endDate*	string	optional end date (yyyy-mm-dd)
studyType*	string	Default value: "ALL" Enum: ALL USER CURATED

curl -X GET \
  undefined/metrics/user/{project-id}/analyses?startDate=<value>&endDate=<value>&studyType=<value>

Inherits: object

Parameter	Type	Description
startDate*	date-only
endDate*	date-only
createdOrModifiedCounts*	object	Inherits: lib.UserAnalysisCounts
createdOrModifiedCounts.analysesCount*	integer
createdOrModifiedCounts.importedAnalysesCount*	integer
createdOrModifiedCounts.analysesPerStudy*	array
createdOrModifiedCounts.analysesPerStudy[]	object	Inherits: lib.StudyCount
createdOrModifiedCounts.analysesPerStudy[].studyId*	string
createdOrModifiedCounts.analysesPerStudy[].count*	integer
createdOrModifiedCounts.importedAnalysesPerStudy*	array
createdOrModifiedCounts.importedAnalysesPerStudy[]	object	Inherits: lib.StudyCount
createdOrModifiedCounts.importedAnalysesPerStudy[].studyId*	string
createdOrModifiedCounts.importedAnalysesPerStudy[].count*	integer
createdOrModifiedCounts.registeredUsersCount*	integer
createdOrModifiedCounts.guestUsersCount*	integer
createdOrModifiedCounts.registeredAnalysesCount*	integer
createdOrModifiedCounts.guestAnalysesCount*	integer
createdOrModifiedCounts.registeredFiltersCount*	integer
createdOrModifiedCounts.guestFiltersCount*	integer
createdOrModifiedCounts.registeredVisualizationsCount*	integer
createdOrModifiedCounts.guestVisualizationsCount*	integer
createdOrModifiedCounts.registeredUsersAnalysesCounts*	array
createdOrModifiedCounts.registeredUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersAnalysesCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersAnalysesCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersAnalysesCounts*	array
createdOrModifiedCounts.guestUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersAnalysesCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersAnalysesCounts[].usersCount*	integer
createdOrModifiedCounts.registeredUsersFiltersCounts*	array
createdOrModifiedCounts.registeredUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersFiltersCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersFiltersCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersFiltersCounts*	array
createdOrModifiedCounts.guestUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersFiltersCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersFiltersCounts[].usersCount*	integer
createdOrModifiedCounts.registeredUsersVisualizationsCounts*	array
createdOrModifiedCounts.registeredUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersVisualizationsCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersVisualizationsCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersVisualizationsCounts*	array
createdOrModifiedCounts.guestUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersVisualizationsCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersVisualizationsCounts[].usersCount*	integer

Parameters

Parameter	Type	Description
Path
project-id*	string
Query
reportMonth*	string	Required report month (yyyy-mm)

curl -X GET \
  undefined/metrics/user/{project-id}/analyses/reports?reportMonth=<value>

Inherits: object

Parameter	Type	Description
count*	integer

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X GET \
  undefined/users/{user-id}/preferences/{project-id}

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X PUT \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/preferences/{project-id}

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X GET \
  undefined/users/{user-id}/analyses/{project-id}

Parameter	Type	Description
[]	object	Inherits: lib.AnalysisBase
[].displayName*	string
[].description*	string
[].studyId*	string
[].studyVersion*	string
[].apiVersion*	string
[].isPublic*	boolean
[].analysisId*	string
[].creationTime*	string
[].modificationTime*	string
[].numFilters*	integer
[].numComputations*	integer
[].numVisualizations*	integer
[].provenance	object	Inherits: object
[].provenance.onImport*	object	Inherits: object
[].provenance.onImport.ownerId*	integer	Format: int64
[].provenance.onImport.ownerName*	string
[].provenance.onImport.ownerOrganization*	string
[].provenance.onImport.analysisId*	string
[].provenance.onImport.analysisName*	string
[].provenance.onImport.creationTime*	string
[].provenance.onImport.modificationTime*	string
[].provenance.onImport.isPublic*	boolean
[].provenance.current*	object	Inherits: object
[].provenance.current.isDeleted*	boolean
[].provenance.current.modificationTime	string
[].provenance.current.isPublic	boolean

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/analyses/{project-id}

Inherits: lib.AnalysisBase

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
notes	string
descriptor*	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string

Inherits: object

Parameter	Type	Description
analysisId*	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/analyses/{project-id}

Inherits: object

Parameter	Type	Description
analysisIdsToDelete	array
analysisIdsToDelete[]	string
inheritOwnershipFrom	integer	Format: int64

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
analysis-id*	string

curl -X GET \
  undefined/users/{user-id}/analyses/{project-id}/{analysis-id}

Inherits: lib.AnalysisSummary

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
analysisId*	string
creationTime*	string
modificationTime*	string
numFilters*	integer
numComputations*	integer
numVisualizations*	integer
provenance	object	Inherits: object
provenance.onImport*	object	Inherits: object
provenance.onImport.ownerId*	integer	Format: int64
provenance.onImport.ownerName*	string
provenance.onImport.ownerOrganization*	string
provenance.onImport.analysisId*	string
provenance.onImport.analysisName*	string
provenance.onImport.creationTime*	string
provenance.onImport.modificationTime*	string
provenance.onImport.isPublic*	boolean
provenance.current*	object	Inherits: object
provenance.current.isDeleted*	boolean
provenance.current.modificationTime	string
provenance.current.isPublic	boolean
notes	string
descriptor*	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
analysis-id*	string

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/analyses/{project-id}/{analysis-id}

Inherits: object

Parameter	Type	Description
displayName	string
description	string
notes	string
descriptor	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string
isPublic	boolean

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
analysis-id*	string

curl -X DELETE \
  undefined/users/{user-id}/analyses/{project-id}/{analysis-id}

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
analysis-id*	string

curl -X POST \
  undefined/users/{user-id}/analyses/{project-id}/{analysis-id}/copy

Inherits: object

Parameter	Type	Description
analysisId*	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X GET \
  undefined/users/{user-id}/derived-variables/{project-id}

Parameter	Type	Description
[]	object	Inherits: lib.DerivedVariableSpec
[].entityId*	string
[].variableId*	string
[].functionName*	string
[].displayName*	string
[].config*	object	Additional properties: Yes
[].datasetId*	string
[].description	string	Max. length: 4000
[].provenance	object	Inherits: lib.DerivedVariableProvenance
[].provenance.copyDate*	datetime-only
[].provenance.copiedFrom*	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/derived-variables/{project-id}

Inherits: object

Parameter	Type	Description
datasetId*	string
entityId*	string
displayName*	string	Min. length: 1 Max. length: 256
functionName*	string
config*	object
description	string	Max. length: 4000

Inherits: lib.VariableSpec

Parameter	Type	Description
entityId*	string
variableId*	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
derived-variable-id*	string

curl -X GET \
  undefined/users/{user-id}/derived-variables/{project-id}/{derived-variable-id}

Inherits: lib.DerivedVariableSpec

Parameter	Type	Description
entityId*	string
variableId*	string
functionName*	string
displayName*	string
config*	object	Additional properties: Yes
datasetId*	string
description	string	Max. length: 4000
provenance	object	Inherits: lib.DerivedVariableProvenance
provenance.copyDate*	datetime-only
provenance.copiedFrom*	string

Parameters

Parameter	Type	Description
Path
user-id*	string
project-id*	string
derived-variable-id*	string

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/users/{user-id}/derived-variables/{project-id}/{derived-variable-id}

Inherits: object

Parameter

Type

Description

displayName

string

Min. length: 1

Max. length: 256

description

string

Max. length: 4000

Renders the API documentation for this service.

curl -X GET \
  undefined/api

Prints information about the overall service health.

curl -X GET \
  undefined/health

HealthResponse HealthResponse

application/json

Health details about the service

Inherits: object

Parameter	Type	Description
status*	string	Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum: healthy unhealthy
dependencies*	array	A list of external services that this service depends on and some details about them.
dependencies[]	object	Inherits: DependencyStatus
dependencies[].name*	string	Name of the external depdendency.
dependencies[].reachable*	boolean	Whether or not the external service is reachable.
dependencies[].online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no
info*	object	Additional properties: Yes
info.threads*	integer	Min. value: 1
info.uptime*	string
info.uptimeMillis*	integer	Min. value: 1 Format: int64

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Prometheus metrics for the service.

curl -X GET \
  undefined/metrics

Security Schemes

Authentication based on a WDK auth cookie.

Headers

Parameter	Type	Description
Auth_Key*	string	Authorization header.

curl -X <method> \
  -H "Auth_Key: <value>" \
  /<path>

Types

Min. value: 1

Format: int64

Inherits: integer

Inherits: object

Model

Parameter	Type	Description
userId*	integer	Min. value: 1 Format: int64
firstName*	string
lastName*	string
organization*	string
email*	string

Enum:

public
prerelease
protected
controlled
private

Inherits: string

Enum:

unrequested
approved
requested
denied

Inherits: string

Inherits: object

Model

Parameter	Type	Description
user*	object	Inherits: object
user.userId*	integer	Min. value: 1 Format: int64
user.firstName*	string
user.lastName*	string
user.organization*	string
user.email*	string
datasetId*	string
startDate	datetime
duration	integer	Format: int64
restrictionLevel*	string	Enum: public prerelease protected controlled private Inherits: string
purpose*	string
researchQuestion*	string
analysisPlan*	string
disseminationPlan*	string
approvalStatus*	string	Enum: unrequested approved requested denied Inherits: string
denialReason	string
priorAuth*	string
allowEdit*	boolean

New end user request body.

Body MUST contain either userId property or the email property.

Inherits: object

Model

Parameter	Type	Description
userId	integer	Min. value: 1 Format: int64
email	string
purpose*	string
researchQuestion*	string
analysisPlan*	string
disseminationPlan*	string
priorAuth*	string
datasetId*	string
startDate	datetime
duration	integer
restrictionLevel	string	Enum: public prerelease protected controlled private Inherits: string
approvalStatus	string	Enum: unrequested approved requested denied Inherits: string
denialReason	string

End user creation response.

If the creation request used the userId property instead of the email property, a new record will always have been created on a success response.

Inherits: object

Model

Parameter	Type	Description
created*	boolean
endUserId	string

Inherits: object

Model

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].datasetId*	string
data[].startDate	datetime
data[].duration	integer	Format: int64
data[].restrictionLevel*	string	Enum: public prerelease protected controlled private Inherits: string
data[].purpose*	string
data[].researchQuestion*	string
data[].analysisPlan*	string
data[].disseminationPlan*	string
data[].approvalStatus*	string	Enum: unrequested approved requested denied Inherits: string
data[].denialReason	string
data[].priorAuth*	string
data[].allowEdit*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Inherits: object

Model

Parameter	Type	Description
op*	string	Enum: add remove replace
path*	string	Pattern: ^/.+$
value	any
from	string

Inherits: object

Model

Parameter	Type	Description
providerId*	integer	Min. value: 1 Format: int64 Inherits: integer
datasetId*	string
user*	object	Inherits: object
user.userId*	integer	Min. value: 1 Format: int64
user.firstName*	string
user.lastName*	string
user.organization*	string
user.email*	string
isManager*	boolean

Inherits: object

Model

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].providerId*	integer	Min. value: 1 Format: int64 Inherits: integer
data[].datasetId*	string
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].isManager*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Inherits: object

Model

Parameter	Type	Description
datasetId*	string
userId	integer	Min. value: 1 Format: int64
email	string
isManager*	boolean

Inherits: object

Model

Parameter Type Description

created*

boolean

Indicates whether a new provider record was created or not.

If this value is true the "providerId" property will be set containing the primary key value of the newly created provider record.

providerId

integer

Min. value: 1

Format: int64

Inherits: object

Model

Parameter	Type	Description
op*	string	Pattern: ^replace$
path*	string	Pattern: ^/isManager$
value*	boolean

Inherits: object

Model

Parameter	Type	Description
meta*	object	Inherits: lib.HistoryMeta
meta.rows*	integer	Format: int64
meta.offset*	integer	Format: int64
results*	array
results[]	object	Inherits: lib.HistoryResult
results[].cause*	object	Inherits: lib.HistoryCause
results[].cause.user*	object	Inherits: lib.HistoryUser
results[].cause.user.userID*	integer	Format: int64
results[].cause.user.firstName*	string
results[].cause.user.lastName*	string
results[].cause.user.email*	string
results[].cause.user.organization*	string
results[].cause.action*	string	Enum: CREATE UPDATE DELETE
results[].cause.timestamp*	datetime-only
results[].row*	object	Inherits: lib.HistoryRow
results[].row.endUserID*	integer	Format: int64
results[].row.user*	object	Inherits: lib.HistoryUser
results[].row.user.userID*	integer	Format: int64
results[].row.user.firstName*	string
results[].row.user.lastName*	string
results[].row.user.email*	string
results[].row.user.organization*	string
results[].row.datasetPresenterID*	string
results[].row.restrictionLevel*	string	Enum: PUBLIC PRERELEASE PROTECTED CONTROLLED PRIVATE
results[].row.approvalStatus*	string	Enum: APPROVED REQUESTED DENIED
results[].row.startDate*	datetime-only
results[].row.duration*	integer	Format: int64
results[].row.purpose*	string
results[].row.researchQuestion*	string
results[].row.analysisPlan*	string
results[].row.priorAuth*	string
results[].row.denialReason*	string
results[].row.dateDenied*	datetime-only
results[].row.allowSelfEdits*	boolean

Inherits: object

Model

Parameter	Type	Description
rows*	integer	Format: int64
offset*	integer	Format: int64

Inherits: object

Model

Parameter	Type	Description
cause*	object	Inherits: lib.HistoryCause
cause.user*	object	Inherits: lib.HistoryUser
cause.user.userID*	integer	Format: int64
cause.user.firstName*	string
cause.user.lastName*	string
cause.user.email*	string
cause.user.organization*	string
cause.action*	string	Enum: CREATE UPDATE DELETE
cause.timestamp*	datetime-only
row*	object	Inherits: lib.HistoryRow
row.endUserID*	integer	Format: int64
row.user*	object	Inherits: lib.HistoryUser
row.user.userID*	integer	Format: int64
row.user.firstName*	string
row.user.lastName*	string
row.user.email*	string
row.user.organization*	string
row.datasetPresenterID*	string
row.restrictionLevel*	string	Enum: PUBLIC PRERELEASE PROTECTED CONTROLLED PRIVATE
row.approvalStatus*	string	Enum: APPROVED REQUESTED DENIED
row.startDate*	datetime-only
row.duration*	integer	Format: int64
row.purpose*	string
row.researchQuestion*	string
row.analysisPlan*	string
row.priorAuth*	string
row.denialReason*	string
row.dateDenied*	datetime-only
row.allowSelfEdits*	boolean

Inherits: object

Model

Parameter	Type	Description
user*	object	Inherits: lib.HistoryUser
user.userID*	integer	Format: int64
user.firstName*	string
user.lastName*	string
user.email*	string
user.organization*	string
action*	string	Enum: CREATE UPDATE DELETE
timestamp*	datetime-only

Inherits: object

Model

Parameter	Type	Description
userID*	integer	Format: int64
firstName*	string
lastName*	string
email*	string
organization*	string

Inherits: object

Model

Parameter	Type	Description
endUserID*	integer	Format: int64
user*	object	Inherits: object
user.userID*	integer	Format: int64
user.firstName*	string
user.lastName*	string
user.email*	string
user.organization*	string
datasetPresenterID*	string
restrictionLevel*	string	Enum: PUBLIC PRERELEASE PROTECTED CONTROLLED PRIVATE
approvalStatus*	string	Enum: APPROVED REQUESTED DENIED
startDate*	datetime-only
duration*	integer	Format: int64
purpose*	string
researchQuestion*	string
analysisPlan*	string
priorAuth*	string
denialReason*	string
dateDenied*	datetime-only
allowSelfEdits*	boolean

Inherits: object

Model

Parameter	Type	Description
isStaff	boolean	Indicates whether the current user is listed in the service's staff entries.
isOwner	boolean	Indicates whether the current user is listed in the service's staff entries and is marked as a site owner.
perDataset	object	If the current user is a provider or an end user of one or more datasets, these datasets will be listed here with the user's permission level for each specific dataset. If the user is not a provider or end user for any datasets, this field will be omitted.
perDataset.//*	object	Inherits: lib.DatasetPermissionEntry
perDataset.//.studyId*	string
perDataset.//.sha1Hash*	string
perDataset.//.isUserStudy*	boolean
perDataset.//.displayName*	string
perDataset.//.shortDisplayName*	string
perDataset.//.description*	string
perDataset.//.type*	string	Enum: provider end-user Inherits: lib.DatasetPermissionLevel
perDataset.//.actionAuthorization*	object	Inherits: lib.ActionList
perDataset.//.actionAuthorization.studyMetadata*	boolean	study metadata
perDataset.//.actionAuthorization.subsetting*	boolean	count, distribution
perDataset.//.actionAuthorization.visualizations*	boolean	all viz plugins
perDataset.//.actionAuthorization.resultsFirstPage*	boolean	offset:0, numRecords: <=20
perDataset.//.actionAuthorization.resultsAll*	boolean	any other tabular response
perDataset.//.isManager	boolean	For providers, this field indicates whether the current user is marked as a manager for the dataset represented by the containing permission entry. This field will only be present if the containing permission entry type = `provider`.
perDataset.//.accessRequestStatus*	string	Enum: unrequested approved requested denied Inherits: string

Inherits: object

Model

Parameter	Type	Description
studyMetadata*	boolean	study metadata
subsetting*	boolean	count, distribution
visualizations*	boolean	all viz plugins
resultsFirstPage*	boolean	offset:0, numRecords: <=20
resultsAll*	boolean	any other tabular response

Inherits: object

Model

Parameter	Type	Description
studyId*	string
datasetId*	string
isUserStudy*	boolean
actionAuthorization*	object	Inherits: object
actionAuthorization.studyMetadata*	boolean	study metadata
actionAuthorization.subsetting*	boolean	count, distribution
actionAuthorization.visualizations*	boolean	all viz plugins
actionAuthorization.resultsFirstPage*	boolean	offset:0, numRecords: <=20
actionAuthorization.resultsAll*	boolean	any other tabular response

Inherits: object

Model

Parameter	Type	Description
studyId*	string
sha1Hash*	string
isUserStudy*	boolean
displayName*	string
shortDisplayName*	string
description*	string
type*	string	Enum: provider end-user Inherits: lib.DatasetPermissionLevel
actionAuthorization*	object	Inherits: object
actionAuthorization.studyMetadata*	boolean	study metadata
actionAuthorization.subsetting*	boolean	count, distribution
actionAuthorization.visualizations*	boolean	all viz plugins
actionAuthorization.resultsFirstPage*	boolean	offset:0, numRecords: <=20
actionAuthorization.resultsAll*	boolean	any other tabular response
isManager	boolean	For providers, this field indicates whether the current user is marked as a manager for the dataset represented by the containing permission entry. This field will only be present if the containing permission entry type = `provider`.
accessRequestStatus*	string	Enum: unrequested approved requested denied Inherits: string

Enum:

provider
end-user

Inherits: string

Inherits: object

Model

Parameter	Type	Description
staffId*	integer	Min. value: 1 Format: int64 Inherits: integer
user*	object	Inherits: object
user.userId*	integer	Min. value: 1 Format: int64
user.firstName*	string
user.lastName*	string
user.organization*	string
user.email*	string
isOwner*	boolean

Inherits: object

Model

Parameter	Type	Description
data*	array
data[]	object	Inherits: object
data[].staffId*	integer	Min. value: 1 Format: int64 Inherits: integer
data[].user*	object	Inherits: object
data[].user.userId*	integer	Min. value: 1 Format: int64
data[].user.firstName*	string
data[].user.lastName*	string
data[].user.organization*	string
data[].user.email*	string
data[].isOwner*	boolean
rows*	integer	Format: int64
offset*	integer	Format: int64
total*	integer	Format: int64

Additional properties: Yes

Inherits: object

Model

Parameter

Type

Description

userId*

integer

Min. value: 1

Format: int64

isOwner*

boolean

Inherits: object

Model

Parameter

Type

Description

staffId*

integer

Min. value: 1

Format: int64

Inherits: object

Model

Parameter	Type	Description
op*	string	Pattern: ^replace$
path*	string	Pattern: ^/isOwner$
value*	boolean

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

Inherits: object

Model

Parameter

Type

Description

jobID*

string

128-bit digest based identifier.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: string

status*

string

Enum:

no-such-job
queued
in-progress
complete
failed
expired

Inherits: string

queuePosition

integer

Format: int32

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object

Enum:

native
derived
computed

Inherits: string

Enum:

xAxis
yAxis
zAxis
overlay
facet1
facet2
geo
latitude
longitude

Inherits: string

Inherits: 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

Additional 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

Enum:

stringSet
numberSet
dateSet
numberRange
dateRange
longitudeRange
multiFilter

Inherits: string

Enum:

intersect
union

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
variableId*	string
stringSet*	array
stringSet[]	string

Additional 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

Additional properties: Yes

Discriminator: type

Discriminator value: stringSet

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
stringSet*	array
stringSet[]	string

Additional properties: Yes

Discriminator: type

Discriminator value: numberSet

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
numberSet*	array
numberSet[]	number

Additional properties: Yes

Discriminator: type

Discriminator value: dateSet

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
dateSet*	array
dateSet[]	string

Additional 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

Additional properties: Yes

Discriminator: type

Discriminator value: dateRange

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*	string
max*	string

Additional 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

Inherits: lib.VariableSpec

Model

Parameter	Type	Description
entityId*	string
variableId*	string
functionName*	string
displayName*	string
config*	object

Inherits: object

Model

Parameter	Type	Description
computeName*	string
computeConfig*	object

Inherits: object

Model

Parameter	Type	Description
studyId*	string
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

Inherits: lib.DerivedVariableBulkMetadataRequest

Model

Parameter	Type	Description
studyId*	string
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
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
entityId*	string
outputVariables*	array
outputVariables[]	object	Inherits: lib.VariableSpec
outputVariables[].entityId*	string
outputVariables[].variableId*	string
computeSpec	object	Inherits: object
computeSpec.computeName*	string
computeSpec.computeConfig*	object	Additional properties: Yes

Enum:

transform
reduction

Inherits: string

Inherits: lib.VariableSpec

Model

Parameter	Type	Description
entityId*	string
variableId*	string
derivationType*	string	Enum: transform reduction Inherits: string
variableType*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
units	string
dataRange	object	Inherits: lib.Range
dataRange.min*	string
dataRange.max*	string

Inherits: object

Model

Parameter	Type	Description
entityId*	string
variableId*	string

Inherits: object

Model

Parameter	Type	Description
entityId*	string
collectionId*	string

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: 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

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: 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

Inherits: object

Model

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Inherits: object

Model

Parameter	Type	Description
min*	string
max*	string

Inherits: lib.Range

Model

Parameter	Type	Description
min*	string
max*	string
label*	string

Inherits: object

Model

Parameter	Type	Description
studies*	array
studies[]	object	Additional properties: Yes Inherits: lib.API_StudyOverview
studies[].id*	string
studies[].datasetId*	string
studies[].sha1hash*	string
studies[].sourceType*	string	Enum: curated user_submitted Inherits: lib.StudySourceType
studies[].displayName*	string
studies[].shortDisplayName*	string
studies[].lastModified*	datetime
studies[].description*	string

Inherits: object

Model

Parameter	Type	Description
study*	object	Additional properties: Yes Inherits: lib.API_StudyDetail
study.id*	string
study.isUserStudy*	boolean
study.hasMap*	boolean
study.rootEntity*	object	Additional properties: Yes Inherits: lib.API_Entity
study.rootEntity.id*	string
study.rootEntity.idColumnName*	string
study.rootEntity.displayName*	string
study.rootEntity.displayNamePlural*	string
study.rootEntity.description*	string
study.rootEntity.isManyToOneWithParent*	boolean
study.rootEntity.variables*	array
study.rootEntity.variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
study.rootEntity.variables[].id*	string
study.rootEntity.variables[].parentId	string
study.rootEntity.variables[].providerLabel*	string
study.rootEntity.variables[].displayName*	string
study.rootEntity.variables[].definition	string
study.rootEntity.variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
study.rootEntity.variables[].displayOrder	integer	Format: int64
study.rootEntity.variables[].isCategory*	string
study.rootEntity.variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
study.rootEntity.variables[].hideFrom*	array
study.rootEntity.variables[].hideFrom[]	string
study.rootEntity.collections*	array
study.rootEntity.collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
study.rootEntity.collections[].id*	string
study.rootEntity.collections[].displayName*	string
study.rootEntity.collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
study.rootEntity.collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
study.rootEntity.collections[].vocabulary	array
study.rootEntity.collections[].vocabulary[]	string
study.rootEntity.collections[].distinctValuesCount	integer	Format: int64
study.rootEntity.collections[].memberVariableIds*	array
study.rootEntity.collections[].memberVariableIds[]	string
study.rootEntity.collections[].imputeZero*	boolean
study.rootEntity.collections[].normalizationMethod*	string
study.rootEntity.collections[].isCompositional*	boolean
study.rootEntity.collections[].isProportion*	boolean
study.rootEntity.collections[].variableSpecToImputeZeroesFor	object	Inherits: object
study.rootEntity.collections[].variableSpecToImputeZeroesFor.entityId*	string
study.rootEntity.collections[].variableSpecToImputeZeroesFor.variableId*	string
study.rootEntity.collections[].member*	string
study.rootEntity.collections[].memberPlural*	string
study.rootEntity.children	array
study.rootEntity.children[]	$recur

Enum:

curated
user_submitted

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
id*	string
datasetId*	string
sha1hash*	string
sourceType*	string	Enum: curated user_submitted Inherits: string
displayName*	string
shortDisplayName*	string
lastModified*	datetime
description*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
id*	string
idColumnName*	string
displayName*	string
displayNamePlural*	string
description*	string
isManyToOneWithParent*	boolean
variables*	array
variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
variables[].id*	string
variables[].parentId	string
variables[].providerLabel*	string
variables[].displayName*	string
variables[].definition	string
variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
variables[].displayOrder	integer	Format: int64
variables[].isCategory*	string
variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
variables[].hideFrom*	array
variables[].hideFrom[]	string
collections*	array
collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
collections[].id*	string
collections[].displayName*	string
collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
collections[].vocabulary	array
collections[].vocabulary[]	string
collections[].distinctValuesCount	integer	Format: int64
collections[].memberVariableIds*	array
collections[].memberVariableIds[]	string
collections[].imputeZero*	boolean
collections[].normalizationMethod*	string
collections[].isCompositional*	boolean
collections[].isProportion*	boolean
collections[].variableSpecToImputeZeroesFor	object	Inherits: object
collections[].variableSpecToImputeZeroesFor.entityId*	string
collections[].variableSpecToImputeZeroesFor.variableId*	string
collections[].member*	string
collections[].memberPlural*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
id*	string
isUserStudy*	boolean
hasMap*	boolean
rootEntity*	object	Additional properties: Yes Inherits: object
rootEntity.id*	string
rootEntity.idColumnName*	string
rootEntity.displayName*	string
rootEntity.displayNamePlural*	string
rootEntity.description*	string
rootEntity.isManyToOneWithParent*	boolean
rootEntity.variables*	array
rootEntity.variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
rootEntity.variables[].id*	string
rootEntity.variables[].parentId	string
rootEntity.variables[].providerLabel*	string
rootEntity.variables[].displayName*	string
rootEntity.variables[].definition	string
rootEntity.variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
rootEntity.variables[].displayOrder	integer	Format: int64
rootEntity.variables[].isCategory*	string
rootEntity.variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
rootEntity.variables[].hideFrom*	array
rootEntity.variables[].hideFrom[]	string
rootEntity.collections*	array
rootEntity.collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
rootEntity.collections[].id*	string
rootEntity.collections[].displayName*	string
rootEntity.collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
rootEntity.collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
rootEntity.collections[].vocabulary	array
rootEntity.collections[].vocabulary[]	string
rootEntity.collections[].distinctValuesCount	integer	Format: int64
rootEntity.collections[].memberVariableIds*	array
rootEntity.collections[].memberVariableIds[]	string
rootEntity.collections[].imputeZero*	boolean
rootEntity.collections[].normalizationMethod*	string
rootEntity.collections[].isCompositional*	boolean
rootEntity.collections[].isProportion*	boolean
rootEntity.collections[].variableSpecToImputeZeroesFor	object	Inherits: object
rootEntity.collections[].variableSpecToImputeZeroesFor.entityId*	string
rootEntity.collections[].variableSpecToImputeZeroesFor.variableId*	string
rootEntity.collections[].member*	string
rootEntity.collections[].memberPlural*	string
rootEntity.children	array
rootEntity.children[]	$recur

Additional properties: Yes

Inherits: lib.EntityIdGetResponse

Model

Parameter	Type	Description
id*	string
idColumnName*	string
displayName*	string
displayNamePlural*	string
description*	string
isManyToOneWithParent*	boolean
variables*	array
variables[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Variable
variables[].id*	string
variables[].parentId	string
variables[].providerLabel*	string
variables[].displayName*	string
variables[].definition	string
variables[].displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
variables[].displayOrder	integer	Format: int64
variables[].isCategory*	string
variables[].type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
variables[].hideFrom*	array
variables[].hideFrom[]	string
collections*	array
collections[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Collection
collections[].id*	string
collections[].displayName*	string
collections[].type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
collections[].dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
collections[].vocabulary	array
collections[].vocabulary[]	string
collections[].distinctValuesCount	integer	Format: int64
collections[].memberVariableIds*	array
collections[].memberVariableIds[]	string
collections[].imputeZero*	boolean
collections[].normalizationMethod*	string
collections[].isCompositional*	boolean
collections[].isProportion*	boolean
collections[].variableSpecToImputeZeroesFor	object	Inherits: object
collections[].variableSpecToImputeZeroesFor.entityId*	string
collections[].variableSpecToImputeZeroesFor.variableId*	string
collections[].member*	string
collections[].memberPlural*	string
children	array
children[]	$recur

Additional properties: Yes

Discriminator: type

Inherits: object

Model

Parameter	Type	Description
id*	string
displayName*	string
type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount	integer	Format: int64
memberVariableIds*	array
memberVariableIds[]	string
imputeZero*	boolean
normalizationMethod*	string
isCompositional*	boolean
isProportion*	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
member*	string
memberPlural*	string

Enum:

number
date
integer
string

Inherits: string

Additional properties: Yes

Discriminator: type

Discriminator value: number

Inherits: lib.API_Collection

Model

Parameter	Type	Description
id*	string
displayName*	string
type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount	integer	Format: int64
memberVariableIds*	array
memberVariableIds[]	string
imputeZero*	boolean
normalizationMethod*	string
isCompositional*	boolean
isProportion*	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
member*	string
memberPlural*	string
distributionDefaults*	object	Additional properties: Yes Inherits: lib.API_NumberDistributionDefaults
distributionDefaults.displayRangeMin	number
distributionDefaults.displayRangeMax	number
distributionDefaults.rangeMin	number
distributionDefaults.rangeMax	number
distributionDefaults.binWidth	number
distributionDefaults.binWidthOverride	number
units*	string
precision*	number

Additional properties: Yes

Discriminator: type

Discriminator value: integer

Inherits: lib.API_Collection

Model

Parameter	Type	Description
id*	string
displayName*	string
type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount	integer	Format: int64
memberVariableIds*	array
memberVariableIds[]	string
imputeZero*	boolean
normalizationMethod*	string
isCompositional*	boolean
isProportion*	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
member*	string
memberPlural*	string
distributionDefaults*	object	Additional properties: Yes Inherits: lib.API_IntegerDistributionDefaults
distributionDefaults.displayRangeMin	integer	Format: int64
distributionDefaults.displayRangeMax	integer	Format: int64
distributionDefaults.rangeMin	integer	Format: int64
distributionDefaults.rangeMax	integer	Format: int64
distributionDefaults.binWidth	integer	Format: int64
distributionDefaults.binWidthOverride	integer	Format: int64
units*	string

Additional properties: Yes

Discriminator: type

Discriminator value: date

Inherits: lib.API_Collection

Model

Parameter	Type	Description
id*	string
displayName*	string
type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount	integer	Format: int64
memberVariableIds*	array
memberVariableIds[]	string
imputeZero*	boolean
normalizationMethod*	string
isCompositional*	boolean
isProportion*	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
member*	string
memberPlural*	string
distributionDefaults*	object	Additional properties: Yes Inherits: lib.API_DateDistributionDefaults
distributionDefaults.displayRangeMin	string
distributionDefaults.displayRangeMax	string
distributionDefaults.rangeMin	string
distributionDefaults.rangeMax	string
distributionDefaults.binWidth	integer
distributionDefaults.binWidthOverride	integer
distributionDefaults.binUnits	string	Enum: day week month year Inherits: lib.BinUnits

Additional properties: Yes

Discriminator: type

Discriminator value: string

Inherits: lib.API_Collection

Model

Parameter	Type	Description
id*	string
displayName*	string
type*	string	Enum: number date integer string Inherits: lib.API_CollectionType
dataShape*	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount	integer	Format: int64
memberVariableIds*	array
memberVariableIds[]	string
imputeZero*	boolean
normalizationMethod*	string
isCompositional*	boolean
isProportion*	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
member*	string
memberPlural*	string

Additional properties: Yes

Discriminator: type

Inherits: object

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string

Additional properties: Yes

Discriminator: type

Inherits: lib.API_Variable

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string

Enum:

category
string
number
date
longitude
integer

Inherits: string

Enum:

continuous
categorical
ordinal
binary

Inherits: string

Enum:

default
hidden
multifilter
geoaggregator
latitude
longitude

Inherits: string

Enum:

log
log2
ln

Inherits: string

Additional properties: Yes

Discriminator: type

Discriminator value: category

Inherits: lib.API_Variable

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string

Additional properties: Yes

Discriminator: type

Discriminator value: string

Inherits: lib.API_VariableWithValues

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string

Additional properties: Yes

Discriminator: type

Discriminator value: longitude

Inherits: lib.API_VariableWithValues

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
precision*	number

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
displayRangeMin	number
displayRangeMax	number
rangeMin	number
rangeMax	number
binWidth	number
binWidthOverride	number

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
displayRangeMin	integer	Format: int64
displayRangeMax	integer	Format: int64
rangeMin	integer	Format: int64
rangeMax	integer	Format: int64
binWidth	integer	Format: int64
binWidthOverride	integer	Format: int64

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
displayRangeMin	string
displayRangeMax	string
rangeMin	string
rangeMax	string
binWidth	integer
binWidthOverride	integer
binUnits	string	Enum: day week month year Inherits: lib.BinUnits

Additional properties: Yes

Discriminator: type

Discriminator value: number

Inherits: lib.API_VariableWithValues

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
distributionDefaults*	object	Additional properties: Yes Inherits: object
distributionDefaults.displayRangeMin	number
distributionDefaults.displayRangeMax	number
distributionDefaults.rangeMin	number
distributionDefaults.rangeMax	number
distributionDefaults.binWidth	number
distributionDefaults.binWidthOverride	number
units	string
precision*	number
scale	string	Enum: log log2 ln Inherits: string

Additional properties: Yes

Discriminator: type

Discriminator value: integer

Inherits: lib.API_VariableWithValues

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
distributionDefaults*	object	Additional properties: Yes Inherits: object
distributionDefaults.displayRangeMin	integer	Format: int64
distributionDefaults.displayRangeMax	integer	Format: int64
distributionDefaults.rangeMin	integer	Format: int64
distributionDefaults.rangeMax	integer	Format: int64
distributionDefaults.binWidth	integer	Format: int64
distributionDefaults.binWidthOverride	integer	Format: int64
units	string

Additional properties: Yes

Discriminator: type

Discriminator value: date

Inherits: lib.API_VariableWithValues

Model

Parameter	Type	Description
id*	string
parentId	string
providerLabel*	string
displayName*	string
definition	string
displayType*	string	Enum: default hidden multifilter geoaggregator latitude longitude Inherits: lib.API_VariableDisplayType
displayOrder	integer	Format: int64
isCategory*	string
type*	string	Enum: category string number date longitude integer Inherits: lib.API_VariableType
hideFrom*	array
hideFrom[]	string
dataShape	string	Enum: continuous categorical ordinal binary Inherits: lib.API_VariableDataShape
vocabulary	array
vocabulary[]	string
distinctValuesCount*	integer	Format: int64
isTemporal*	boolean
isFeatured*	boolean
isMergeKey*	boolean
isMultiValued*	boolean
imputeZero*	boolean
hasStudyDependentVocabulary	boolean
variableSpecToImputeZeroesFor	object	Inherits: object
variableSpecToImputeZeroesFor.entityId*	string
variableSpecToImputeZeroesFor.variableId*	string
distributionDefaults*	object	Additional properties: Yes Inherits: object
distributionDefaults.displayRangeMin	string
distributionDefaults.displayRangeMax	string
distributionDefaults.rangeMin	string
distributionDefaults.rangeMax	string
distributionDefaults.binWidth	integer
distributionDefaults.binWidthOverride	integer
distributionDefaults.binUnits	string	Enum: day week month year Inherits: lib.BinUnits

Inherits: object

Model

Parameter	Type	Description
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

Inherits: object

Model

Parameter	Type	Description
count*	integer	Format: int64

Enum:

asc
desc

Inherits: string

Inherits: object

Model

Parameter	Type	Description
key*	string
direction*	string	Enum: asc desc Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
numRows	integer	Format: int64
offset	integer	Format: int64

Enum:

standard
display

Inherits: string

Enum:

database
file

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
sorting	array
sorting[]	object	Inherits: object
sorting[].key*	string
sorting[].direction*	string	Enum: asc desc Inherits: string
paging	object	Additional properties: Yes Inherits: object
paging.numRows	integer	Format: int64
paging.offset	integer	Format: int64
headerFormat	string	Enum: standard display Inherits: string
trimTimeFromDateVars	boolean
dataSource	string	Enum: database file Inherits: string

Inherits: object

Model

Parameter	Type	Description
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
outputVariableIds*	array
outputVariableIds[]	string
reportConfig	object	Additional properties: Yes Inherits: object
reportConfig.sorting	array
reportConfig.sorting[]	object	Inherits: object
reportConfig.sorting[].key*	string
reportConfig.sorting[].direction*	string	Enum: asc desc Inherits: string
reportConfig.paging	object	Additional properties: Yes Inherits: object
reportConfig.paging.numRows	integer	Format: int64
reportConfig.paging.offset	integer	Format: int64
reportConfig.headerFormat	string	Enum: standard display Inherits: string
reportConfig.trimTimeFromDateVars	boolean
reportConfig.dataSource	string	Enum: database file Inherits: string

Enum:

day
week
month
year

Inherits: string

Inherits: object

Model

Parameter	Type	Description
displayRangeMin*	any
displayRangeMax*	any
binWidth*	number
binUnits	string	Enum: day week month year Inherits: string

Enum:

count
proportion

Inherits: string

Inherits: object

Model

Parameter	Type	Description
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
binSpec	object	Inherits: object
binSpec.displayRangeMin*	any
binSpec.displayRangeMax*	any
binSpec.binWidth*	number
binSpec.binUnits	string	Enum: day week month year Inherits: string
valueSpec*	string	Enum: count proportion Inherits: string

Inherits: object

Model

Parameter	Type	Description
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

Inherits: lib.EntityTabularPostResponse

Model

Parameter	Type	Description
tabular*	array
tabular[]	array
tabular[][]	string

Inherits: object

Model

Parameter	Type	Description
value*	number
binStart*	string
binEnd*	string
binLabel*	string

Inherits: object

Model

Parameter	Type	Description
subsetSize*	integer	Format: int64
subsetMin	any
subsetMax	any
subsetMean	any
numVarValues*	integer	Format: int64
numDistinctValues*	integer	Format: int64
numDistinctEntityRecords*	integer	Format: int64
numMissingCases*	integer	Format: int64

Inherits: object

Model

Parameter	Type	Description
histogram*	array
histogram[]	object	Inherits: object
histogram[].value*	number
histogram[].binStart*	string
histogram[].binEnd*	string
histogram[].binLabel*	string
statistics*	object	Inherits: object
statistics.subsetSize*	integer	Format: int64
statistics.subsetMin	any
statistics.subsetMax	any
statistics.subsetMean	any
statistics.numVarValues*	integer	Format: int64
statistics.numDistinctValues*	integer	Format: int64
statistics.numDistinctEntityRecords*	integer	Format: int64
statistics.numMissingCases*	integer	Format: int64

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.AlphaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.alphaDivMethod*	string	Enum: shannon simpson evenness Inherits: lib.AlphaDivMethod

Additional 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

Enum:

shannon
simpson
evenness

Inherits: string

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BetaDivComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.betaDivDissimilarityMethod*	string	Enum: bray jaccard jsd Inherits: lib.BetaDivDissimilarityMethod

Additional 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

Enum:

bray
jaccard
jsd

Inherits: string

Enum:

spearman
pearson

Inherits: string

Enum:

spearman
pearson
sparcc

Inherits: string

Inherits: object

Model

Parameter	Type	Description
proportionNonZero	number
variance	number
standardDeviation	number

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
prefilterThresholds	object	Inherits: object
prefilterThresholds.proportionNonZero	number
prefilterThresholds.variance	number
prefilterThresholds.standardDeviation	number

Enum:

metadata
collection

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
dataType*	string	Enum: metadata collection Inherits: string
collectionSpec	object	Inherits: object
collectionSpec.entityId*	string
collectionSpec.collectionId*	string

Additional properties: Yes

Inherits: lib.BaseCorrelationComputeConfig

Model

Parameter	Type	Description
prefilterThresholds	object	Inherits: object
prefilterThresholds.proportionNonZero	number
prefilterThresholds.variance	number
prefilterThresholds.standardDeviation	number
correlationMethod*	string	Enum: spearman pearson Inherits: string
data1*	object	Additional properties: Yes Inherits: object
data1.dataType*	string	Enum: metadata collection Inherits: string
data1.collectionSpec	object	Inherits: object
data1.collectionSpec.entityId*	string
data1.collectionSpec.collectionId*	string
data2*	object	Additional properties: Yes Inherits: object
data2.dataType*	string	Enum: metadata collection Inherits: string
data2.collectionSpec	object	Inherits: object
data2.collectionSpec.entityId*	string
data2.collectionSpec.collectionId*	string

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson Inherits: string
config.data1*	object	Additional properties: Yes Inherits: object
config.data1.dataType*	string	Enum: metadata collection Inherits: string
config.data1.collectionSpec	object	Inherits: object
config.data1.collectionSpec.entityId*	string
config.data1.collectionSpec.collectionId*	string
config.data2*	object	Additional properties: Yes Inherits: object
config.data2.dataType*	string	Enum: metadata collection Inherits: string
config.data2.collectionSpec	object	Inherits: object
config.data2.collectionSpec.entityId*	string
config.data2.collectionSpec.collectionId*	string

Additional properties: Yes

Inherits: lib.BaseCorrelationComputeConfig

Model

Parameter	Type	Description
prefilterThresholds	object	Inherits: object
prefilterThresholds.proportionNonZero	number
prefilterThresholds.variance	number
prefilterThresholds.standardDeviation	number
correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
data1*	object	Inherits: object
data1.entityId*	string
data1.collectionId*	string

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.BaseCorrelationComputeConfig
config.prefilterThresholds	object	Inherits: object
config.prefilterThresholds.proportionNonZero	number
config.prefilterThresholds.variance	number
config.prefilterThresholds.standardDeviation	number
config.correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
config.data1*	object	Inherits: object
config.data1.entityId*	string
config.data1.collectionId*	string

Inherits: object

Model

Parameter	Type	Description
statistics*	array
statistics[]	object	Additional properties: Yes Inherits: lib.CorrelationPoint
statistics[].data1*	string
statistics[].data2*	string
statistics[].correlationCoef	string
statistics[].pValue	string
statistics[].adjustedPValue	string
data1Metadata*	string
data2Metadata*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
data1*	string
data2*	string
correlationCoef	string
pValue	string
adjustedPValue	string

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.DifferentialAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.comparator*	object	Additional properties: Yes Inherits: lib.ComparatorSpec
config.comparator.variable*	object	Inherits: object
config.comparator.variable.entityId*	string
config.comparator.variable.variableId*	string
config.comparator.groupA*	array
config.comparator.groupA[]	object	Inherits: lib.Range
config.comparator.groupA[].min*	string
config.comparator.groupA[].max*	string
config.comparator.groupA[].label*	string
config.comparator.groupB*	array
config.comparator.groupB[]	object	Inherits: lib.Range
config.comparator.groupB[].min*	string
config.comparator.groupB[].max*	string
config.comparator.groupB[].label*	string
config.differentialAbundanceMethod*	string	Enum: DESeq ANCOMBC Maaslin Inherits: lib.DifferentialAbundanceMethod
config.pValueFloor	string

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: DESeq ANCOMBC Maaslin Inherits: lib.DifferentialAbundanceMethod
pValueFloor	string

Enum:

DESeq
ANCOMBC
Maaslin

Inherits: string

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

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

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

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.ExampleComputeConfig
config.inputVariable*	object	Inherits: object
config.inputVariable.entityId*	string
config.inputVariable.variableId*	string
config.valueSuffix*	string
config.failureProbability*	number

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputVariable*	object	Inherits: object
inputVariable.entityId*	string
inputVariable.variableId*	string
valueSuffix*	string
failureProbability*	number

Additional properties: Yes

Inherits: lib.ComputeRequestBase

Model

Parameter	Type	Description
studyId*	string
filters	array
filters[]	object	Additional properties: Yes Discriminator: type Inherits: lib.API_Filter
filters[].entityId*	string
filters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
derivedVariables*	array
derivedVariables[]	object	Inherits: lib.DerivedVariableSpec
derivedVariables[].entityId*	string
derivedVariables[].variableId*	string
derivedVariables[].functionName*	string
derivedVariables[].displayName*	string
derivedVariables[].config*	object	Additional properties: Yes
config*	object	Additional properties: Yes Inherits: lib.RankedAbundanceComputeConfig
config.collectionVariable*	object	Inherits: object
config.collectionVariable.entityId*	string
config.collectionVariable.collectionId*	string
config.rankingMethod*	string	Enum: median q3 variance max Inherits: lib.RankingMethod

Additional 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

Enum:

median
q3
variance
max

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
jobId*	string	128-bit digest based identifier. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32 Inherits: string
status*	string	Enum: no-such-job queued in-progress complete failed expired Inherits: string
owned*	boolean
created*	datetime
grabbed*	datetime
finished*	datetime

Inherits: object

Model

Parameter	Type	Description
name*	string
displayName*	string
description*	string
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

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
numJobsExpired*	integer

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

Inherits: 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

Inherits: object

Model

Parameter	Type	Description
significanceThreshold	number
correlationCoefThreshold	number
layout	string	Enum: none force circle nicely
degree*	boolean

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.nodes[].degree	number
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[].source.degree	number
bipartitenetwork.data.links[].target*	object	Additional properties: Yes Inherits: lib.NodeData
bipartitenetwork.data.links[].target.id*	string
bipartitenetwork.data.links[].target.degree	number
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

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: 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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: metadata collection Inherits: string
computeConfig.data1.collectionSpec	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: metadata collection Inherits: string
computeConfig.data2.collectionSpec	object	Inherits: object
computeConfig.data2.collectionSpec.entityId*	string
computeConfig.data2.collectionSpec.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
dataType*	string	Enum: collection
collectionSpec*	object	Inherits: object
collectionSpec.entityId*	string
collectionSpec.collectionId*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
dataType*	string	Enum: metadata

Additional properties: Yes

Inherits: lib.BaseCorrelationComputeConfig

Model

Parameter	Type	Description
prefilterThresholds	object	Inherits: object
prefilterThresholds.proportionNonZero	number
prefilterThresholds.variance	number
prefilterThresholds.standardDeviation	number
correlationMethod*	string	Enum: spearman pearson Inherits: string
data1*	object	Additional properties: Yes Inherits: object
data1.dataType*	string	Enum: collection
data1.collectionSpec*	object	Inherits: object
data1.collectionSpec.entityId*	string
data1.collectionSpec.collectionId*	string
data2*	object	Additional properties: Yes Inherits: object
data2.dataType*	string	Enum: collection
data2.collectionSpec*	object	Inherits: object
data2.collectionSpec.entityId*	string
data2.collectionSpec.collectionId*	string

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: 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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: collection
computeConfig.data1.collectionSpec*	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: collection
computeConfig.data2.collectionSpec*	object	Inherits: object
computeConfig.data2.collectionSpec.entityId*	string
computeConfig.data2.collectionSpec.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

Additional properties: Yes

Inherits: lib.BaseCorrelationComputeConfig

Model

Parameter	Type	Description
prefilterThresholds	object	Inherits: object
prefilterThresholds.proportionNonZero	number
prefilterThresholds.variance	number
prefilterThresholds.standardDeviation	number
correlationMethod*	string	Enum: spearman pearson Inherits: string
data1*	object	Additional properties: Yes Inherits: object
data1.dataType*	string	Enum: collection
data1.collectionSpec*	object	Inherits: object
data1.collectionSpec.entityId*	string
data1.collectionSpec.collectionId*	string
data2*	object	Additional properties: Yes Inherits: object
data2.dataType*	string	Enum: metadata

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: 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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson Inherits: string
computeConfig.data1*	object	Additional properties: Yes Inherits: object
computeConfig.data1.dataType*	string	Enum: collection
computeConfig.data1.collectionSpec*	object	Inherits: object
computeConfig.data1.collectionSpec.entityId*	string
computeConfig.data1.collectionSpec.collectionId*	string
computeConfig.data2*	object	Additional properties: Yes Inherits: object
computeConfig.data2.dataType*	string	Enum: metadata
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

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: 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.BaseCorrelationComputeConfig
computeConfig.prefilterThresholds	object	Inherits: object
computeConfig.prefilterThresholds.proportionNonZero	number
computeConfig.prefilterThresholds.variance	number
computeConfig.prefilterThresholds.standardDeviation	number
computeConfig.correlationMethod*	string	Enum: spearman pearson sparcc Inherits: string
computeConfig.data1*	object	Inherits: object
computeConfig.data1.entityId*	string
computeConfig.data1.collectionId*	string
config*	object	Inherits: object
config.significanceThreshold	number
config.correlationCoefThreshold	number
config.layout	string	Enum: none force circle nicely
config.degree*	boolean

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: 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

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: 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

Inherits: object

Model

Parameter	Type	Description
variable*	object	Inherits: object
variable.entityId*	string
variable.variableId*	string
metadata*	array
metadata[]	string	Enum: binRanges median

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

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

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
id*	string
degree	number

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
source*	object	Additional properties: Yes Inherits: object
source.id*	string
source.degree	number
target*	object	Additional properties: Yes Inherits: object
target.id*	string
target.degree	number
weight*	string
color*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
nodes*	array
nodes[]	object	Additional properties: Yes Inherits: object
nodes[].id*	string
nodes[].degree	number
links*	array
links[]	object	Additional properties: Yes Inherits: object
links[].source*	object	Additional properties: Yes Inherits: object
links[].source.id*	string
links[].source.degree	number
links[].target*	object	Additional properties: Yes Inherits: object
links[].target.id*	string
links[].target.degree	number
links[].weight*	string
links[].color*	string

Additional 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

Inherits: object

Model

Parameter	Type	Description
nodeIds*	array
nodeIds[]	string

Additional 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

Additional properties: Yes

Inherits: lib.NetworkData

Model

Parameter	Type	Description
nodes*	array
nodes[]	object	Additional properties: Yes Inherits: object
nodes[].id*	string
nodes[].degree	number
links*	array
links[]	object	Additional properties: Yes Inherits: object
links[].source*	object	Additional properties: Yes Inherits: object
links[].source.id*	string
links[].source.degree	number
links[].target*	object	Additional properties: Yes Inherits: object
links[].target.id*	string
links[].target.degree	number
links[].weight*	string
links[].color*	string
partitions*	array	Max. items: 2
partitions[]	object	Inherits: object
partitions[].nodeIds*	array
partitions[].nodeIds[]	string

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.nodes[].degree	number
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[].source.degree	number
data.links[].target*	object	Additional properties: Yes Inherits: object
data.links[].target.id*	string
data.links[].target.degree	number
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

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.nodes[].degree	number
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[].source.degree	number
bipartitenetwork.data.links[].target*	object	Additional properties: Yes Inherits: object
bipartitenetwork.data.links[].target.id*	string
bipartitenetwork.data.links[].target.degree	number
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

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: 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

Inherits: 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

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: 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

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: 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

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: 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

Inherits: 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

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: 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

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: 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

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

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: 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

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: 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

Inherits: 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

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: 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

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: 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

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: 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

Inherits: 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

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: 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

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: 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

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: 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

Inherits: 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

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
min*	string
q1*	string
median*	string
mean*	string
q3*	string
max*	string

Inherits: 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

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: 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

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: 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

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: 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

Inherits: 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

Inherits: 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

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: 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

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: 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

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: 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

Inherits: 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

Inherits: 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

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: 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

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: 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

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: 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

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

Inherits: object

Model

Parameter	Type	Description
completeCasesGeoVar*	number

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

Inherits: object

Model

Parameter	Type	Description
geoAggregateValue*	string
entityCount*	number
avgLat*	number
avgLon*	number
minLat*	number
minLon*	number
maxLat*	number
maxLon*	number

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: 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
config.correlationMethod*	string	Enum: none spearman pearson sparcc Inherits: lib.ScatterCorrelationMethod

Enum:

none
spearman
pearson
sparcc

Inherits: string

Inherits: 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
correlationMethod*	string	Enum: none spearman pearson sparcc Inherits: string

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: 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

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: 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

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: 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

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

Inherits: object

Model

Parameter	Type	Description
columns*	array
columns[]	object	Inherits: object
columns[].entityId*	string
columns[].variableId*	string
rows*	array
rows[]	array
rows[][]	string

Inherits: 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

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: 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

Inherits: object

Model

Parameter	Type	Description
value*	number
confidenceInterval	string
confidenceLevel	number
pvalue*	string

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

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: 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

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

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

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

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

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

Inherits: object

Model

Parameter	Type	Description
min*	number
max*	number
step*	number

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

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: 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

Inherits: 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

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

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: 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

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

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

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

Inherits: 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

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

Inherits: object

Model

Parameter	Type	Description
variableDetails*	object	Inherits: object
variableDetails.entityId*	string
variableDetails.variableId*	string
completeCases*	number

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: 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

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
label*	string
value*	number

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

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: 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
computeConfig.failureProbability*	number

Inherits: object

Model

Parameter	Type	Description
prefixVar*	object	Inherits: object
prefixVar.entityId*	string
prefixVar.variableId*	string

Inherits: object

Model

Parameter	Type	Description
countPluginResult*	integer
numEmptyValues*	integer
longestConcatenatedValue*	string
avgConcatenatedLength*	number

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: 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

Inherits: object

Model

Parameter	Type	Description
entityId*	string

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: 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

Inherits: object

Model

Parameter	Type	Description
entityId*	string

Inherits: object

Model

Parameter	Type	Description
recordCount*	integer

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: 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

Inherits: object

Model

Parameter	Type	Description
geoAggregateValue*	string
entityCount*	number
avgLat*	number
avgLon*	number
minLat*	number
minLon*	number
maxLat*	number
maxLon*	number

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: 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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.overlayConfig.selectedValues	array
config.overlayConfig.selectedValues[]	string

Inherits: object

Model

Parameter	Type	Description
outputEntityId*	string
barMode*	string	Enum: group stack
valueSpec*	string	Enum: count proportion Inherits: string
overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection*	object	Inherits: object
overlayConfig.collection.entityId*	string
overlayConfig.collection.collectionId*	string
overlayConfig.selectedMembers*	array
overlayConfig.selectedMembers[]	string
overlayConfig.selectedValues	array
overlayConfig.selectedValues[]	string

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: 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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.maxAllowedDataPoints	integer	Format: int64

Inherits: object

Model

Parameter	Type	Description
outputEntityId*	string
xAxisVariable*	object	Inherits: object
xAxisVariable.entityId*	string
xAxisVariable.variableId*	string
overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. Additional properties: Yes Inherits: lib.CollectionOverlayConfig
overlayConfig.collection*	object	Inherits: object
overlayConfig.collection.entityId*	string
overlayConfig.collection.collectionId*	string
overlayConfig.selectedMembers*	array
overlayConfig.selectedMembers[]	string
maxAllowedDataPoints	integer	Format: int64

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: 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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	string
config.xAxisVariable.selectedValues	array
config.xAxisVariable.selectedValues[]	string

Inherits: object

Model

Parameter	Type	Description
outputEntityId*	string
xAxisVariable*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues
xAxisVariable.collection*	object	Inherits: object
xAxisVariable.collection.entityId*	string
xAxisVariable.collection.collectionId*	string
xAxisVariable.selectedMembers*	array
xAxisVariable.selectedMembers[]	string
xAxisVariable.selectedValues	array
xAxisVariable.selectedValues[]	string

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: 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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

Inherits: object

Model

Parameter	Type	Description
outputEntityId*	string
barMode*	string	Enum: overlay stack
valueSpec*	string	Enum: count proportion Inherits: string
overlayConfig*	object	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. Additional properties: Yes Inherits: lib.CollectionOverlayConfig
overlayConfig.collection*	object	Inherits: object
overlayConfig.collection.entityId*	string
overlayConfig.collection.collectionId*	string
overlayConfig.selectedMembers*	array
overlayConfig.selectedMembers[]	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

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: 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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. 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[]	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

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	Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection. Additional properties: Yes Inherits: lib.CollectionOverlayConfigWithValues
overlayConfig.collection*	object	Inherits: object
overlayConfig.collection.entityId*	string
overlayConfig.collection.collectionId*	string
overlayConfig.selectedMembers*	array
overlayConfig.selectedMembers[]	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

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: 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 collection-level map marker visualization. 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.collectionOverlay*	object	Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig
config.collectionOverlay.collection*	object	Inherits: object
config.collectionOverlay.collection.entityId*	string
config.collectionOverlay.collection.collectionId*	string
config.collectionOverlay.selectedMembers*	array
config.collectionOverlay.selectedMembers[]	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

Specification for a collection-level map marker visualization.

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
collectionOverlay*	object	Collection variable to use for markers. Additional properties: Yes Inherits: lib.CollectionOverlayConfig
collectionOverlay.collection*	object	Inherits: object
collectionOverlay.collection.entityId*	string
collectionOverlay.collection.collectionId*	string
collectionOverlay.selectedMembers*	array
collectionOverlay.selectedMembers[]	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

Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection.

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
collection*	object	Inherits: object
collection.entityId*	string
collection.collectionId*	string
selectedMembers*	array
selectedMembers[]	string

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.

Inherits: lib.BaseMarker

Model

Parameter	Type	Description
geoAggregateValue*	string
entityCount*	number
avgLat*	number
avgLon*	number
minLat*	number
minLon*	number
maxLat*	number
maxLon*	number
overlayValues*	array
overlayValues[]	object	Additional properties: Yes Inherits: lib.CollectionMemberAggregate
overlayValues[].variableId*	string
overlayValues[].value*	number
overlayValues[].confidenceInterval*	object	Inherits: lib.NumberRange
overlayValues[].confidenceInterval.min*	number
overlayValues[].confidenceInterval.max*	number
overlayValues[].n*	number

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

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. Inherits: lib.BaseMarker
markers[].geoAggregateValue*	string
markers[].entityCount*	number
markers[].avgLat*	number
markers[].avgLon*	number
markers[].minLat*	number
markers[].minLon*	number
markers[].maxLat*	number
markers[].maxLon*	number
markers[].overlayValues*	array
markers[].overlayValues[]	object	Additional properties: Yes Inherits: lib.CollectionMemberAggregate
markers[].overlayValues[].variableId*	string
markers[].overlayValues[].value*	number
markers[].overlayValues[].confidenceInterval*	object	Inherits: lib.NumberRange
markers[].overlayValues[].confidenceInterval.min*	number
markers[].overlayValues[].confidenceInterval.max*	number
markers[].overlayValues[].n*	number

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: 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

Inherits: 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

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: 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

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: 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

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: 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

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: continuous categorical Inherits: lib.OverlayType
overlayConfig.overlayVariable*	object	Inherits: object
overlayConfig.overlayVariable.entityId*	string
overlayConfig.overlayVariable.variableId*	string
maxAllowedDataPoints	integer	Format: int64

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: 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

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: 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

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: 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

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

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: 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

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: 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

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: 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

Inherits: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

Inherits: 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

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: 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

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: 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

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: 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

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: continuous categorical Inherits: lib.OverlayType
sizeConfig*	object	Inherits: lib.SizeLegendConfig
sizeConfig.geoAggregateVariable*	object	Inherits: object
sizeConfig.geoAggregateVariable.entityId*	string
sizeConfig.geoAggregateVariable.variableId*	string

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: continuous categorical Inherits: lib.OverlayType

Inherits: object

Model

Parameter	Type	Description
geoAggregateVariable*	object	Inherits: object
geoAggregateVariable.entityId*	string
geoAggregateVariable.variableId*	string

Inherits: object

Model

Parameter	Type	Description
minColorValue*	string
maxColorValue*	string
minSizeValue*	number
maxSizeValue*	number

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: 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

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: 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

Inherits: object

Model

Parameter	Type	Description
mapElements*	array
mapElements[]	object	Inherits: object
mapElements[].geoAggregateValue*	string
mapElements[].entityCount*	number
mapElements[].avgLat*	number
mapElements[].avgLon*	number
mapElements[].minLat*	number
mapElements[].minLon*	number
mapElements[].maxLat*	number
mapElements[].maxLon*	number
mapElements[].overlayValue*	string

Inherits: lib.BaseMarker

Model

Parameter	Type	Description
geoAggregateValue*	string
entityCount*	number
avgLat*	number
avgLon*	number
minLat*	number
minLon*	number
maxLat*	number
maxLon*	number
overlayValue*	string

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: 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

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: 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

Inherits: object

Model

Parameter	Type	Description
mapElements*	array
mapElements[]	object	Inherits: object
mapElements[].geoAggregateValue*	string
mapElements[].entityCount*	number
mapElements[].avgLat*	number
mapElements[].avgLon*	number
mapElements[].minLat*	number
mapElements[].minLon*	number
mapElements[].maxLat*	number
mapElements[].maxLon*	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

Enum:

continuous
categorical

Inherits: string

Discriminator: overlayType

Inherits: object

Model

Parameter	Type	Description
overlayType*	string	Enum: continuous categorical Inherits: string
overlayVariable*	object	Inherits: object
overlayVariable.entityId*	string
overlayVariable.variableId*	string

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.OverlayConfig

Model

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

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.OverlayConfig

Model

Parameter	Type	Description
overlayType*	string	Enum: continuous categorical Inherits: string
overlayVariable*	object	Inherits: object
overlayVariable.entityId*	string
overlayVariable.variableId*	string
overlayValues*	array
overlayValues[]	string

Inherits: lib.BaseMarker

Model

Parameter	Type	Description
geoAggregateValue*	string
entityCount*	number
avgLat*	number
avgLon*	number
minLat*	number
minLon*	number
maxLat*	number
maxLon*	number
overlayValues*	array
overlayValues[]	object	Inherits: lib.LegacyLabeledRangeWithCountAndValue
overlayValues[].binStart*	string
overlayValues[].binEnd*	string
overlayValues[].binLabel*	string
overlayValues[].value*	number
overlayValues[].count*	number

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: 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

Inherits: object

Model

Parameter	Type	Description

Enum:

TRUE
FALSE

Inherits: string

Inherits: lib.VariableSpec

Model

Parameter	Type	Description
entityId*	string
variableId*	string
value*	string

Inherits: 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

Inherits: 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

Inherits: object

Model

Parameter	Type	Description
min*	number
max*	number

Inherits: object

Model

Parameter	Type	Description
min*	string
max*	string

Inherits: object

Model

Parameter	Type	Description
xMin*	string
xMax*	string

Inherits: object

Model

Parameter	Type	Description
left*	number
right*	number

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

Inherits: object

Model

Parameter	Type	Description
lowerBound*	number
upperBound*	number
error*	string

Inherits: object

Model

Parameter	Type	Description
N*	number

Inherits: object

Model

Parameter	Type	Description
numeratorN*	number
denominatorN*	number

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

Enum:

allVariables
strataVariables
noVariables
TRUE
FALSE

Inherits: string

Enum:

strataVariables
noVariables
TRUE
FALSE

Inherits: string

Inherits: 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

Inherits: 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

Enum:

mean
median

Inherits: string

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: continuous categorical Inherits: string

Discriminator: overlayType

Inherits: object

Model

Parameter	Type	Description
overlayType*	string	Enum: continuous categorical Inherits: string

Discriminator: 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

Discriminator: 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

Overlay configuration for the collection. Note that the variable IDs indicated must be members of the collection.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

Model

Parameter	Type	Description
collection*	object	Inherits: object
collection.entityId*	string
collection.collectionId*	string
selectedMembers*	array
selectedMembers[]	string
selectedValues	array
selectedValues[]	string

Inherits: object

Model

Parameter	Type	Description
binStart*	string
binEnd*	string
binLabel*	string

Inherits: lib.LegacyLabeledRange

Model

Parameter	Type	Description
binStart*	string
binEnd*	string
binLabel*	string
value*	number
count*	number

Inherits: object

Model

Parameter	Type	Description
name*	string
modifiedDate*	string
size*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
//*	any

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
mean*	object	Additional properties: Yes Inherits: lib.SingleNumericVarReductionConfig
mean.inputVariable*	object	Inherits: object
mean.inputVariable.entityId*	string
mean.inputVariable.variableId*	string
mean.imputeZero	boolean
sum*	object	Additional properties: Yes Inherits: lib.SingleNumericVarReductionConfig
sum.inputVariable*	object	Inherits: object
sum.inputVariable.entityId*	string
sum.inputVariable.variableId*	string
sum.imputeZero	boolean
concatenation*	object	Additional properties: Yes Inherits: lib.ConcatenationConfig
concatenation.prefix	string
concatenation.delimiter	string
concatenation.suffix	string
concatenation.inputVariables*	array
concatenation.inputVariables[]	object	Inherits: object
concatenation.inputVariables[].entityId*	string
concatenation.inputVariables[].variableId*	string
subsetMembership*	object	Additional properties: Yes Inherits: lib.SubsetMembershipConfig
subsetMembership.subsetFilters*	array
subsetMembership.subsetFilters[]	object	Additional properties: Yes Discriminator: type Inherits: object
subsetMembership.subsetFilters[].entityId*	string
subsetMembership.subsetFilters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
advancedSubset*	object	Additional properties: Yes Inherits: lib.AdvancedSubsetConfig
advancedSubset.rootStepKey*	string
advancedSubset.steps*	array
advancedSubset.steps[]	object	Additional properties: Yes Inherits: lib.Step
advancedSubset.steps[].key*	string
advancedSubset.steps[].operation*	string	Enum: intersect union minus Inherits: lib.SetOperation
advancedSubset.steps[].leftStepKey	string
advancedSubset.steps[].leftVariable	object	Inherits: object
advancedSubset.steps[].leftVariable.entityId*	string
advancedSubset.steps[].leftVariable.variableId*	string
advancedSubset.steps[].leftVariableTrueValues	array
advancedSubset.steps[].leftVariableTrueValues[]	string
advancedSubset.steps[].rightStepKey	string
advancedSubset.steps[].rightVariable	object	Inherits: object
advancedSubset.steps[].rightVariable.entityId*	string
advancedSubset.steps[].rightVariable.variableId*	string
advancedSubset.steps[].rightVariableTrueValues	array
advancedSubset.steps[].rightVariableTrueValues[]	string
unitConversion*	object	Additional properties: Yes Inherits: lib.UnitConversionConfig
unitConversion.inputVariable*	object	Inherits: object
unitConversion.inputVariable.entityId*	string
unitConversion.inputVariable.variableId*	string
unitConversion.outputUnits*	string
bodyMassIndex*	object	Additional properties: Yes Inherits: lib.BodyMassIndexConfig
bodyMassIndex.heightVariable*	object	Inherits: object
bodyMassIndex.heightVariable.entityId*	string
bodyMassIndex.heightVariable.variableId*	string
bodyMassIndex.weightVariable*	object	Inherits: object
bodyMassIndex.weightVariable.entityId*	string
bodyMassIndex.weightVariable.variableId*	string
categoricalRecoding*	object	Additional properties: Yes Inherits: lib.CategoricalRecodingConfig
categoricalRecoding.inputVariable*	object	Inherits: object
categoricalRecoding.inputVariable.entityId*	string
categoricalRecoding.inputVariable.variableId*	string
categoricalRecoding.rules*	array
categoricalRecoding.rules[]	object	Additional properties: Yes Inherits: lib.CategoricalRecodingRule
categoricalRecoding.rules[].inputValues*	array
categoricalRecoding.rules[].inputValues[]	string
categoricalRecoding.rules[].outputValue*	string
categoricalRecoding.unmappedValue	string
continuousToOrdinal*	object	Additional properties: Yes Inherits: lib.ContinuousNumericRecodingConfig
continuousToOrdinal.inputVariable*	object	Inherits: object
continuousToOrdinal.inputVariable.entityId*	string
continuousToOrdinal.inputVariable.variableId*	string
continuousToOrdinal.rules*	array
continuousToOrdinal.rules[]	object	Additional properties: Yes Inherits: lib.ContinuousNumericRule
continuousToOrdinal.rules[].minInclusive	number
continuousToOrdinal.rules[].maxExclusive	number
continuousToOrdinal.rules[].outputValue*	string
continuousToOrdinal.unmappedValue	string
ecmaScriptExpressionEval*	object	Additional properties: Yes Inherits: lib.EcmaScriptExpressionEvalConfig
ecmaScriptExpressionEval.ecmaScriptExpression*	string
ecmaScriptExpressionEval.nullResultOnAnyMissingInput*	boolean
ecmaScriptExpressionEval.inputVariables*	array
ecmaScriptExpressionEval.inputVariables[]	object	Additional properties: Yes Inherits: lib.VariableReference
ecmaScriptExpressionEval.inputVariables[].name*	string
ecmaScriptExpressionEval.inputVariables[].variable*	object	Inherits: object
ecmaScriptExpressionEval.inputVariables[].variable.entityId*	string
ecmaScriptExpressionEval.inputVariables[].variable.variableId*	string
ecmaScriptExpressionEval.expectedType*	string	Enum: category string number date longitude integer Inherits: string
ecmaScriptExpressionEval.expectedShape*	string	Enum: continuous categorical ordinal binary Inherits: string
relativeObservationMinTimeInterval*	object	Additional properties: Yes Inherits: lib.RelatedObservationMinTimeIntervalConfig
relativeObservationMinTimeInterval.relatedObservationsSubset*	array
relativeObservationMinTimeInterval.relatedObservationsSubset[]	object	Additional properties: Yes Discriminator: type Inherits: object
relativeObservationMinTimeInterval.relatedObservationsSubset[].entityId*	string
relativeObservationMinTimeInterval.relatedObservationsSubset[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
relativeObservationMinTimeInterval.anchorVariable*	object	Inherits: object
relativeObservationMinTimeInterval.anchorVariable.entityId*	string
relativeObservationMinTimeInterval.anchorVariable.variableId*	string
relativeObservationMinTimeInterval.anchorVariableTrueValues*	array
relativeObservationMinTimeInterval.anchorVariableTrueValues[]	string
relativeObservationMinTimeInterval.anchorTimestampVariable*	object	Inherits: object
relativeObservationMinTimeInterval.anchorTimestampVariable.entityId*	string
relativeObservationMinTimeInterval.anchorTimestampVariable.variableId*	string
relativeObservationMinTimeInterval.targetVariable*	object	Inherits: object
relativeObservationMinTimeInterval.targetVariable.entityId*	string
relativeObservationMinTimeInterval.targetVariable.variableId*	string
relativeObservationMinTimeInterval.targetVariableTrueValues*	array
relativeObservationMinTimeInterval.targetVariableTrueValues[]	string
relativeObservationMinTimeInterval.targetTimestampVariable*	object	Inherits: object
relativeObservationMinTimeInterval.targetTimestampVariable.entityId*	string
relativeObservationMinTimeInterval.targetTimestampVariable.variableId*	string
relativeObservationMinTimeInterval.minimumTimeIntervalDays*	integer

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
displayName*	string
values*	array
values[]	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
displayName*	string
units*	array
units[]	object	Additional properties: Yes Inherits: object
units[].displayName*	string
units[].values*	array
units[].values[]	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
types*	array
types[]	object	Additional properties: Yes Inherits: object
types[].displayName*	string
types[].units*	array
types[].units[]	object	Additional properties: Yes Inherits: object
types[].units[].displayName*	string
types[].units[].values*	array
types[].units[].values[]	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputVariable*	object	Inherits: object
inputVariable.entityId*	string
inputVariable.variableId*	string
imputeZero	boolean

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
prefix	string
delimiter	string
suffix	string
inputVariables*	array
inputVariables[]	object	Inherits: object
inputVariables[].entityId*	string
inputVariables[].variableId*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputValues*	array
inputValues[]	string
outputValue*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputVariable*	object	Inherits: object
inputVariable.entityId*	string
inputVariable.variableId*	string
rules*	array
rules[]	object	Additional properties: Yes Inherits: object
rules[].inputValues*	array
rules[].inputValues[]	string
rules[].outputValue*	string
unmappedValue	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
minInclusive	number
maxExclusive	number
outputValue*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputVariable*	object	Inherits: object
inputVariable.entityId*	string
inputVariable.variableId*	string
rules*	array
rules[]	object	Additional properties: Yes Inherits: object
rules[].minInclusive	number
rules[].maxExclusive	number
rules[].outputValue*	string
unmappedValue	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
heightVariable*	object	Inherits: object
heightVariable.entityId*	string
heightVariable.variableId*	string
weightVariable*	object	Inherits: object
weightVariable.entityId*	string
weightVariable.variableId*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
subsetFilters*	array
subsetFilters[]	object	Additional properties: Yes Discriminator: type Inherits: object
subsetFilters[].entityId*	string
subsetFilters[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
inputVariable*	object	Inherits: object
inputVariable.entityId*	string
inputVariable.variableId*	string
outputUnits*	string

Enum:

intersect
union
minus

Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
key*	string
operation*	string	Enum: intersect union minus Inherits: string
leftStepKey	string
leftVariable	object	Inherits: object
leftVariable.entityId*	string
leftVariable.variableId*	string
leftVariableTrueValues	array
leftVariableTrueValues[]	string
rightStepKey	string
rightVariable	object	Inherits: object
rightVariable.entityId*	string
rightVariable.variableId*	string
rightVariableTrueValues	array
rightVariableTrueValues[]	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
rootStepKey*	string
steps*	array
steps[]	object	Additional properties: Yes Inherits: object
steps[].key*	string
steps[].operation*	string	Enum: intersect union minus Inherits: string
steps[].leftStepKey	string
steps[].leftVariable	object	Inherits: object
steps[].leftVariable.entityId*	string
steps[].leftVariable.variableId*	string
steps[].leftVariableTrueValues	array
steps[].leftVariableTrueValues[]	string
steps[].rightStepKey	string
steps[].rightVariable	object	Inherits: object
steps[].rightVariable.entityId*	string
steps[].rightVariable.variableId*	string
steps[].rightVariableTrueValues	array
steps[].rightVariableTrueValues[]	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
name*	string
variable*	object	Inherits: object
variable.entityId*	string
variable.variableId*	string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
ecmaScriptExpression*	string
nullResultOnAnyMissingInput*	boolean
inputVariables*	array
inputVariables[]	object	Additional properties: Yes Inherits: object
inputVariables[].name*	string
inputVariables[].variable*	object	Inherits: object
inputVariables[].variable.entityId*	string
inputVariables[].variable.variableId*	string
expectedType*	string	Enum: category string number date longitude integer Inherits: string
expectedShape*	string	Enum: continuous categorical ordinal binary Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
relatedObservationsSubset*	array
relatedObservationsSubset[]	object	Additional properties: Yes Discriminator: type Inherits: object
relatedObservationsSubset[].entityId*	string
relatedObservationsSubset[].type*	string	Enum: stringSet numberSet dateSet numberRange dateRange longitudeRange multiFilter Inherits: lib.API_FilterType
anchorVariable*	object	Inherits: object
anchorVariable.entityId*	string
anchorVariable.variableId*	string
anchorVariableTrueValues*	array
anchorVariableTrueValues[]	string
anchorTimestampVariable*	object	Inherits: object
anchorTimestampVariable.entityId*	string
anchorTimestampVariable.variableId*	string
targetVariable*	object	Inherits: object
targetVariable.entityId*	string
targetVariable.variableId*	string
targetVariableTrueValues*	array
targetVariableTrueValues[]	string
targetTimestampVariable*	object	Inherits: object
targetTimestampVariable.entityId*	string
targetTimestampVariable.variableId*	string
minimumTimeIntervalDays*	integer

Inherits: object

Model

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean

Inherits: object

Model

Parameter	Type	Description
ownerId*	integer	Format: int64
ownerName*	string
ownerOrganization*	string
analysisId*	string
analysisName*	string
creationTime*	string
modificationTime*	string
isPublic*	boolean

Inherits: object

Model

Parameter	Type	Description
isDeleted*	boolean
modificationTime	string
isPublic	boolean

Inherits: object

Model

Parameter	Type	Description
onImport*	object	Inherits: object
onImport.ownerId*	integer	Format: int64
onImport.ownerName*	string
onImport.ownerOrganization*	string
onImport.analysisId*	string
onImport.analysisName*	string
onImport.creationTime*	string
onImport.modificationTime*	string
onImport.isPublic*	boolean
current*	object	Inherits: object
current.isDeleted*	boolean
current.modificationTime	string
current.isPublic	boolean

Inherits: lib.AnalysisBase

Model

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
analysisId*	string
creationTime*	string
modificationTime*	string
numFilters*	integer
numComputations*	integer
numVisualizations*	integer
provenance	object	Inherits: object
provenance.onImport*	object	Inherits: object
provenance.onImport.ownerId*	integer	Format: int64
provenance.onImport.ownerName*	string
provenance.onImport.ownerOrganization*	string
provenance.onImport.analysisId*	string
provenance.onImport.analysisName*	string
provenance.onImport.creationTime*	string
provenance.onImport.modificationTime*	string
provenance.onImport.isPublic*	boolean
provenance.current*	object	Inherits: object
provenance.current.isDeleted*	boolean
provenance.current.modificationTime	string
provenance.current.isPublic	boolean

Inherits: lib.AnalysisSummary

Model

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
analysisId*	string
creationTime*	string
modificationTime*	string
numFilters*	integer
numComputations*	integer
numVisualizations*	integer
provenance	object	Inherits: object
provenance.onImport*	object	Inherits: object
provenance.onImport.ownerId*	integer	Format: int64
provenance.onImport.ownerName*	string
provenance.onImport.ownerOrganization*	string
provenance.onImport.analysisId*	string
provenance.onImport.analysisName*	string
provenance.onImport.creationTime*	string
provenance.onImport.modificationTime*	string
provenance.onImport.isPublic*	boolean
provenance.current*	object	Inherits: object
provenance.current.isDeleted*	boolean
provenance.current.modificationTime	string
provenance.current.isPublic	boolean
userId*	number
userName*	string
userOrganization*	string

Inherits: lib.AnalysisBase

Model

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
notes	string
descriptor*	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string

Inherits: object

Model

Parameter	Type	Description
analysisId*	string

Inherits: object

Model

Parameter	Type	Description
analysisIdsToDelete	array
analysisIdsToDelete[]	string
inheritOwnershipFrom	integer	Format: int64

Inherits: lib.AnalysisSummary

Model

Parameter	Type	Description
displayName*	string
description*	string
studyId*	string
studyVersion*	string
apiVersion*	string
isPublic*	boolean
analysisId*	string
creationTime*	string
modificationTime*	string
numFilters*	integer
numComputations*	integer
numVisualizations*	integer
provenance	object	Inherits: object
provenance.onImport*	object	Inherits: object
provenance.onImport.ownerId*	integer	Format: int64
provenance.onImport.ownerName*	string
provenance.onImport.ownerOrganization*	string
provenance.onImport.analysisId*	string
provenance.onImport.analysisName*	string
provenance.onImport.creationTime*	string
provenance.onImport.modificationTime*	string
provenance.onImport.isPublic*	boolean
provenance.current*	object	Inherits: object
provenance.current.isDeleted*	boolean
provenance.current.modificationTime	string
provenance.current.isPublic	boolean
notes	string
descriptor*	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string

Inherits: object

Model

Parameter	Type	Description
displayName	string
description	string
notes	string
descriptor	object	Inherits: lib.AnalysisDescriptor
descriptor.subset*	object	Additional properties: Yes
descriptor.subset.descriptor*	array
descriptor.subset.descriptor[]	object
descriptor.subset.uiSettings	object
descriptor.computations*	array
descriptor.computations[]	object	Inherits: lib.Computation
descriptor.computations[].computationId*	string
descriptor.computations[].displayName*	string
descriptor.computations[].descriptor*	object
descriptor.computations[].visualizations*	array
descriptor.computations[].visualizations[]	object	Inherits: lib.Visualization
descriptor.computations[].visualizations[].visualizationId*	string
descriptor.computations[].visualizations[].displayName*	string
descriptor.computations[].visualizations[].descriptor*	object
descriptor.starredVariables*	array
descriptor.starredVariables[]	object	Inherits: object
descriptor.starredVariables[].entityId*	string
descriptor.starredVariables[].variableId*	string
descriptor.dataTableConfig*	object	Additional properties: Yes Inherits: lib.DataTableConfigSet
descriptor.dataTableConfig.//*	object	Inherits: lib.DataTableConfig
descriptor.dataTableConfig.//.variables*	array
descriptor.dataTableConfig.//.variables[]	object	Inherits: object
descriptor.dataTableConfig.//.variables[].entityId*	string
descriptor.dataTableConfig.//.variables[].variableId*	string
descriptor.dataTableConfig.//.sorting*	array
descriptor.dataTableConfig.//.sorting[]	object	Inherits: object
descriptor.dataTableConfig.//.sorting[].key*	string
descriptor.dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
descriptor.derivedVariables*	array
descriptor.derivedVariables[]	string
isPublic	boolean

Inherits: object

Model

Parameter	Type	Description
variables*	array
variables[]	object	Inherits: object
variables[].entityId*	string
variables[].variableId*	string
sorting*	array
sorting[]	object	Inherits: object
sorting[].key*	string
sorting[].direction*	string	Enum: asc desc Inherits: string

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
//*	object	Inherits: object
//.variables*	array
//.variables[]	object	Inherits: object
//.variables[].entityId*	string
//.variables[].variableId*	string
//.sorting*	array
//.sorting[]	object	Inherits: object
//.sorting[].key*	string
//.sorting[].direction*	string	Enum: asc desc Inherits: string

Inherits: object

Model

Parameter	Type	Description
subset*	object	Additional properties: Yes
subset.descriptor*	array
subset.descriptor[]	object
subset.uiSettings	object
computations*	array
computations[]	object	Inherits: lib.Computation
computations[].computationId*	string
computations[].displayName*	string
computations[].descriptor*	object
computations[].visualizations*	array
computations[].visualizations[]	object	Inherits: lib.Visualization
computations[].visualizations[].visualizationId*	string
computations[].visualizations[].displayName*	string
computations[].visualizations[].descriptor*	object
starredVariables*	array
starredVariables[]	object	Inherits: object
starredVariables[].entityId*	string
starredVariables[].variableId*	string
dataTableConfig*	object	Additional properties: Yes Inherits: object
dataTableConfig.//*	object	Inherits: object
dataTableConfig.//.variables*	array
dataTableConfig.//.variables[]	object	Inherits: object
dataTableConfig.//.variables[].entityId*	string
dataTableConfig.//.variables[].variableId*	string
dataTableConfig.//.sorting*	array
dataTableConfig.//.sorting[]	object	Inherits: object
dataTableConfig.//.sorting[].key*	string
dataTableConfig.//.sorting[].direction*	string	Enum: asc desc Inherits: string
derivedVariables*	array
derivedVariables[]	string

Inherits: object

Model

Parameter	Type	Description
computationId*	string
displayName*	string
descriptor*	object
visualizations*	array
visualizations[]	object	Inherits: lib.Visualization
visualizations[].visualizationId*	string
visualizations[].displayName*	string
visualizations[].descriptor*	object

Inherits: object

Model

Parameter	Type	Description
visualizationId*	string
displayName*	string
descriptor*	object

Inherits: object

Model

Parameter	Type	Description
studyId*	string

Inherits: object

Model

Parameter	Type	Description
startDate*	date-only
endDate*	date-only
createdOrModifiedCounts*	object	Inherits: lib.UserAnalysisCounts
createdOrModifiedCounts.analysesCount*	integer
createdOrModifiedCounts.importedAnalysesCount*	integer
createdOrModifiedCounts.analysesPerStudy*	array
createdOrModifiedCounts.analysesPerStudy[]	object	Inherits: lib.StudyCount
createdOrModifiedCounts.analysesPerStudy[].studyId*	string
createdOrModifiedCounts.analysesPerStudy[].count*	integer
createdOrModifiedCounts.importedAnalysesPerStudy*	array
createdOrModifiedCounts.importedAnalysesPerStudy[]	object	Inherits: lib.StudyCount
createdOrModifiedCounts.importedAnalysesPerStudy[].studyId*	string
createdOrModifiedCounts.importedAnalysesPerStudy[].count*	integer
createdOrModifiedCounts.registeredUsersCount*	integer
createdOrModifiedCounts.guestUsersCount*	integer
createdOrModifiedCounts.registeredAnalysesCount*	integer
createdOrModifiedCounts.guestAnalysesCount*	integer
createdOrModifiedCounts.registeredFiltersCount*	integer
createdOrModifiedCounts.guestFiltersCount*	integer
createdOrModifiedCounts.registeredVisualizationsCount*	integer
createdOrModifiedCounts.guestVisualizationsCount*	integer
createdOrModifiedCounts.registeredUsersAnalysesCounts*	array
createdOrModifiedCounts.registeredUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersAnalysesCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersAnalysesCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersAnalysesCounts*	array
createdOrModifiedCounts.guestUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersAnalysesCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersAnalysesCounts[].usersCount*	integer
createdOrModifiedCounts.registeredUsersFiltersCounts*	array
createdOrModifiedCounts.registeredUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersFiltersCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersFiltersCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersFiltersCounts*	array
createdOrModifiedCounts.guestUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersFiltersCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersFiltersCounts[].usersCount*	integer
createdOrModifiedCounts.registeredUsersVisualizationsCounts*	array
createdOrModifiedCounts.registeredUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.registeredUsersVisualizationsCounts[].objectsCount*	integer
createdOrModifiedCounts.registeredUsersVisualizationsCounts[].usersCount*	integer
createdOrModifiedCounts.guestUsersVisualizationsCounts*	array
createdOrModifiedCounts.guestUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
createdOrModifiedCounts.guestUsersVisualizationsCounts[].objectsCount*	integer
createdOrModifiedCounts.guestUsersVisualizationsCounts[].usersCount*	integer

Inherits: object

Model

Parameter	Type	Description
analysesCount*	integer
importedAnalysesCount*	integer
analysesPerStudy*	array
analysesPerStudy[]	object	Inherits: lib.StudyCount
analysesPerStudy[].studyId*	string
analysesPerStudy[].count*	integer
importedAnalysesPerStudy*	array
importedAnalysesPerStudy[]	object	Inherits: lib.StudyCount
importedAnalysesPerStudy[].studyId*	string
importedAnalysesPerStudy[].count*	integer
registeredUsersCount*	integer
guestUsersCount*	integer
registeredAnalysesCount*	integer
guestAnalysesCount*	integer
registeredFiltersCount*	integer
guestFiltersCount*	integer
registeredVisualizationsCount*	integer
guestVisualizationsCount*	integer
registeredUsersAnalysesCounts*	array
registeredUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
registeredUsersAnalysesCounts[].objectsCount*	integer
registeredUsersAnalysesCounts[].usersCount*	integer
guestUsersAnalysesCounts*	array
guestUsersAnalysesCounts[]	object	Inherits: lib.UsersObjectsCount
guestUsersAnalysesCounts[].objectsCount*	integer
guestUsersAnalysesCounts[].usersCount*	integer
registeredUsersFiltersCounts*	array
registeredUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
registeredUsersFiltersCounts[].objectsCount*	integer
registeredUsersFiltersCounts[].usersCount*	integer
guestUsersFiltersCounts*	array
guestUsersFiltersCounts[]	object	Inherits: lib.UsersObjectsCount
guestUsersFiltersCounts[].objectsCount*	integer
guestUsersFiltersCounts[].usersCount*	integer
registeredUsersVisualizationsCounts*	array
registeredUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
registeredUsersVisualizationsCounts[].objectsCount*	integer
registeredUsersVisualizationsCounts[].usersCount*	integer
guestUsersVisualizationsCounts*	array
guestUsersVisualizationsCounts[]	object	Inherits: lib.UsersObjectsCount
guestUsersVisualizationsCounts[].objectsCount*	integer
guestUsersVisualizationsCounts[].usersCount*	integer

Inherits: object

Model

Parameter	Type	Description
studyId*	string
count*	integer

Inherits: object

Model

Parameter	Type	Description
objectsCount*	integer
usersCount*	integer

Inherits: object

Model

Parameter	Type	Description
count*	integer

Inherits: object

Model

Parameter	Type	Description
datasetId*	string
entityId*	string
displayName*	string	Min. length: 1 Max. length: 256
functionName*	string
config*	object
description	string	Max. length: 4000

Inherits: lib.VariableSpec

Model

Parameter	Type	Description
entityId*	string
variableId*	string

Inherits: lib.DerivedVariableSpec

Model

Parameter	Type	Description
entityId*	string
variableId*	string
functionName*	string
displayName*	string
config*	object	Additional properties: Yes
datasetId*	string
description	string	Max. length: 4000
provenance	object	Inherits: lib.DerivedVariableProvenance
provenance.copyDate*	datetime-only
provenance.copiedFrom*	string

Inherits: object

Model

Parameter

Type

Description

displayName

string

Min. length: 1

Max. length: 256

description

string

Max. length: 4000

Inherits: object

Model

Parameter	Type	Description
copyDate*	datetime-only
copiedFrom*	string

Discriminator: 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

Enum:

bad-request
unauthorized
forbidden
not-found
bad-method
invalid-input
server-error

Inherits: string

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: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unauthenticated 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

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

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": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

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": "not-found",
  "message": "the requested resource could not be found"
}

The HTTP method used to request a resource is not allowed or configured by the server.

Discriminator: status

Discriminator value: bad-method

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-method",
  "message": "PUT requests are not permitted on this endpoint"
}

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

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
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Examples

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

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
requestId*	string

Examples

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Health details about the service

Inherits: object

Model

Parameter	Type	Description
status*	string	Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum: healthy unhealthy
dependencies*	array	A list of external services that this service depends on and some details about them.
dependencies[]	object	Inherits: DependencyStatus
dependencies[].name*	string	Name of the external depdendency.
dependencies[].reachable*	boolean	Whether or not the external service is reachable.
dependencies[].online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no
info*	object	Additional properties: Yes
info.threads*	integer	Min. value: 1
info.uptime*	string
info.uptimeMillis*	integer	Min. value: 1 Format: int64

Inherits: object

Model

Parameter	Type	Description
name*	string	Name of the external depdendency.
reachable*	boolean	Whether or not the external service is reachable.
online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no

EDA Workspace Data Service API vv1.0.0

200 OK chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Request Body chevron_right expand_more

204 No Content chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

200 OK chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

400 Bad Request chevron_right expand_more

Response Body

422 Unprocessable Entity chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Secured By chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

400 Bad Request chevron_right expand_more

Response Body

422 Unprocessable Entity chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

Parameters chevron_right expand_more

Request Body chevron_right expand_more

200 OK chevron_right expand_more

200 OK

200 OK

Parameters

200 OK

Parameters

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Parameters

Secured By

Request Body

200 OK

Request Body

204 No Content

Request Body

200 OK

200 OK

Secured By

Request Body

200 OK

400 Bad Request

422 Unprocessable Entity

500 Internal Server Error

Request Body

200 OK

Secured By

Request Body

200 OK

400 Bad Request

422 Unprocessable Entity

500 Internal Server Error

200 OK

Parameters

Request Body

200 OK

Parameters

Request Body

200 OK

Parameters

Request Body

200 OK