Data_GetRecords (Get)

Save PDF

Last UpdatedNov 13, 2025
4 minute read

Get Data_GetRecords

Resource Path:/api/v1/data

Parameters

Name	Description	Data Type
module	Required. The module that maps to one of the standard application modules. This can be Downtime, Production, or Inventory.	string
location	Required. The reporting point location that maps to the application folder location.	string
view	The view name of a module that maps to its standard view by default if no explicit value is provided, or in the case of the Metrics module, it maps to the analysis view. For example: Downtime.StandardView or Inventory.BalanceByLot This default behavior applies to most of the standard queries. If a value is provided, it overrides the default behavior. For more information. See the Remarks section.	string
deleted	A boolean-result flag. When this value is set to True, the deleted fields are included in the results.	boolean
locationIdentifier	The unique identifier used to recognize a reporting point or equipment from an external system.	string
samplePeriod	The period of time to use in the query. This can be any filterable period definition or date time.	datetime
language	The Windows regional setting that determines the language of the displayed data in the client machine. This can be any regional setting value. For example, en-AU, en-GB.	string
resolveIdentifiers	A boolean-result flag that enables the request to resolve the identifier fields like Cause and Classification to return the corresponding text values.	boolean
fields	A comma-separated list of field names.	string
modelFields	A comma-separated list of model field names that specify which model item property is returned.	string
filterCriteria	The key-value pairs for filtering returned data.	string

Example

Request | Production


GET 'https://localhost:9003/api/v1/data/?module=Production&Location=ACME.Rocky%20Mine.Mining.ROM'

Response


[
  {
    "Id": 5184,
    "Module": "Production",
    "IsManual": false,
    "HasAudit": false,
    "CreatedBy": "Administrator",
    "CreatedDateTime": "2019-12-22T00:50:41Z",
    "ConfirmedBy": null,
    "ConfirmedDateTime": null,
    "Deleted": false,
    "Confirmed": false,
    "LastModified": "2019-12-22T00:50:41Z",
    "Sample Period": "2019-12-22T00:50:00Z",
    "Duration": 600,
    "Location": "ACME.Rocky Mine.Mining.ROM.Production",
    "Equipment Id": null,
    "Location Identifier": null,
    "Comment": null,
    "Record Date Time": null,
    "Feed Rate": 3000,
    "Feed Rate Setpoint": 3000,
    "Crusher Feed Tonnes": 301,
    "Crushed Tonnes": 301,
    "Reject Tonnes": 0,
    "kWh": 45,
    "Capture Location": "ROM",
    "Shift": "Day",
    "Crewzzzz": "C"
  },
  {
    "Id": 5144,
    "Module": "Production",
    "IsManual": false,
    "HasAudit": false,
    "CreatedBy": "Administrator",
    "CreatedDateTime": "2019-12-22T00:47:33Z",
    "ConfirmedBy": null,
    "ConfirmedDateTime": null,
    "Deleted": false,
    "Confirmed": false,
    "LastModified": "2019-12-22T00:47:33Z",
    "Sample Period": "2019-12-22T00:40:00Z",
    "Duration": 600,
    "Location": "ACME.Rocky Mine.Mining.ROM.Production",
    "Equipment Id": null,
    "Location Identifier": null,
    "Comment": null,
    "Record Date Time": null,
    "Feed Rate": 2980,
    "Feed Rate Setpoint": 3000,
    "Crusher Feed Tonnes": 0,
    "Crushed Tonnes": 0,
    "Reject Tonnes": 0,
    "kWh": 0,
    "Capture Location": "ROM",
    "Shift": "Day",
    "Crewzzzz": "C"
  },
  {
    "Id": 5143,
    "Module": "Production",
    "IsManual": false,
    "HasAudit": false,
    "CreatedBy": "Administrator",
    "CreatedDateTime": "2019-12-22T00:47:33Z",
    "ConfirmedBy": null,
    "ConfirmedDateTime": null,
    "Deleted": false,
    "Confirmed": false,
    "LastModified": "2019-12-22T00:47:33Z",
    "Sample Period": "2019-12-22T00:30:00Z",
    "Duration": 600,
    "Location": "ACME.Rocky Mine.Mining.ROM.Production",
    "Equipment Id": null,
    "Location Identifier": null,
    "Comment": null,
    "Record Date Time": null,
    "Feed Rate": 2980,
    "Feed Rate Setpoint": 3000,
    "Crusher Feed Tonnes": 0,
    "Crushed Tonnes": 0,
    "Reject Tonnes": 0,
    "kWh": 0,
    "Capture Location": "ROM",
    "Shift": "Day",
    "Crewzzzz": "C"
  }
]

Request | Inventory View


GET 'https://localhost:9003/api/v1/data/?module=Inventory&Location=SiteFolder%20with%20recurse&View=Inventory.BalanceOverTimeView&Sample%20Period=Current%20Month&Fields=Location,%20Material%20Class,%20Material,%20Sample%20Period,%20Balance'

Response


[
  {
    "Id": 500127,
    "Module": "Inventory",
    "Location": "SiteFolder.Area2.WorkCenter4",
    "Material Class": "Material Class.MaterialClass1",
    "Material": "Material Model.MaterialClass1.Material2",
    "Sample Period": "2019-12-23T04:02:51Z",
    "Balance": 102.5
  },
  {
    "Id": 500126,
    "Module": "Inventory",
    "Location": "SiteFolder.Area2.WorkCenter4",
    "Material Class": "Material Class.MaterialClass1",
    "Material": "Material Model.MaterialClass1.Material1",
    "Sample Period": "2019-12-23T04:02:51Z",
    "Balance": 102.5
  },
  {
    "Id": 500125,
    "Module": "Inventory",
    "Location": "SiteFolder.Area2.WorkCenter4",
    "Material Class": "Material Class.MaterialClass1",
    "Material": "Material Model.MaterialClass1.Material2",
    "Sample Period": "2019-12-23T03:53:41.7466667Z",
    "Balance": 100
  }
]

