c8y(1)

🎀 NAME 🎀

bestie, welcome to the c8y(1) manual page for c8y-measurements-list — Get measurement collection. that's the name, that's the vibe, and it's literally giving "we're getting measurements" ✨

✨ SYNOPSIS ✨

c8y measurements list [flags]

lowkey the whole move: c8y measurements list plus whatever flags you need, bestie 💅

💜 DESCRIPTION 💜

okay so this command gets a collection of measurements based on filter parameters. that's the description, that's the energy, and it is serving filter-something-and-get-measurements realness fr fr 🦋

💅 OPTIONS 💅

• --csvFormat[=false] — Results will be displayed in csv format. Note: -IncludeAll, is not supported when using using this parameter. csv spreadsheet bestie, but mind that note 🍓
• --dateFrom="" — Start date or date and time of measurement occurrence. set the start of the measurement window, no cap ✨
• --dateTo="" — End date or date and time of measurement occurrence. close the window, bestie 🎀
• --device=[] — Device ID (accepts pipeline). yes, it accepts a pipeline — slay 🔥
• --excelFormat[=false] — Results will be displayed in Excel format Note: -IncludeAll, is not supported when using using this parameter. Excel girlies get the same heads-up 🧚
• -h, --help[=false] — help for list. the classic halp button, iconic 🫶
• --revert[=false] — Return the newest instead of the oldest measurements. Must be used with dateFrom and dateTo parameters. By default, the results are sorted by the newest measurements first for time series and by the oldest first for legacy measurements. flip the order, but only with dateFrom + dateTo — periodt 💀
• --type="" — Measurement type. pick the measurement type, bestie 🌸
• --unit="" — Every measurement fragment which contains 'unit' property will be transformed to use required system of units. unit girlies get transformed, okay? 💜
• --valueFragmentSeries="" — value fragment series. literally the value fragment series 💅
• --valueFragmentType="" — value fragment type. yep, the value fragment type ✨

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

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

🌈 EXAMPLE 🌈

$ c8y measurements list
Get a list of measurements

$ c8y measurements list --dateFrom -1d --revert=false
Get a list of measurements from the last day, showing the oldest first

these examples ate, honestly 👑

🦋 SEE ALSO 🦋

c8y-measurements(1) — go see the parent page, bestie. that's the whole see-also, no cap 🦋

okay that's the whole page! this is the c8y(1) manual, dated Jan 1980 — that's the source/version + date sign-off, mwah 💋✨