Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA Production Management Web API Reference

TABLE OF CONTENTS

Data_GetView (Get)

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL

GetData_GetView

Resource Path:/api/v1/data/view

Description

Gets the detailed information of a specific view.

Parameters

NameDescriptionData Type
nameRequired. The name of the view.string
moduleRequired. This maps to one of the standard application modules.string
locationThe reporting point location that maps to the application folder location.string
locationIdentifierThe unique identifier of the reporting point from an external system.string

200 Response

The response body is of type View.

Example

Request


GET 'https://localhost:9003/api/v1/data/view?Name=Inventory.InboundMaterialFlowView&Module=Inventory&Location=Talison.Site%201%20with%20recurse'

Response


{
  "Name": "Inventory.InboundMaterialFlowView",
  "FieldsDisplayNameByName": {
    "MovementId": "Movement Id",
    "SampleDateTime": "Sample Period",
    "ObjectId": "Location",
    "MovementLocation": "Movement Location",
    "Material": "Material",
    "MaterialClass": "Material Class",
    "MaterialClassIdentifier": "Material Class Identifier",
    "MaterialIdentifier": "Material Identifier",
    "Lot": "Lot",
    "LotGroup": "Lot Group",
    "SourceLot": "Source Lot",
    "SourceLotGroup": "Source Lot Group",
    "SourceEquipment": "Source Equipment",
    "LocationIdentifier": "Location Identifier",
    "SourceMaterial": "Source Material",
    "SourceMaterialClass": "Source Material Class",
    "SourceMaterialClassIdentifier": "Source Material Class Identifier",
    "SourceMaterialIdentifier": "Source Material Identifier",
    "Quantity": "Quantity",
    "Units": "Units",
    "MovementType": "Movement Type",
    "MovementDirection": "Movement Direction",
    "SampleIdentifier": "Sample Identifier",
    "AdjustmentType": "Adjustment Type",
    "ActivityId": "ActivityId",
    "QualityLocation": "Quality Location",
    "QualityRecordIdentifier": "Quality Record Identifier",
    "RecordIdentifier": "Record Identifier",
    "OperationsDefinitionIdentifier": "Operations Definition Identifier",
    "OperationsSegmentIdentifier": "Operations Segment Identifier",
    "Moisture": "Moisture",
    "Dry Tonnes": "Dry Tonnes",
    "Accuracy": "Accuracy",
    "Balancing Comments": "Balancing Comments",
    "Bench": "Bench",
    "Blast Pattern ID": "Blast Pattern ID",
    "Excav": "Excav",
    "Id": "Id",
    "IsReconciled": "IsReconciled",
    "Li2O": "Li2O",
    "Li2O Tonnes": "Li2O Tonnes",
    "Ore Type": "Ore Type",
    "Primary Quantity": "Primary Quantity",
    "Secondary Quantity": "Secondary Quantity",
    "Shift": "Shift",
    "Site of Origin": "Site of Origin",
    "Status": "Status",
    "Truck ID": "Truck ID",
    "K2O": "K2O",
    "K2O Tonnes": "K2O Tonnes",
    "Fe2O3": "Fe2O3",
    "Fe2O3 Tonnes": "Fe2O3 Tonnes",
    "Na2O": "Na2O",
    "Na2O Tonnes": "Na2O Tonnes",
    "P2O5": "P2O5",
    "P2O5 Tonnes": "P2O5 Tonnes",
    "Ta2O5": "Ta2O5",
    "Ta2O5 Grams": "Ta2O5 Grams",
    "Sb2O3": "Sb2O3",
    "Sb2O3 Tonnes": "Sb2O3 Tonnes",
    "Sn": "Sn",
    "Sn Kg": "Sn Kg",
    "Date Prepped": "Date Prepped",
    "Original Quantity": "Original Quantity",
    "Date Drilled": "Date Drilled",
    "Date Blasted": "Date Blasted",
    "Date Created": "Date Created"
  },
  "FieldsNameByDisplayName": {
    "Movement Id": "MovementId",
    "Sample Period": "SampleDateTime",
    "Location": "ObjectId",
    "Movement Location": "MovementLocation",
    "Material": "Material",
    "Material Class": "MaterialClass",
    "Material Class Identifier": "MaterialClassIdentifier",
    "Material Identifier": "MaterialIdentifier",
    "Lot": "Lot",
    "Lot Group": "LotGroup",
    "Source Lot": "SourceLot",
    "Source Lot Group": "SourceLotGroup",
    "Source Equipment": "SourceEquipment",
    "Location Identifier": "LocationIdentifier",
    "Source Material": "SourceMaterial",
    "Source Material Class": "SourceMaterialClass",
    "Source Material Class Identifier": "SourceMaterialClassIdentifier",
    "Source Material Identifier": "SourceMaterialIdentifier",
    "Quantity": "Quantity",
    "Units": "Units",
    "Movement Type": "MovementType",
    "Movement Direction": "MovementDirection",
    "Sample Identifier": "SampleIdentifier",
    "Adjustment Type": "AdjustmentType",
    "ActivityId": "ActivityId",
    "Quality Location": "QualityLocation",
    "Quality Record Identifier": "QualityRecordIdentifier",
    "Record Identifier": "RecordIdentifier",
    "Operations Definition Identifier": "OperationsDefinitionIdentifier",
    "Operations Segment Identifier": "OperationsSegmentIdentifier",
    "Moisture": "Moisture",
    "Dry Tonnes": "Dry Tonnes",
    "Accuracy": "Accuracy",
    "Balancing Comments": "Balancing Comments",
    "Bench": "Bench",
    "Blast Pattern ID": "Blast Pattern ID",
    "Excav": "Excav",
    "Id": "Id",
    "IsReconciled": "IsReconciled",
    "Li2O": "Li2O",
    "Li2O Tonnes": "Li2O Tonnes",
    "Ore Type": "Ore Type",
    "Primary Quantity": "Primary Quantity",
    "Secondary Quantity": "Secondary Quantity",
    "Shift": "Shift",
    "Site of Origin": "Site of Origin",
    "Status": "Status",
    "Truck ID": "Truck ID",
    "K2O": "K2O",
    "K2O Tonnes": "K2O Tonnes",
    "Fe2O3": "Fe2O3",
    "Fe2O3 Tonnes": "Fe2O3 Tonnes",
    "Na2O": "Na2O",
    "Na2O Tonnes": "Na2O Tonnes",
    "P2O5": "P2O5",
    "P2O5 Tonnes": "P2O5 Tonnes",
    "Ta2O5": "Ta2O5",
    "Ta2O5 Grams": "Ta2O5 Grams",
    "Sb2O3": "Sb2O3",
    "Sb2O3 Tonnes": "Sb2O3 Tonnes",
    "Sn": "Sn",
    "Sn Kg": "Sn Kg",
    "Date Prepped": "Date Prepped",
    "Original Quantity": "Original Quantity",
    "Date Drilled": "Date Drilled",
    "Date Blasted": "Date Blasted",
    "Date Created": "Date Created"
  },
  "FieldsTypeByDisplayName": {
    "Movement Id": "xs:Int",
    "Sample Period": "xs:DateTime",
    "Location": "xs:String",
    "Movement Location": "xs:String",
    "Material": "xs:String",
    "Material Class": "xs:String",
    "Material Class Identifier": "xs:String",
    "Material Identifier": "xs:String",
    "Lot": "xs:String",
    "Lot Group": "xs:String",
    "Source Lot": "xs:String",
    "Source Lot Group": "xs:String",
    "Source Equipment": "xs:String",
    "Location Identifier": "xs:String",
    "Source Material": "xs:String",
    "Source Material Class": "xs:String",
    "Source Material Class Identifier": "xs:String",
    "Source Material Identifier": "xs:String",
    "Quantity": "xs:Decimal",
    "Units": "xs:String",
    "Movement Type": "xs:String",
    "Movement Direction": "xs:String",
    "Sample Identifier": "xs:String",
    "Adjustment Type": "xs:String",
    "ActivityId": "xs:String",
    "Quality Location": "xs:String",
    "Quality Record Identifier": "xs:String",
    "Record Identifier": "xs:String",
    "Operations Definition Identifier": "xs:String",
    "Operations Segment Identifier": "xs:String",
    "Moisture": "xs:Decimal",
    "Dry Tonnes": "xs:Decimal",
    "Accuracy": "xs:float",
    "Balancing Comments": "xs:String",
    "Bench": "xs:String",
    "Blast Pattern ID": "xs:String",
    "Excav": "xs:String",
    "Id": "xs:Int",
    "IsReconciled": "xs:Boolean",
    "Li2O": "xs:Decimal",
    "Li2O Tonnes": "xs:Decimal",
    "Ore Type": "xs:String",
    "Primary Quantity": "xs:Double",
    "Secondary Quantity": "xs:Double",
    "Shift": "xs:String",
    "Site of Origin": "xs:String",
    "Status": "xs:String",
    "Truck ID": "xs:String",
    "K2O": "xs:Decimal",
    "K2O Tonnes": "xs:Decimal",
    "Fe2O3": "xs:Decimal",
    "Fe2O3 Tonnes": "xs:Decimal",
    "Na2O": "xs:Decimal",
    "Na2O Tonnes": "xs:Decimal",
    "P2O5": "xs:Decimal",
    "P2O5 Tonnes": "xs:Decimal",
    "Ta2O5": "xs:Decimal",
    "Ta2O5 Grams": "xs:Decimal",
    "Sb2O3": "xs:Decimal",
    "Sb2O3 Tonnes": "xs:Decimal",
    "Sn": "xs:Decimal",
    "Sn Kg": "xs:Decimal",
    "Date Prepped": "xs:DateTime",
    "Original Quantity": "xs:Double",
    "Date Drilled": "xs:DateTime",
    "Date Blasted": "xs:DateTime",
    "Date Created": "xs:DateTime"
  },
  "Filters": {
    "SampleDateTime": "Sample Period",
    "ObjectId": "Location",
    "MovementLocation": "Movement Location",
    "Material": "Material",
    "MaterialClass": "Material Class",
    "MaterialClassIdentifier": "Material Class Identifier",
    "MaterialIdentifier": "Material Identifier",
    "Lot": "Lot",
    "LotGroup": "Lot Group",
    "SourceLot": "Source Lot",
    "SourceLotGroup": "Source Lot Group",
    "SourceEquipment": "Source Equipment",
    "LocationIdentifier": "Location Identifier",
    "SourceMaterial": "Source Material",
    "SourceMaterialClass": "Source Material Class",
    "SourceMaterialClassIdentifier": "Source Material Class Identifier",
    "SourceMaterialIdentifier": "Source Material Identifier",
    "Quantity": "Quantity",
    "MovementType": "Movement Type",
    "MovementDirection": "Movement Direction",
    "SampleIdentifier": "Sample Identifier",
    "AdjustmentType": "Adjustment Type",
    "ActivityId": "ActivityId",
    "QualityLocation": "Quality Location",
    "QualityRecordIdentifier": "Quality Record Identifier",
    "RecordIdentifier": "Record Identifier",
    "OperationsDefinitionIdentifier": "Operations Definition Identifier",
    "OperationsSegmentIdentifier": "Operations Segment Identifier",
    "Moisture": "Moisture",
    "Bench": "Bench",
    "Blast_x0020_Pattern_x0020_ID": "Blast Pattern ID",
    "Excav": "Excav",
    "Id": "Id",
    "IsReconciled": "IsReconciled",
    "Li2O": "Li2O",
    "Ore_x0020_Type": "Ore Type",
    "Shift": "Shift",
    "Site_x0020_of_x0020_Origin": "Site of Origin",
    "Status": "Status",
    "K2O": "K2O",
    "Fe2O3": "Fe2O3",
    "Na2O": "Na2O",
    "P2O5": "P2O5",
    "Ta2O5": "Ta2O5",
    "Sb2O3": "Sb2O3",
    "Sn": "Sn",
    "Date_x0020_Prepped": "Date Prepped",
    "Date_x0020_Drilled": "Date Drilled",
    "Date_x0020_Blasted": "Date Blasted",
    "Date_x0020_Created": "Date Created"
  }
}

See Also

All Operations Resource Group | AVEVA Production Management Web API Reference

In This Topic
TitleResults for “How to create a CRG?”Also Available in