Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

asset_groups

Get an asset group

get/app/v1/asset_groups/{id}

Path parameters

idstring uuid required

Asset Group ID

Query parameters

periodstring

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Response

A successful operation

namestring
status'active' | 'inactive'
asset_group_type_id'network'
default_network_reporting_group_idstring
default_estimation_method_idstring uuid
idstring uuid
company_idstring uuid
created_atstring date-time
created_bystring uuid
updated_atstring date-time
updated_bystring uuid
custom_attributesCustomAttributes
network_inlet_idsstring[]

Example response

{
  "default_network_reporting_group": {
    "name": "SubpartW",
    "description": "my reporting group",
    "priority": 2,
    "id": "subpartw"
  },
  "default_estimation_method": {
    "analytics_library_id": "2024-SubpartW",
    "analytics_calculator_id": "2024-SubpartW-AcidGasRemovalMethod1",
    "name": "SubpartW AGR Method",
    "default_values": {
      "fuel_type": {
        "value": "Eastern",
        "unit": "",
        "measurement_type": "measurement_type",
        "measurement_quantity": "dimensionless_coefficient"
      },
      "volume": {
        "value": 5,
        "unit": "e3m3",
        "measurement_type": "measurement_type",
        "measurement_quantity": "volume"
      }
    },
    "default_asset_values": {
      "a04b4387-5145-4935-9edc-d53ecdb7a6c0": {
        "fuel_type": {
          "value": "Eastern",
          "unit": "",
          "measurement_type": "measurement_type",
          "measurement_quantity": "dimensionless_coefficient"
        },
        "volume": {
          "value": 5,
          "unit": "e3m3",
          "measurement_type": "measurement_type",
          "measurement_quantity": "volume"
        }
      },
      "99a45dd3-6ce1-4290-9d16-79415111cc43": {
        "fuel_type": {
          "value": "Eastern",
          "unit": "",
          "measurement_type": "measurement_type",
          "measurement_quantity": "dimensionless_coefficient"
        },
        "volume": {
          "value": 5,
          "unit": "e3m3",
          "measurement_type": "measurement_type",
          "measurement_quantity": "volume"
        }
      }
    }
  },
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  }
}