Sensor refresh request

Description

This operation provides SensorAttribute time series data by fetching data from associated monitoring provider.
 It performs a topological sort on Sensors and for each level of the topological sort it groups sensors by provider and invokes bulkRefreshSensors operation implemented by monitoring providers.
 The sensors parameter expects one or more Sensor objects. Each Sensor object describes the SensorAttribute that needs to be refreshed. Each SensorAttribute describes the AttributeValueTimeSeries data that should be returned from refreshing the SensorAttribute.
 Each Sensor will have the CloudObject that it is attached to.
 For AttributeValueTimeSeries, startTimestamp will be defined by the timestamps0 and endTimestamp is defined by timestamp1.
 If both the startTimestamp and endTimestamp are both null, then it is assumed that only the most current datapoint is returned for a SensorAttribute given the SummarizationPeriod and StatisticalModifier.
 If the startTimestamp is non-null, but the endTimestamp is null, then the time series data returned for a SensorAttribute starts on or after the startTimestamp and ends on or before the "current" timestamp relative to the monitoring provider.
 If the startTimestamp and the endTimestamp are both non-null, then the time series data returned for a SensorAttribute starts on or after the startTimestamp and ends on or before the endTimestamp.

API stability classification

Unstable

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/Sensor/refresh	Sensor	1..*

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline.

Name	Type	Multi- plicity	Description
callbackURL	String	0..1	URL to call when the operation finishes
postCallout	String	0..1	Identifier of a callout to run after the operation executes
preCallout	String	0..1	Identifier of a callout to run before the operation executes
timeout	Integer	0..1	Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.

The [confluence_table-plus] macro is a standalone macro and it cannot be used inline.

Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline.

Name	Type	Multi- plicity	Description
sensors	Sensor	1..*

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.