CreateReportSpecification

autorunboolean

Default: true

Whether to automatically run this Report Specification when a new version is published

bboxBBox | BBoxXYZ | null

Example: {"i_minmax":{"max":1,"min":0},"j_minmax":{"max":1,"min":0},"k_minmax":{"max":1,"min":0}}

Bounding box for the report

Any of:

One of:

BBoxobject

i_minmaxIntRange

Required

Minimum and maximum values for the i column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

j_minmaxIntRange

Required

Minimum and maximum values for the j column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

k_minmaxIntRange

Required

Minimum and maximum values for the k column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

BBoxXYZobject

x_minmaxFloatRange

Required

Minimum and maximum values for the x column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

y_minmaxFloatRange

Required

Minimum and maximum values for the y column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

z_minmaxFloatRange

Required

Minimum and maximum values for the z column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

null

categoriesarray | null

Example: [{"col_id":"11c277c2-edc6-4a7a-8380-251dd19231f2","label":"Grade","values":["low","medium","high"]}]

Category columns within this Report Specification. If null or empty, the report will have a single total row for each cut-off.

columnsobject[]

Example: [{"aggregation":"SUM","col_id":"abc277c2-edc6-4a7a-8380-251dd19231f2","label":"Au content","output_unit_id":"kg"}]

Columns within this Report Specification

aggregation"SUM" | "MASS_AVERAGE"

Examples: "SUM", "MASS_AVERAGE"

The aggregation method to use for the column

col_iduuid

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column in the block model

labelstring

Example: "Au Content"

The human-readable label used to identify the column

output_unit_idstring

Example: "kg"

ID of the unit to use for the column output

cutoff_col_idstring | null

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for cut-off evaluation

cutoff_valuesarray | null

Example: [0.5,1.5,5]

Values to use for cut-off evaluation

density_col_idstring | null

Example: "24c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for block density

density_unit_idstring | null

Example: "kg/m3"

ID of the unit to use for block density. The unit must be of type MASS_PER_VOLUME.

density_valuenumber | null

Example: 2.5

Value to use for block density

descriptionstring | null

Example: "Gold resource report for test purposes"

User-supplied description of the report

mass_unit_idstring

Example: "t"

ID of the unit to use for total mass. The unit must be of type MASS

namestring

The human-readable label used to identify the report

negative_values_policystring | null

Example: "USE"

Default: "IGNORE_BLOCK"

Policy for handling negative values in the report's cut-off or value columns

null_values_policystring | null

Example: "ZERO"

Default: "IGNORE_BLOCK"

Policy for handling null values in the report's cut-off or value columns