Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

asset_groups

Search and list Asset Groups

post/app/v1/asset_groups/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'status' | 'asset_group_type_id' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "asset.asset_type": "equipment"
      },
      {
        "name": {
          "$like": "Asset Group 1"
        }
      }
    ]
  }
}

Response

Successfully something

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "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"
      }
    }
  ]
}