latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

networks

Triggers the calculation and returns the table along with the results

post/app/v1/networks/{id}/{year_month}/run

Path parameters

idstring uuid required

Asset Group ID

year_monthstring required

YearMonth

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'status' | 'product_category' | 'product_type' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

promote_to_recordboolean

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc"
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber
reporting_group_idstring

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      }
    }
  ]
}