IOionworks
Channels

Update a specific channel by id

Changed on

Update an existing channel identified by its ID.

Only provided fields will be updated. Taking a channel out of service (or returning it) also records an outage span; user_id is threaded through so the incident records who did it.

patch/channels/{channel_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/channels/{channel_id}
  • Auth
    none declared

Path parameters

channel_idstring uuid required

Request body

object required

Response

Successful Response

namestring required

Name of the channel

notesstring nullable

Free-text notes about the channel

cycler_idstring required

Foreign key to the parent cycler

max_ampsnumber nullable

Maximum rated current for the channel, in amps (A).

min_voltsnumber nullable

Minimum rated voltage for the channel, in volts (V).

max_voltsnumber nullable

Maximum rated voltage for the channel, in volts (V).

idstring required

Unique identifier for the channel

out_of_commissionboolean

Whether the channel is deliberately out of service (broken or under maintenance). An out-of-commission channel is shown as such in the Lab view and is not counted as available.

organization_idstring required

Organization this channel belongs to.

project_idstring required

Project that owns this channel (inherited from its cycler)

created_bystring nullable

User ID of the user who created this channel

created_by_emailstring nullable

Email of the user who created this channel

created_atstring date-time required

Timestamp when the channel was created

updated_atstring date-time required

Timestamp when the channel was last updated

Changes