Create an asset meter
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/buyer/asset/meters \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"defaultExpectedValue": "<string>",
"isArchived": true
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters"
payload = {
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"defaultExpectedValue": "<string>",
"isArchived": True
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
assetId: 123,
meterTypeId: 123,
defaultExpectedValue: '<string>',
isArchived: true
})
};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/asset/meters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'assetId' => 123,
'meterTypeId' => 123,
'defaultExpectedValue' => '<string>',
'isArchived' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useopenwrench.com/api/external/v1/buyer/asset/meters")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/asset/meters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"readingMode": "direct_reading",
"valueType": "<string>",
"valueUnit": "<string>",
"locationId": 123,
"buyerCompanyId": 123,
"isArchived": true,
"isDeleted": true,
"id": 123,
"defaultExpectedValue": "<string>",
"lastReading": {
"meterId": 123,
"isBaseline": true,
"value": "<string>",
"recordedAt": "2023-11-07T05:31:56Z",
"recordedBy": "<string>",
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"expectedValue": "<string>",
"lastBaselineValue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Asset Meters
Create an asset meter
Creates a meter on an asset. valueType, valueUnit and locationId are not read from the request body — they are derived server-side from the referenced asset and meter type. readingMode defaults to direct_reading when omitted.
POST
/
v1
/
buyer
/
asset
/
meters
Create an asset meter
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/buyer/asset/meters \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"defaultExpectedValue": "<string>",
"isArchived": true
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters"
payload = {
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"defaultExpectedValue": "<string>",
"isArchived": True
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
assetId: 123,
meterTypeId: 123,
defaultExpectedValue: '<string>',
isArchived: true
})
};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/asset/meters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'assetId' => 123,
'meterTypeId' => 123,
'defaultExpectedValue' => '<string>',
'isArchived' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/asset/meters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useopenwrench.com/api/external/v1/buyer/asset/meters")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/asset/meters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"assetId\": 123,\n \"meterTypeId\": 123,\n \"defaultExpectedValue\": \"<string>\",\n \"isArchived\": true\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"name": "<string>",
"assetId": 123,
"meterTypeId": 123,
"readingMode": "direct_reading",
"valueType": "<string>",
"valueUnit": "<string>",
"locationId": 123,
"buyerCompanyId": 123,
"isArchived": true,
"isDeleted": true,
"id": 123,
"defaultExpectedValue": "<string>",
"lastReading": {
"meterId": 123,
"isBaseline": true,
"value": "<string>",
"recordedAt": "2023-11-07T05:31:56Z",
"recordedBy": "<string>",
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"expectedValue": "<string>",
"lastBaselineValue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Autorisations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Corps
application/json
Fields not listed here (e.g. valueType, valueUnit, locationId) are ignored if sent.