• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referenceuoms

Update UOM

Beta
POST
https://api.devrev.ai/uoms.update
POST
/uoms.update
1curl -X POST https://api.devrev.ai/uoms.update \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "id": "string"
6}'
Try it
1{
2  "uom": {
3    "aggregation_details": {
4      "aggregation_type": "duration",
5      "unique_dimension": "string"
6    },
7    "id": "string",
8    "is_enabled": true,
9    "metric_name": "string",
10    "metric_scope": "org",
11    "name": "string",
12    "product": {
13      "display_id": "string",
14      "id": "string",
15      "name": "string",
16      "owned_by": [
17        {
18          "display_id": "string",
19          "id": "string",
20          "display_name": "string",
21          "display_picture": {
22            "display_id": {},
23            "id": {},
24            "file": {}
25          },
26          "email": "string",
27          "full_name": "string",
28          "state": "active"
29        }
30      ],
31      "sync_metadata": {
32        "external_reference": "string",
33        "origin_system": "string"
34      }
35    },
36    "unit": {
37      "type": "boolean",
38      "name": "string"
39    },
40    "created_by": {
41      "display_id": "string",
42      "id": "string",
43      "display_name": "string",
44      "display_picture": {
45        "display_id": "string",
46        "id": "string",
47        "file": {
48          "type": "string",
49          "name": "string",
50          "size": 1
51        }
52      },
53      "email": "string",
54      "full_name": "string",
55      "state": "active"
56    },
57    "created_date": "2023-01-01T12:00:00.000Z",
58    "description": "string",
59    "dimensions": [
60      "string"
61    ],
62    "display_id": "string",
63    "modified_by": {
64      "display_id": "string",
65      "id": "string",
66      "display_name": "string",
67      "display_picture": {
68        "display_id": "string",
69        "id": "string",
70        "file": {
71          "type": "string",
72          "name": "string",
73          "size": 1
74        }
75      },
76      "email": "string",
77      "full_name": "string",
78      "state": "active"
79    },
80    "modified_date": "2023-01-01T12:00:00.000Z",
81    "part": {
82      "display_id": "string",
83      "id": "string",
84      "name": "string",
85      "owned_by": [
86        {
87          "display_id": "string",
88          "id": "string",
89          "display_name": "string",
90          "display_picture": {
91            "display_id": {},
92            "id": {},
93            "file": {}
94          },
95          "email": "string",
96          "full_name": "string",
97          "state": "active"
98        }
99      ],
100      "sync_metadata": {
101        "external_reference": "string",
102        "origin_system": "string"
103      }
104    }
105  }
106}
Updates a Unit of Measurement.

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The Unit of Measurement (UOM)'s DON.
aggregation_typeenumOptional
Aggregation type to be used while aggregating the metering data for the UOM. 1] Sum - sum of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for the meter in the given period (not considering the data from the previous billing period) Ex. January {M1:{VM:VM0}}, February {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total - Sum of distinct active unique dimension observed for a meter in the given period, taking into consideration the active data from the previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off} February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3} 6] Duration - Sum of distinct active unique dimension duration for a meter in the given period, taking into consideration the active data from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15 {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1-> 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the latest/last meter in the given period 8] Oldest - consider the oldest/first record in the given period.
descriptionstringOptionalformat: "text"
Description of the Unit of Measurement (UOM).
dimensionsobjectOptional
is_enabledbooleanOptional
Flag used to enable/disable the Unit of Measurement (UOM). When disabled, any metricsrecords ingested against this UOM will be dropped.
namestringOptionalformat: "text"
Human readable name of the Unit of Measurement (UOM).
part_idstringOptionalformat: "id"
The part ID such as feature or capability for which the Unit of Measurement (UOM) is defined.
product_idstringOptionalformat: "id"
The product ID for which the Unit of Measurement (UOM) is defined.
unitstringOptionalformat: "text"
Unit name of the Unit of Measurement (UOM).

Response

Success.
uomobject

Errors

Was this page helpful?
Previous

Create Vista

Next
Built with
Success.

The Unit of Measurement (UOM)‘s DON.

Description of the Unit of Measurement (UOM).

Flag used to enable/disable the Unit of Measurement (UOM). When disabled, any metricsrecords ingested against this UOM will be dropped.

Unit name of the Unit of Measurement (UOM).

Human readable name of the Unit of Measurement (UOM).

The part ID such as feature or capability for which the Unit of Measurement (UOM) is defined.

The product ID for which the Unit of Measurement (UOM) is defined.

Bearer authentication of the form Bearer <token>, where token is your auth token.