Sign in

v44

latestSwagger 2.0NTIA/ITSraw.githubusercontent.com2024-04-2650568.6 KB
v1

Updates the specified schedule entry.

put/v1/schedule/{name}/

Request body

selfstring uri

The url of the entry

namestring slug required

[Required] The unique identifier used in URLs and filenames

action'test_SEA_CBRS_Measure_Baseline' | 'test_monitor_sigan' | 'test_multi_frequency_iq_action' | 'test_single_frequency_iq_action' | 'test_single_frequency_m4s_action' | 'test_survey_iq_action' | 'test_sync_gps' required

[Required] The name of the action to be scheduled

priorityinteger nullable

Lower number is higher priority (default=10)

startstring date-time nullable

UTC time (ISO 8601) to start, or leave blank for 'now'

stopstring date-time nullable

UTC time (ISO 8601) to stop, or leave blank for 'never' (not valid with relative stop)

relative_stopinteger nullable

Integer seconds after start to stop, or leave blank for 'never' (not valid with absolute stop)

intervalinteger nullable

Seconds between tasks, or leave blank to run once

is_activeboolean

Indicates whether the entry should be removed from the scheduler without removing it from the system

callback_urlstring uri nullable

If given, the scheduler will POST a TaskResult JSON object to this URL after each task completes

next_task_timestring date-time

UTC time (ISO 8601) the next task is scheduled for

next_task_idinteger

The id of the next task to be executed

createdstring date-time

The date the entry was created

modifiedstring date-time

The date the entry was modified

ownerstring uri

The name of the user who owns the entry

task_resultsstring

The list of results related to the entry

validate_onlyboolean

Only validate the input, do not modify the schedule

Response

OK

selfstring uri

The url of the entry

namestring slug required

[Required] The unique identifier used in URLs and filenames

action'test_SEA_CBRS_Measure_Baseline' | 'test_monitor_sigan' | 'test_multi_frequency_iq_action' | 'test_single_frequency_iq_action' | 'test_single_frequency_m4s_action' | 'test_survey_iq_action' | 'test_sync_gps' required

[Required] The name of the action to be scheduled

priorityinteger nullable

Lower number is higher priority (default=10)

startstring date-time nullable

UTC time (ISO 8601) to start, or leave blank for 'now'

stopstring date-time nullable

UTC time (ISO 8601) to stop, or leave blank for 'never' (not valid with relative stop)

relative_stopinteger nullable

Integer seconds after start to stop, or leave blank for 'never' (not valid with absolute stop)

intervalinteger nullable

Seconds between tasks, or leave blank to run once

is_activeboolean

Indicates whether the entry should be removed from the scheduler without removing it from the system

callback_urlstring uri nullable

If given, the scheduler will POST a TaskResult JSON object to this URL after each task completes

next_task_timestring date-time

UTC time (ISO 8601) the next task is scheduled for

next_task_idinteger

The id of the next task to be executed

createdstring date-time

The date the entry was created

modifiedstring date-time

The date the entry was modified

ownerstring uri

The name of the user who owns the entry

task_resultsstring

The list of results related to the entry

validate_onlyboolean

Only validate the input, do not modify the schedule