Compute With Units

POST

https://api.gov.nominal.io/api/compute/v2/computeWithUnits

POST

/api/compute/v2/computeWithUnits

1 curl -X POST https://api.gov.nominal.io/api/compute/v2/computeWithUnits \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "node": {
6     "type": "ranges",
7     "ranges": {
8       "input": {
9         "type": "approximateThreshold",
10         "approximateThreshold": {
11           "input": {
12             "type": "aggregate",
13             "aggregate": {
14               "input": {
15                 "type": "arithmetic",
16                 "arithmetic": {
17                   "inputs": {},
18                   "expression": "expression"
19                 }
20               },
21               "function": "SUM"
22             }
23           },
24           "threshold": {
25             "type": "literal",
26             "literal": 1.1
27           },
28           "tolerance": {
29             "type": "literal",
30             "literal": 1.1
31           },
32           "operator": "EQUAL_TO"
33         }
34       }
35     }
36   },
37   "start": {
38     "seconds": 1000000,
39     "nanos": 1000000
40   },
41   "end": {
42     "seconds": 1000000,
43     "nanos": 1000000
44   },
45   "context": {
46     "variables": {
47       "variables": {
48         "type": "double",
49         "double": 1.1
50       }
51     },
52     "functionVariables": {
53       "functionVariables": {
54         "variables": {
55           "variables": {
56             "type": "double",
57             "double": 1.1
58           }
59         },
60         "subFunctionVariables": {
61           "subFunctionVariables": {
62             "variables": {
63               "variables": {
64                 "type": "double",
65                 "double": 1.1
66               }
67             },
68             "subFunctionVariables": {
69               "subFunctionVariables": {
70                 "variables": {
71                   "variables": {
72                     "type": "double",
73                     "double": 1.1
74                   }
75                 },
76                 "subFunctionVariables": {
77                   "subFunctionVariables": {
78                     "variables": {},
79                     "subFunctionVariables": {}
80                   }
81                 }
82               }
83             }
84           }
85         }
86       }
87     }
88   }
89 }'

Try it

200Successful

1 {
2   "computeResult": {
3     "type": "numeric",
4     "numeric": {
5       "timestamps": [
6         {
7           "seconds": 1000000,
8           "nanos": 1000000,
9           "picos": 1
10         },
11         {
12           "seconds": 1000000,
13           "nanos": 1000000,
14           "picos": 1
15         }
16       ],
17       "values": [
18         1.1,
19         1.1
20       ]
21     }
22   },
23   "computeUnit": {
24     "type": "single",
25     "single": {
26       "type": "success",
27       "success": "computeUnit"
28     }
29   }
30 }

Computes the output of the compute graph specified by a ComputeNodeRequest, as well as providing the resulting unit for the output of a compute graph. If the resulting unit is equivalent to exactly one existing unit in the system, it will be returned (for example, a series in Coulombs divided by a series in Volts will return an output of Farads). If the output does not have units (for example, a range output,) the unit result will return noUnitAvailable, and if the computation was not successful, corresponding errors are returned.

Request

This endpoint expects an object.

nodeobjectRequired

startobjectRequired

endobjectRequired

contextobjectRequired

Response

This endpoint returns an object.

computeResultobject

computeUnitobject

Headers

Request

Response