Parameter: envelope

Applies to

Applies to: latest

Applies to: history

Value

Boolean value, the default is false

Related

Parameter: after

When envelope=true, the response is as follows:

Applies to: latest

  • /latest results are returned in an envelope containing requestId, after and latest (data) properties.

Applies to: history

  • /timeseries results are returned in an envelope containing requestId, after and timeseries (data) properties.

Applies to: stream

  • /stream responses are always returned in an envelope, so this parameter does not apply to the /stream service.

Applies to: batch

  • /batchrun responses are always returned in an envelope, so this parameter does not apply to the /batchrun service.

Applies to: archive

  • /archive responses are always returned in an envelope, so this parameter does not apply to the /archive service.

Important: Note that new fields can be added to the response envelope in the future. The Consumer API can add new fields to the message envelope or message body at any time, and client applications must handle new fields gracefully.

Note: Use of the envelope parameter is strongly recommended, as the envelope contains the correctly calculated after value, used to request the next set of results. The envelope also contains a requestId, which should be logged to enable tracing of any issues on the REST API servers.

Note: When envelope=true is set in combination with format=CSV, the CSV contains an additional end column with heading "after". The last cell in the last row in the CSV response contains the after value used to obtain the next set of results.

Back to help overview