getResourceStatisticsConfig

Get the statistics configuration for a resource.

Also see getDataSourceStatisticsConfig .

Multiple resources are returned if a path has multiple resources that differ by type—for example, /shared/examples/ds_inventory (data source) and /shared/examples/ds_inventory (view).

Location

/services/webservices/system/admin/resource/operations/

Request Elements

path: The path of the resource.

type: The type of the resource. May only be a relational physical TABLE.

Response Elements

statisticsConfig: The statistics gathering configuration of the given resource.

cardinalityMin (optional): Minimum cardinality for this resource. Setting this value overrides gathered statistics.
cardinalityMax (optional): Maximum cardinality for this resource. Setting this value overrides gathered statistics.
cardinalityExpected (optional): Expected cardinality for this resource. Setting this value overrides gathered statistics.
gatherEnabled (optional): Defines what statistics should be gathered for this resource. Valid values are DEFAULT, CUSTOM, DISABLED or TABLE_BOUNDARY.
maxTime (optional): Number of minutes after which each thread performing statistics gathering gives up: 0 means no timeout; -1 means use data source setting.
columns (optional): Only applicable if gatherEnabled is set to CUSTOM.
column: List indicating what specific data to get for each column.
name: Simple column name.
flags: Valid values are NONE, BOUNDARY or ALL.

Faults

IllegalArgument: If the path is malformed or an illegal type is provided.

NotAllowed: If the resource if of the wrong type.

NotFound: If the resource or any portion of the path to the resource does not exist.

Security: If the user does not have READ access on all items in path.

Security: If the user does not have the ACCESS_TOOLS right.