Get a planned measurement

Get a planned measurement by id within a project.

Get a planned measurement

cURL

curl --request GET \
  --url https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}

import requests

url = "https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}', 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/projects/{project_id}/planned_measurements/{planned_measurement_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/projects/{project_id}/planned_measurements/{planned_measurement_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "name": "<string>",
  "id": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "requested_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cell_specification_id": "<string>",
  "cell_instance_id": "<string>",
  "channel_id": "<string>",
  "protocol_id": "<string>",
  "test_setup": {},
  "planned_start_time": "2023-11-07T05:31:56Z",
  "planned_end_time": "2023-11-07T05:31:56Z",
  "estimated_duration_seconds": 2,
  "setup_duration_seconds": 0,
  "teardown_duration_seconds": 0,
  "notes": "<string>",
  "scheduled_by": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_measurement_id": "<string>",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "requested_by_email": "<string>",
  "scheduled_by_email": "<string>",
  "channel_name": "<string>",
  "cycler_id": "<string>",
  "cycler_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

project_id · string · required

planned_measurement_id · string · required

Response

200

application/json

Successful Response

A planned measurement row returned by the API.

name · string · required

Required string length: 1 - 255

id · string · required

organization_id · string · required

project_id · string · required

status · enum<string> · required

Lifecycle state for a planned measurement.

Available options: requested, scheduled, in_progress, completed, cancelled

requested_by · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

cell_specification_id · string | null

Cell specification the requester wants tested (set at request time).

cell_instance_id · string | null

Cell instance this future measurement will run on.

channel_id · string | null

Channel reserved for this measurement, once scheduled.

protocol_id · string | null

Named protocol (experiment_template) this measurement will run. Required on create; a planned measurement must name a protocol.

test_setup · Test Setup · object | null

Planned physical setup.

planned_start_time · string<date-time> | null

When setup/run is planned to start.

planned_end_time · string<date-time> | null

When this planned measurement is expected to release the channel.

estimated_duration_seconds · integer | null

Expected run duration before scheduled times exist.

Required range: x >= 1

setup_duration_seconds · integer · default: 0

Operator setup duration before the test starts.

Required range: x >= 0

teardown_duration_seconds · integer · default: 0

Operator teardown duration after the test finishes.

Required range: x >= 0

notes · string | null

Free-text planning notes.

scheduled_by · string | null

scheduled_at · string<date-time> | null

started_measurement_id · string | null

cancelled_at · string<date-time> | null

completed_at · string<date-time> | null

requested_by_email · string | null

scheduled_by_email · string | null

channel_name · string | null

cycler_id · string | null

cycler_name · string | null