Update signal

patch

https://data.api.exabel.com/v1/signals/{signalId}

This can also be used to create a signal by setting allowMissing to true.

Note that this method will update all fields unless updateMask is set.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

signalId

string

required

The ID of a signal, e.g. signalIdentifier or namespace.signalIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The signal identifier must match the regex [a-zA-Z]\w{0,63}.

Query Params

updateMask

string

Use this to update only selected fields. For example, specify displayName to update only the display name. If allowMissing is set, this field is ignored.

For REST requests, this is a comma-separated string.

allowMissing

boolean

If set to true, a new raw data signal will be created if it did not exist, and updateMask is ignored.

createLibrarySignal

boolean

Set to true to also create a derived signal in the Library, referencing this new raw data signal. This will be created in the "Upload" folder. This is only applicable if a new raw data signal has been created (with allowMissing set to true).

Body Params

The signal to update.

displayName

string

Used when showing the signal in the Exabel app. Required when creating a signal.

description

string

Used when showing the signal in the Exabel app.

downsamplingMethod

string

enum

Defaults to LAST

Aggregation methods.

AGGREGATION_INVALID: Aggregation is unspecified and invalid. Aggregation must be set.
MEAN: Takes the arithmetic mean of the data values. Example: 2, 1, 3, 5, 4 -> 3.
FIRST: Selects the first value. Example: 2, 1, 3, 5, 4 -> 2.
LAST: Selects the last value. Example: 2, 1, 3, 5, 4 -> 4.
SUM: Sums the data values. Example: 2, 1, 3, 5, 4 -> 15.
MIN: Selects the minimum value. Example: 2, 1, 3, 5, 4 -> 1.
MAX: Selects the maximum value. Example: 2, 1, 3, 5, 4 -> 5.
MEDIAN: Selects the median value. Example: 2, 1, 3, 5, 1000 -> 3.

Responses

200A successful response.

defaultAn unexpected error response.