Request | Production with specific fields


GET 'https://localhost:9003/api/v1/data/?Module=Production&Location=ACME.Rocky%20Mine.Mining.ROM&Fields=Id,%20Shift,%20Crew&Language=ru&Sample%20Period=Current%20Hour'

Response


[
  {
    "Id": 6473,
    "Module": "Production",
    "сдвиг": "Day",
    "экипаж": "C"
  },
  {
    "Id": 6469,
    "Module": "Production",
    "сдвиг": "Day",
    "экипаж": "C"
  },
  {
    "Id": 6463,
    "Module": "Production",
    "сдвиг": "Day",
    "экипаж": "C"
  },
  {
    "Id": 6462,
    "Module": "Production",
    "сдвиг": "Day",
    "экипаж": "C"
  }
]

Request | Downtime with time filters

 
GET 'https://localhost:9003/api/v1/data/?module=Downtime&Location=ACME.Rocky%20Mine.Train%20Loadout.Downtime&Start%20Time=%3C2019-12-23T22:22:31Z'

Response


[
  {
    "Id": 3220,
    "Module": "Downtime",
    "IsManual": true,
    "HasAudit": false,
    "CreatedBy": "System Configuration.Users.Administrator",
    "CreatedDateTime": "2019-12-22T00:59:18Z",
    "ConfirmedBy": null,
    "ConfirmedDateTime": null,
    "MaskedById": null,
    "ClippedPercentage": 1,
    "Deleted": false,
    "Confirmed": false,
    "Masked": false,
    "IsSplit": false,
    "Virtual": false,
    "Is Clipped": false,
    "LastModified": "2019-12-22T00:59:18Z",
    "Last Modified By": "Administrator",
    "Start Time": "2019-12-22T05:52:55Z",
    "Start Time (Clipped)": "2019-12-22T05:52:55Z",
    "End Time": null,
    "End Time (Clipped)": null,
    "Duration": 0,
    "Duration (Clipped)": 0,
    "Location": "ACME.Rocky Mine.Train Loadout.Downtime",
    "Equipment Id (Location)": null,
    "Equipment Type (Location)": "Train Load Out",
    "Eff. Duration": 0,
    "Eff. Duration (Clipped)": 0,
    "Location Identifier": null,
    "Effect": null,
    "Event": null,
    "Cause Location": "ACME.Rocky Mine.Train Loadout",
    "Cause": "100021",
    "Classification": "1006",
    "Eff. %": 1,
    "Equipment Id (Cause Location)": null,
    "Equipment Type (Cause Location)": "Train Load Out",
    "Record Date Time": null,
    "Explanation": null,
    "Comments": null,
    "Capture Location": null,
    "Shift": null,
    "Crew": null,
    "Record Type": "Real Downtime"
  },
  {
    "Id": 3221,
    "Module": "Downtime",
    "IsManual": true,
    "HasAudit": false,
    "CreatedBy": "System Configuration.Users.Administrator",
    "CreatedDateTime": "2019-12-22T00:59:18Z",
    "ConfirmedBy": null,
    "ConfirmedDateTime": null,
    "MaskedById": null,
    "ClippedPercentage": 1,
    "Deleted": false,
    "Confirmed": false,
    "Masked": false,
    "IsSplit": false,
    "Virtual": false,
    "Is Clipped": false,
    "LastModified": "2019-12-22T00:59:18Z",
    "Last Modified By": "Administrator",
    "Start Time": "2019-12-22T05:52:55Z",
    "Start Time (Clipped)": "2019-12-22T05:52:55Z",
    "End Time": null,
    "End Time (Clipped)": null,
    "Duration": 0,
    "Duration (Clipped)": 0,
    "Location": "ACME.Rocky Mine.Train Loadout.Downtime",
    "Equipment Id (Location)": null,
    "Equipment Type (Location)": "Train Load Out",
    "Eff. Duration": 0,
    "Eff. Duration (Clipped)": 0,
    "Location Identifier": null,
    "Effect": null,
    "Event": null,
    "Cause Location": "ACME.Rocky Mine.Train Loadout",
    "Cause": "100021",
    "Classification": "1006",
    "Eff. %": 1,
    "Equipment Id (Cause Location)": null,
    "Equipment Type (Cause Location)": "Train Load Out",
    "Record Date Time": null,
    "Explanation": null,
    "Comments": null,
    "Capture Location": null,
    "Shift": null,
    "Crew": null,
    "Record Type": "Real Downtime"
  }
].

Remarks

For the view parameter, specify the correct view name for the Quality type of a Quality reporting point. Here are some examples.

- StandardView
- MaterialQualityView, QualityEventsView
- CalculatedQualityByLotGroupOverTimeView, CalculatedQualityByLotGroupView

If no language is specified, the default is en-US.

To use the modelFields parameter, set the associated model property of the reporting point field to the associated model type of the linked model item.

To specify the filters, use key-value pairs. For example, Cause Value=BrokenPump filters the returned results to records with BrokenPump as the Cause value. If no filters are specified, the request returns all available data.

Use invariant display names of filter fields.

AVEVA Production Management Web API Reference