Report a cell measurement as failed, or clear the report
curl --request PATCH \
--url https://api.ionworks.com/cell_measurements/{measurement_id}/failure \
--header 'Content-Type: application/json' \
--data '
{
"failed": true,
"reason": "<string>"
}
'import requests
url = "https://api.ionworks.com/cell_measurements/{measurement_id}/failure"
payload = {
"failed": True,
"reason": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({failed: true, reason: '<string>'})
};
fetch('https://api.ionworks.com/cell_measurements/{measurement_id}/failure', 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.ionworks.com/cell_measurements/{measurement_id}/failure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'failed' => true,
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.ionworks.com/cell_measurements/{measurement_id}/failure"
payload := strings.NewReader("{\n \"failed\": true,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.ionworks.com/cell_measurements/{measurement_id}/failure")
.header("Content-Type", "application/json")
.body("{\n \"failed\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_measurements/{measurement_id}/failure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"failed\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"measurement": {
"name": "<string>",
"id": "<string>",
"cell_instance_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_failed": false,
"failure_reason": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_by": "<string>",
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "time_series",
"properties": {},
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
],
"created_by": "<string>",
"created_by_email": "<string>",
"processing_status": "ready",
"processing_error": "<string>",
"source_etag": "<string>",
"row_count": 123,
"time_series_bytes": 123,
"recorded_duration_s": 123,
"accepts_raw_updates": false,
"estimated_end_time_status": "estimating",
"estimated_end_time_job_id": "<string>",
"extend_claim_id": "<string>",
"extend_in_progress_at": "2023-11-07T05:31:56Z",
"extend_claimed_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Cell Measurements
Report a cell measurement as failed, or clear the report
Mark one test as failed, e.g. a run stopped early or never started.
Only this measurement is marked; its cell is not, and nothing is sent to the LIMS. To fail the whole cell, use PATCH /cell_instances//failure.
Report a cell measurement as failed, or clear the report
curl --request PATCH \
--url https://api.ionworks.com/cell_measurements/{measurement_id}/failure \
--header 'Content-Type: application/json' \
--data '
{
"failed": true,
"reason": "<string>"
}
'import requests
url = "https://api.ionworks.com/cell_measurements/{measurement_id}/failure"
payload = {
"failed": True,
"reason": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({failed: true, reason: '<string>'})
};
fetch('https://api.ionworks.com/cell_measurements/{measurement_id}/failure', 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.ionworks.com/cell_measurements/{measurement_id}/failure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'failed' => true,
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.ionworks.com/cell_measurements/{measurement_id}/failure"
payload := strings.NewReader("{\n \"failed\": true,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.ionworks.com/cell_measurements/{measurement_id}/failure")
.header("Content-Type", "application/json")
.body("{\n \"failed\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_measurements/{measurement_id}/failure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"failed\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"measurement": {
"name": "<string>",
"id": "<string>",
"cell_instance_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_failed": false,
"failure_reason": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_by": "<string>",
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "time_series",
"properties": {},
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
],
"created_by": "<string>",
"created_by_email": "<string>",
"processing_status": "ready",
"processing_error": "<string>",
"source_etag": "<string>",
"row_count": 123,
"time_series_bytes": 123,
"recorded_duration_s": 123,
"accepts_raw_updates": false,
"estimated_end_time_status": "estimating",
"estimated_end_time_job_id": "<string>",
"extend_claim_id": "<string>",
"extend_in_progress_at": "2023-11-07T05:31:56Z",
"extend_claimed_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Response
Successful Response
The measurement after its verdict changed.
A measurement's verdict is never sent to the LIMS: Uncountable's cell failure output describes the cell, and one failed test does not fail it.
Show child attributes
Show child attributes
Was this page helpful?