c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

✨ c8y(1) β€” measurements getSeries ✨

okay so this is the c8y manual page for c8y measurements getSeries, and it's literally your bestie for pulling measurement series πŸ’– no cap.


πŸ’– NAME πŸ’–

c8y-measurements-getSeries β€” Get measurement series

bestie, this is the one that goes and gets the series. iconic behavior only.


πŸ¦‹ SYNOPSIS πŸ¦‹

c8y measurements getSeries [flags]

🌸 DESCRIPTION 🌸

Get a collection of measurements based on filter parameters.

that's the whole vibe: you give it filters, it gives you back a collection of measurements. slay.


πŸŽ€ OPTIONS πŸŽ€

  • --aggregationType="" β€” Fragment name from measurement.
  • --dateFrom="-7d" β€” Start date or date and time of measurement occurrence. Defaults to last 7 days.
  • --dateTo="0s" β€” End date or date and time of measurement occurrence. Defaults to the current time.
  • --device=[] β€” Device ID (accepts pipeline).
  • -h, --help[=false] β€” help for getSeries.
  • --series=[] β€” measurement type and series name, e.g. c8y_AccelerationMeasurement.acceleration.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the parent-command options that come along for the ride, bestie. all of them. every single one. πŸ’…

  • --abortOnErrors=10 β€” Abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] β€” Don't fail when piped input is empty (stdin).
  • --cache[=false] β€” Enable cached responses.
  • --cacheBodyPaths=[] β€” Cache should limit hashing of selected paths in the json body. Empty indicates all values.
  • --cacheTTL="60s" β€” Cache time-to-live (TTL) as a duration, i.e. 60s, 2m.
  • -c, --compact[=false] β€” Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal.
  • --confirm[=false] β€” Prompt for confirmation.
  • --confirmText="" β€” Custom confirmation text.
  • --currentPage=0 β€” Current page which should be returned.
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] β€” Set very verbose log messages.
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s.
  • --dry[=false] β€” Dry run. Don't send any data to the server.
  • --dryFormat="markdown" β€” Dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] β€” Show examples for the current command.
  • --filter=[] β€” Apply a client side filter to response before returning it to the user.
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation.
  • -f, --force[=false] β€” Do not prompt for confirmation. Ignored when using --confirm.
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] β€” Include all results by iterating through each page.
  • -k, --insecure[=false] β€” Allow insecure server connections when using SSL.
  • -l, --logMessage="" β€” Add custom message to the activity log.
  • --maxJobs=0 β€” Maximum number of jobs. 0 = unlimited (use with caution!).
  • --noAccept[=false] β€” Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] β€” Force disabling of cached responses (overwrites cache setting).
  • -M, --noColor[=false] β€” Don't use colors when displaying log entries on the console.
  • --noLog[=false] β€” Disables the activity log for the current command.
  • --noProgress[=false] β€” Disable progress bars.
  • --noProxy[=false] β€” Ignore the proxy settings.
  • -n, --nullInput[=false] β€” Don't read the input (stdin). Useful if using in shell for/while loops.
  • -o, --output="table" β€” Output format i.e. table, json, csv, csvheader.
  • --outputFile="" β€” Save JSON output to file (after select/view).
  • --outputFileRaw="" β€” Save raw response to file (before select/view).
  • --outputTemplate="" β€” jsonnet template to apply to the output.
  • -p, --pageSize=5 β€” Maximum results per page.
  • --progress[=false] β€” Show progress bar. This will also disable any other verbose output.
  • --proxy="" β€” Proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] β€” Show raw response. This mode will force output=json and view=off.
  • --retries=3 β€” Max number of attempts when a failed http call is encountered.
  • --select=[] β€” Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" β€” Session configuration.
  • --sessionMode="" β€” Override default session mode for a single command which would normally be disabled.
  • -P, --sessionPassword="" β€” Override session password.
  • -U, --sessionUsername="" β€” Override session username. i.e. peter or t1234/peter (with tenant).
  • --silentExit[=false] β€” Silent status codes do not affect the exit code.
  • --silentStatusCodes="" β€” Status codes which will not print out an error message.
  • --timeout="600s" β€” Request timeout duration, i.e. 60s, 2m.
  • --totalPages=0 β€” Total number of pages to get.
  • -v, --verbose[=false] β€” Verbose logging.
  • --view="auto" β€” Use views when displaying data on the terminal. Disable using --view off.
  • --withError[=false] β€” Errors will be printed on stdout instead of stderr.
  • --withTotalElements[=false] β€” Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13).
  • -t, --withTotalPages[=false] β€” Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 β€” Number of workers.

🌟 EXAMPLE 🌟

$ c8y measurements getSeries --device 12345 --series app_Weather.temperature --series app_Weather.barometer --dateFrom "-10min" --dateTo "0s"
Get a list of series [app_Weather.temperature] and [app_Weather.barometer] for device 12345

like, look at her go. getting a list of series [app_Weather.temperature] and [app_Weather.barometer] for device 12345. we love to see it. 🫢


πŸ‘‘ SEE ALSO πŸ‘‘

c8y-measurements(1)

go read the parent page too, iykyk. πŸ’œ


πŸ’… that's the whole page, bestie! this manual situation is from c8y(1), dated Jan 1980. periodt. πŸŽ€βœ¨
πŸ“¦ where this page comes from