Data_GetAllowedValues (Get)
- Last UpdatedNov 13, 2025
- 5 minute read
| Get | Data_GetAllowedValues |
Resource Path:/api/v1/data/GetAllowedValues
Gets the allowed values for the specified fields based on the specified reporting point location.
| Name | Description | Data Type |
|---|---|---|
| module | The module that corresponds to the request. | string |
| location | The reporting point location that maps to the application folder location. | string |
| fields | A comma-separated list of field names for the allowed values. | string |
| locationIdentifier | The unique identifier of the reporting point from the external system. | string |
The response body is of type Array[AllowedValue].
Request
GET 'https://localhost:9003/api/v1/data/GetAllowedValues/?Module=Downtime&Location=ACME.Rocky%20Mine.Train%20Loadout.Downtime'Response
[
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Services.Substations.SU721 - Train Loadout"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Services.MCCs.MC721 - Train Loadout"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Services.Switchboards.SD721 - Train Loadout"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Services.Transformers.TF721 - Train Loadout 11kV-433V"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Bins.BN701 - TLO Bin.Bin"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Bins.BN701 - TLO Bin.Level Sensor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Bins.BN701 - TLO Bin.Weighflask"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Bins.BN701 - TLO Bin.Hydraulic Power Unit"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT701 - TLO Surge Bin Gates.Gate"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT701 - TLO Surge Bin Gates.Proximity Switch"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT701 - TLO Surge Bin Gates.Hydraulic Power Unit"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT702 - TLO Flask Gates.Gate"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT702 - TLO Flask Gates.Proximity Switch"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Gates.GT702 - TLO Flask Gates.Hydraulic Power Unit"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV741.Magnet"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV741.Gravity Takeup"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV741.Belt"
},
,
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Scrapers Skirts"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Pullwire"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Underspeed Sensor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Belt Rip Sensor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Drift Switch"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Variable Speed Drive"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV742.Chute"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Gravity Takeup"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Belt"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Pulley"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Conveyors.CV701.Roller"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Pulley"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Chute"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Variable Speed Drive"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Chain Conveyor.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Long Travel.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Long Travel.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Long Travel.Encoder"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Long Travel.Brake"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Cable Reeler.Cable Reeler"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Cable Reeler.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Cable Reeler.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Lubrication System.Pump"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Lubrication System.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Lubrication System.Lubrication"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Rail Clamp"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Reclaimers.RE741 - Product Coal Reclaimer.Harrows"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.SA701 - Primary Coal Reclaim Sampler.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.SA704 - Quartenary Coal Reclaim Sampler.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.SA704 - Quartenary Coal Reclaim Sampler.Sampler Cutter"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Belt"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Pulley"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Roller"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Idler Frame"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Pullwire"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Underspeed Sensor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Drift Switch"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE701 - Primary Sampler Feeder.Chute"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Belt"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Pulley"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Roller"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Idler Frame"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Pullwire"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Underspeed Sensor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Drift Switch"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE702 - Secondary Sampler Feeder.Chute"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE703 - Tertiary Sampler Feeder.Motor"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE703 - Tertiary Sampler Feeder.Gearbox"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.FE703 - Tertiary Sampler Feeder.Electrical General"
},
{
"Field": "Cause Location",
"Value": "ACME.Rocky Mine.Train Loadout.Sampler.CR701 - Product Coal Sampler Crusher.Chute"
},
{
"Field": "Capture Location",
"Value": "Module1"
},
{
"Field": "Capture Location",
"Value": "Module2"
},
{
"Field": "Capture Location",
"Value": "Processing Plant"
},
{
"Field": "Capture Location",
"Value": "ROM"
},
{
"Field": "Capture Location",
"Value": "Train Load Out"
},
{
"Field": "Shift",
"Value": "Day"
},
{
"Field": "Shift",
"Value": "Night"
},
{
"Field": "Crew",
"Value": "A"
},
{
"Field": "Crew",
"Value": "B"
},
{
"Field": "Crew",
"Value": "C"
},
{
"Field": "Crew",
"Value": "D"
},
{
"Field": "Record Type",
"Value": "Real Downtime"
},
{
"Field": "Record Type",
"Value": "Slow Running"
}
]If no fields are specified in the request, the response includes the available allowed values of the fields based on the specified reporting point.
You can use this method to retrieve the allowed values for the CauseLocation field just like in the given example.