Apply selected auto-schedule assignments

curl --request POST \
  --url https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignments": [
    {
      "planned_measurement_id": "<string>",
      "planned_measurement_name": "<string>",
      "planned_measurement_updated_at": "2023-11-07T05:31:56Z",
      "channel_id": "<string>",
      "channel_name": "<string>",
      "cycler_name": "<string>",
      "planned_start_time": "2023-11-07T05:31:56Z",
      "planned_end_time": "2023-11-07T05:31:56Z",
      "unscheduled_reason": "<string>"
    }
  ]
}
'

import requests

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

payload = { "assignments": [
        {
            "planned_measurement_id": "<string>",
            "planned_measurement_name": "<string>",
            "planned_measurement_updated_at": "2023-11-07T05:31:56Z",
            "channel_id": "<string>",
            "channel_name": "<string>",
            "cycler_name": "<string>",
            "planned_start_time": "2023-11-07T05:31:56Z",
            "planned_end_time": "2023-11-07T05:31:56Z",
            "unscheduled_reason": "<string>"
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assignments: [
      {
        planned_measurement_id: '<string>',
        planned_measurement_name: '<string>',
        planned_measurement_updated_at: '2023-11-07T05:31:56Z',
        channel_id: '<string>',
        channel_name: '<string>',
        cycler_name: '<string>',
        planned_start_time: '2023-11-07T05:31:56Z',
        planned_end_time: '2023-11-07T05:31:56Z',
        unscheduled_reason: '<string>'
      }
    ]
  })
};

fetch('https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal', 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/apply_auto_schedule_proposal",
  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([
    'assignments' => [
        [
                'planned_measurement_id' => '<string>',
                'planned_measurement_name' => '<string>',
                'planned_measurement_updated_at' => '2023-11-07T05:31:56Z',
                'channel_id' => '<string>',
                'channel_name' => '<string>',
                'cycler_name' => '<string>',
                'planned_start_time' => '2023-11-07T05:31:56Z',
                'planned_end_time' => '2023-11-07T05:31:56Z',
                'unscheduled_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/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal"

	payload := strings.NewReader("{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal")
  .header("Content-Type", "application/json")
  .body("{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}"

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

[
  {
    "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>",
    "program_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>",
    "program_name": "<string>",
    "estimated_duration_job_id": "<string>",
    "estimated_duration_simulation_id": "<string>",
    "simulated_duration_seconds": 123,
    "estimated_duration_is_exact": true,
    "estimated_duration_margin_pct": 123,
    "actual_duration_seconds": 123,
    "estimated_duration_note": "<string>",
    "estimated_duration_calculated_at": "2023-11-07T05:31:56Z"
  }
]

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

Apply selected auto-schedule assignments

curl --request POST \
  --url https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignments": [
    {
      "planned_measurement_id": "<string>",
      "planned_measurement_name": "<string>",
      "planned_measurement_updated_at": "2023-11-07T05:31:56Z",
      "channel_id": "<string>",
      "channel_name": "<string>",
      "cycler_name": "<string>",
      "planned_start_time": "2023-11-07T05:31:56Z",
      "planned_end_time": "2023-11-07T05:31:56Z",
      "unscheduled_reason": "<string>"
    }
  ]
}
'

import requests

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

payload = { "assignments": [
        {
            "planned_measurement_id": "<string>",
            "planned_measurement_name": "<string>",
            "planned_measurement_updated_at": "2023-11-07T05:31:56Z",
            "channel_id": "<string>",
            "channel_name": "<string>",
            "cycler_name": "<string>",
            "planned_start_time": "2023-11-07T05:31:56Z",
            "planned_end_time": "2023-11-07T05:31:56Z",
            "unscheduled_reason": "<string>"
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    assignments: [
      {
        planned_measurement_id: '<string>',
        planned_measurement_name: '<string>',
        planned_measurement_updated_at: '2023-11-07T05:31:56Z',
        channel_id: '<string>',
        channel_name: '<string>',
        cycler_name: '<string>',
        planned_start_time: '2023-11-07T05:31:56Z',
        planned_end_time: '2023-11-07T05:31:56Z',
        unscheduled_reason: '<string>'
      }
    ]
  })
};

fetch('https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal', 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/apply_auto_schedule_proposal",
  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([
    'assignments' => [
        [
                'planned_measurement_id' => '<string>',
                'planned_measurement_name' => '<string>',
                'planned_measurement_updated_at' => '2023-11-07T05:31:56Z',
                'channel_id' => '<string>',
                'channel_name' => '<string>',
                'cycler_name' => '<string>',
                'planned_start_time' => '2023-11-07T05:31:56Z',
                'planned_end_time' => '2023-11-07T05:31:56Z',
                'unscheduled_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/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal"

	payload := strings.NewReader("{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.ionworks.com/projects/{project_id}/planned_measurements/apply_auto_schedule_proposal")
  .header("Content-Type", "application/json")
  .body("{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assignments\": [\n    {\n      \"planned_measurement_id\": \"<string>\",\n      \"planned_measurement_name\": \"<string>\",\n      \"planned_measurement_updated_at\": \"2023-11-07T05:31:56Z\",\n      \"channel_id\": \"<string>\",\n      \"channel_name\": \"<string>\",\n      \"cycler_name\": \"<string>\",\n      \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n      \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n      \"unscheduled_reason\": \"<string>\"\n    }\n  ]\n}"

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

[
  {
    "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>",
    "program_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>",
    "program_name": "<string>",
    "estimated_duration_job_id": "<string>",
    "estimated_duration_simulation_id": "<string>",
    "simulated_duration_seconds": 123,
    "estimated_duration_is_exact": true,
    "estimated_duration_margin_pct": 123,
    "actual_duration_seconds": 123,
    "estimated_duration_note": "<string>",
    "estimated_duration_calculated_at": "2023-11-07T05:31:56Z"
  }
]

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

Path Parameters

project_id

string

required

Body

application/json

The selected scheduled assignments from a transient proposal.

assignments

AutoScheduleAssignment · object[]

required

Required array length: 1 - 100 elements

Show child attributes

Response

Successful Response

name

string

required

Required string length: 1 - 255

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.

program_id

string | null

Optional catalog program (Formation, Cycling, …) for this test request.

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

program_name

string | null

estimated_duration_status

enum<string> | null

Lifecycle of a duration estimate computed by a background simulation.

Used by both estimates: a planned test's total duration (planned_measurements.estimated_duration_*) and a running test's remaining duration (cell_measurements.estimated_end_time_*). One enum because the lifecycle is identical -- only what is being estimated differs.

estimating while the job is in flight, ready once a value came from it, failed with the reason in the accompanying note. None means no estimate was ever requested.

Available options:

estimating,

ready,

failed

estimated_duration_job_id

string | null

estimated_duration_simulation_id

string | null

simulated_duration_seconds

integer | null

estimated_duration_is_exact

boolean | null

estimated_duration_margin_pct

number | null

actual_duration_seconds

integer | null

estimated_duration_note

string | null

estimated_duration_calculated_at

string<date-time> | null

⌘I

API Reference

Cell Specifications

Cell Instances

Cell Measurements

Programs

Sites

Cyclers

Channels

Simulations

parameterized_models

discovery

Pipeline

simple_pipeline

protocols

users

jobs

optimization

optimizations

Organizations

project-webhooks

studies

Lab

Planned Measurements

Health check

Apply selected auto-schedule assignments

Path Parameters

Body

Response