Package com.seeq.api
Class SignalsApi
java.lang.Object
com.seeq.api.SignalsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddSamples
(String id, SamplesInputV1 body) Save samples to a signaladdSamplesByDataId
(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body) Save samples to a signal, using the source system's identifieraddSamplesByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body, Map<String, String> customHeaders) Save samples to a signal, using the source system's identifieraddSamplesByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body) Save samples to a signal, using the source system's identifieraddSamplesWithHeadersAndHttpInfo
(String id, SamplesInputV1 body, Map<String, String> customHeaders) Save samples to a signaladdSamplesWithHttpInfo
(String id, SamplesInputV1 body) Save samples to a signalarchiveSignal
(String id) Archive a signalarchiveSignalByDataId
(String datasourceClass, String datasourceId, String dataId) Archive a signal, using the source system's identifierarchiveSignalByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, Map<String, String> customHeaders) Archive a signal, using the source system's identifierarchiveSignalByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId) Archive a signal, using the source system's identifierarchiveSignalWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a signalArchive a signalcreateSignal
(SignalInputV1 body) Create a new signal, to be stored in SeeqcreateSignalWithHeadersAndHttpInfo
(SignalInputV1 body, Map<String, String> customHeaders) Create a new signal, to be stored in SeeqCreate a new signal, to be stored in SeeqdeleteSamples
(String id) Delete all samples in a signaldeleteSamplesWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Delete all samples in a signalDelete all samples in a signallong
Get a sample from a signalgetSampleByDataId
(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) Get a sample from a signal, using the source system's identifiergetSampleByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure, Map<String, String> customHeaders) Get a sample from a signal, using the source system's identifiergetSampleByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) Get a sample from a signal, using the source system's identifiergetSamples
(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) Get samples from a signal over an intervalgetSamplesByDataId
(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) Get samples from a signal over an interval, using the source system's identifiergetSamplesByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit, Map<String, String> customHeaders) Get samples from a signal over an interval, using the source system's identifiergetSamplesByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) Get samples from a signal over an interval, using the source system's identifiergetSamplesWithHeadersAndHttpInfo
(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit, Map<String, String> customHeaders) Get samples from a signal over an intervalgetSamplesWithHttpInfo
(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) Get samples from a signal over an intervalgetSampleWithHeadersAndHttpInfo
(String id, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure, Map<String, String> customHeaders) Get a sample from a signalgetSampleWithHttpInfo
(String id, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) Get a sample from a signalGet signalgetSignalByDataId
(String datasourceClass, String datasourceId, String dataId) Get a signal, using the source system's identifiergetSignalByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, Map<String, String> customHeaders) Get a signal, using the source system's identifiergetSignalByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId) Get a signal, using the source system's identifiergetSignals
(Integer offset, Integer limit) List signalsList signalsgetSignalsWithHttpInfo
(Integer offset, Integer limit) List signalsgetSignalWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get signalGet signalputSamples
(String id, SamplesOverwriteInputV1 body) Replace any samples to a signal in the same time rangeputSamplesByDataId
(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body) Replace any samples to a signal in the same time range, using the source system's identifierputSamplesByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body, Map<String, String> customHeaders) Replace any samples to a signal in the same time range, using the source system's identifierputSamplesByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body) Replace any samples to a signal in the same time range, using the source system's identifierputSamplesWithHeadersAndHttpInfo
(String id, SamplesOverwriteInputV1 body, Map<String, String> customHeaders) Replace any samples to a signal in the same time rangeReplace any samples to a signal in the same time rangeputSignal
(String id, SignalInputV1 body) Update a signalputSignalByDataId
(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body) Create or update a signal, using the source system's identifierputSignalByDataIdWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body, Map<String, String> customHeaders) Create or update a signal, using the source system's identifierputSignalByDataIdWithHttpInfo
(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body) Create or update a signal, using the source system's identifierputSignals
(PutSignalsInputV1 body) Create or update multiple signalsputSignalsWithHeadersAndHttpInfo
(PutSignalsInputV1 body, Map<String, String> customHeaders) Create or update multiple signalsCreate or update multiple signalsputSignalWithHeadersAndHttpInfo
(String id, SignalInputV1 body, Map<String, String> customHeaders) Update a signalputSignalWithHttpInfo
(String id, SignalInputV1 body) Update a signalvoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout)
-
Constructor Details
-
SignalsApi
public SignalsApi() -
SignalsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
addSamples
Save samples to a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)- Returns:
- SamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
addSamplesWithHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> addSamplesWithHttpInfo(String id, SamplesInputV1 body) throws ApiException Save samples to a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)- Throws:
ApiException
- if fails to make API call
-
addSamplesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> addSamplesWithHeadersAndHttpInfo(String id, SamplesInputV1 body, Map<String, String> customHeaders) throws ApiExceptionSave samples to a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
addSamplesByDataId
public SamplesOutputV1 addSamplesByDataId(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body) throws ApiException Save samples to a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)- Returns:
- SamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
addSamplesByDataIdWithHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> addSamplesByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body) throws ApiException Save samples to a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)- Throws:
ApiException
- if fails to make API call
-
addSamplesByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> addSamplesByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, SamplesInputV1 body, Map<String, String> customHeaders) throws ApiExceptionSave samples to a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
archiveSignal
Archive a signal- Parameters:
id
- The Seeq ID for the signal (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveSignalWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveSignalWithHttpInfo(String id) throws ApiException Archive a signal- Parameters:
id
- The Seeq ID for the signal (required)- Throws:
ApiException
- if fails to make API call
-
archiveSignalWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveSignalWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a signal- Parameters:
id
- The Seeq ID for the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
archiveSignalByDataId
public ArchiveOutputV1 archiveSignalByDataId(String datasourceClass, String datasourceId, String dataId) throws ApiException Archive a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveSignalByDataIdWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveSignalByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId) throws ApiException Archive a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)- Throws:
ApiException
- if fails to make API call
-
archiveSignalByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveSignalByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, Map<String, String> customHeaders) throws ApiExceptionArchive a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createSignal
Create a new signal, to be stored in Seeq- Parameters:
body
- (required)- Returns:
- SignalOutputV1
- Throws:
ApiException
- if fails to make API call
-
createSignalWithHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> createSignalWithHttpInfo(SignalInputV1 body) throws ApiException Create a new signal, to be stored in Seeq- Parameters:
body
- (required)- Throws:
ApiException
- if fails to make API call
-
createSignalWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> createSignalWithHeadersAndHttpInfo(SignalInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a new signal, to be stored in Seeq- Parameters:
body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deleteSamples
Delete all samples in a signal- Parameters:
id
- The Seeq ID for the signal (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deleteSamplesWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteSamplesWithHttpInfo(String id) throws ApiException Delete all samples in a signal- Parameters:
id
- The Seeq ID for the signal (required)- Throws:
ApiException
- if fails to make API call
-
deleteSamplesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteSamplesWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionDelete all samples in a signal- Parameters:
id
- The Seeq ID for the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSample
public GetSampleOutputV1 getSample(String id, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) throws ApiException Get a sample from a signal- Parameters:
id
- The Seeq ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)- Returns:
- GetSampleOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSampleWithHttpInfo
public ApiClient.ApiResponse<GetSampleOutputV1> getSampleWithHttpInfo(String id, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) throws ApiException Get a sample from a signal- Parameters:
id
- The Seeq ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)- Throws:
ApiException
- if fails to make API call
-
getSampleWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetSampleOutputV1> getSampleWithHeadersAndHttpInfo(String id, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure, Map<String, String> customHeaders) throws ApiExceptionGet a sample from a signal- Parameters:
id
- The Seeq ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSampleByDataId
public GetSampleOutputV1 getSampleByDataId(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) throws ApiException Get a sample from a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)- Returns:
- GetSampleOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSampleByDataIdWithHttpInfo
public ApiClient.ApiResponse<GetSampleOutputV1> getSampleByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure) throws ApiException Get a sample from a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)- Throws:
ApiException
- if fails to make API call
-
getSampleByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetSampleOutputV1> getSampleByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, String key, String lookup, String keyUnitOfMeasure, String valueUnitOfMeasure, Map<String, String> customHeaders) throws ApiExceptionGet a sample from a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)key
- The key in the signal where the sample should be retrieved (required)lookup
- Where to look for a sample relative to the specified key. The options are Interpolate, Before, AtOrBefore, At, AtOrAfter, After (optional, default to Interpolate)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSamples
public GetSamplesOutputV1 getSamples(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) throws ApiException Get samples from a signal over an interval- Parameters:
id
- The Seeq ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)- Returns:
- GetSamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSamplesWithHttpInfo
public ApiClient.ApiResponse<GetSamplesOutputV1> getSamplesWithHttpInfo(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) throws ApiException Get samples from a signal over an interval- Parameters:
id
- The Seeq ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)- Throws:
ApiException
- if fails to make API call
-
getSamplesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetSamplesOutputV1> getSamplesWithHeadersAndHttpInfo(String id, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet samples from a signal over an interval- Parameters:
id
- The Seeq ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSamplesByDataId
public GetSamplesOutputV1 getSamplesByDataId(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) throws ApiException Get samples from a signal over an interval, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)- Returns:
- GetSamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSamplesByDataIdWithHttpInfo
public ApiClient.ApiResponse<GetSamplesOutputV1> getSamplesByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit) throws ApiException Get samples from a signal over an interval, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)- Throws:
ApiException
- if fails to make API call
-
getSamplesByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetSamplesOutputV1> getSamplesByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, String start, String end, String period, Boolean inflate, String boundaryValues, String keyUnitOfMeasure, String valueUnitOfMeasure, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet samples from a signal over an interval, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)start
- The key at the start of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)end
- The key at the end of the query interval. The contents vary based on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) series: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\". (required)period
- To resample the signal to an evenly-spaced grid, provide the desired resampling period. The default does not perform resampling. (optional, default to 0)inflate
- Whether to inflate the resulting signal. Inflation adds samples that may not be present in the source historian in two cases. Signals with step discontinuities will have an extra sample at each discontinuity. Also, gaps wider than Max Interpolation will be marked explicitly by invalid values. An inflated signal can be plotted by connecting adjacent samples with straight lines, without needing to consider the signal's interpolation method. (optional, default to false)boundaryValues
- Choice for handling samples near the start and end of the query interval. The options are Outside, Inclusive, and Interpolate. (optional, default to Outside)keyUnitOfMeasure
- Units to use for the key of each sample. The default does no unit conversion. For time-series, the default is ISO 8601 timestamps, e.g. '2016-01-01T19:51:32.490Z'. (optional)valueUnitOfMeasure
- Units to use for the value of each sample. The default does no unit conversion. (optional)offset
- The pagination offset, the index of the first sample that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of samples that will be returned in this page of results (optional, default to 1000)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSignal
Get signal- Parameters:
id
- The Seeq ID for the signal (required)- Returns:
- SignalOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSignalWithHttpInfo
Get signal- Parameters:
id
- The Seeq ID for the signal (required)- Throws:
ApiException
- if fails to make API call
-
getSignalWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> getSignalWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet signal- Parameters:
id
- The Seeq ID for the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSignalByDataId
public SignalOutputV1 getSignalByDataId(String datasourceClass, String datasourceId, String dataId) throws ApiException Get a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)- Returns:
- SignalOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSignalByDataIdWithHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> getSignalByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId) throws ApiException Get a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)- Throws:
ApiException
- if fails to make API call
-
getSignalByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> getSignalByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, Map<String, String> customHeaders) throws ApiExceptionGet a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getSignals
List signals- Parameters:
offset
- The pagination offset, the index of the first signal that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of signals that will be returned in this page of results (optional, default to 40)- Returns:
- GetSignalsOutputV1
- Throws:
ApiException
- if fails to make API call
-
getSignalsWithHttpInfo
public ApiClient.ApiResponse<GetSignalsOutputV1> getSignalsWithHttpInfo(Integer offset, Integer limit) throws ApiException List signals- Parameters:
offset
- The pagination offset, the index of the first signal that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of signals that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getSignalsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetSignalsOutputV1> getSignalsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionList signals- Parameters:
offset
- The pagination offset, the index of the first signal that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of signals that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putSamples
Replace any samples to a signal in the same time range- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)- Returns:
- SamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
putSamplesWithHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> putSamplesWithHttpInfo(String id, SamplesOverwriteInputV1 body) throws ApiException Replace any samples to a signal in the same time range- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)- Throws:
ApiException
- if fails to make API call
-
putSamplesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> putSamplesWithHeadersAndHttpInfo(String id, SamplesOverwriteInputV1 body, Map<String, String> customHeaders) throws ApiExceptionReplace any samples to a signal in the same time range- Parameters:
id
- The Seeq ID for the signal (required)body
- Data to be added to the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putSamplesByDataId
public SamplesOutputV1 putSamplesByDataId(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body) throws ApiException Replace any samples to a signal in the same time range, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)- Returns:
- SamplesOutputV1
- Throws:
ApiException
- if fails to make API call
-
putSamplesByDataIdWithHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> putSamplesByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body) throws ApiException Replace any samples to a signal in the same time range, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)- Throws:
ApiException
- if fails to make API call
-
putSamplesByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SamplesOutputV1> putSamplesByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, SamplesOverwriteInputV1 body, Map<String, String> customHeaders) throws ApiExceptionReplace any samples to a signal in the same time range, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- Data to be added to the signal (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putSignal
Update a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- (required)- Returns:
- SignalOutputV1
- Throws:
ApiException
- if fails to make API call
-
putSignalWithHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> putSignalWithHttpInfo(String id, SignalInputV1 body) throws ApiException Update a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
putSignalWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> putSignalWithHeadersAndHttpInfo(String id, SignalInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate a signal- Parameters:
id
- The Seeq ID for the signal (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putSignalByDataId
public SignalOutputV1 putSignalByDataId(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body) throws ApiException Create or update a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- (required)- Returns:
- SignalOutputV1
- Throws:
ApiException
- if fails to make API call
-
putSignalByDataIdWithHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> putSignalByDataIdWithHttpInfo(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body) throws ApiException Create or update a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
putSignalByDataIdWithHeadersAndHttpInfo
public ApiClient.ApiResponse<SignalOutputV1> putSignalByDataIdWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, String dataId, SignalInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update a signal, using the source system's identifier- Parameters:
datasourceClass
- The class of the datasource containing the signal (required)datasourceId
- The ID of the datasource containing the signal (required)dataId
- The Data ID for the signal (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putSignals
Create or update multiple signals- Parameters:
body
- (required)- Returns:
- ItemBatchOutputV1
- Throws:
ApiException
- if fails to make API call
-
putSignalsWithHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putSignalsWithHttpInfo(PutSignalsInputV1 body) throws ApiException Create or update multiple signals- Parameters:
body
- (required)- Throws:
ApiException
- if fails to make API call
-
putSignalsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putSignalsWithHeadersAndHttpInfo(PutSignalsInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update multiple signals- Parameters:
body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-