c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 c8y(1) — bestie's field guide to c8y-events-update 🌸

okay so real talk: this is the c8y(1) manual, and today's main character is the update-event command. she edits stuff. she slays. let's go 💅

✨ NAME ✨

c8y-events-update — literally updates an event. that's it, that's the whole vibe 🦋

🎀 SYNOPSIS 🎀

c8y events update [flags]

💖 DESCRIPTION 💖

Updates an event that already exists. not creating a new one, bestie — we're editing the one you already have. glow-up energy only ✨

👑 OPTIONS 👑

  • -d, --data=[] — static data you wanna slap onto the body. takes json or shorthand json, like --data 'value1=1,my.nested.value=100' (yes the shorthand is a whole vibe, use it)
  • -h, --help[=false] — help for update. when in doubt, ask for help, it's not a weakness it's self-care 🫶
  • --id=[] — Event id. required, bestie, no id no update. also accepts pipeline 🚰
  • --processingMode="" — Cumulocity processing mode
  • --template="" — body template
  • --templateVars=[] — body template variables
  • --text="" — text description of the event

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

these are the hand-me-downs from the parent command and honestly they ate 💀

  • --abortOnErrors=10 — aborts the batch when it hits the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when piped input (stdin) is empty. the chill option
  • --cache[=false] — enables cached responses
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty means 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 the output is the terminal (aesthetic first, always 💅)
  • --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. chaos mode, but make it informative 🔥
  • --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 (window shopping, essentially 🛍️)
  • --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 the 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 a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! 👀 this is not a drill)
  • --noAccept[=false] — ignore the Accept header, which 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 the cache setting)
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console (monochrome era, we don't love it but ok)
  • --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 a file (after select/view)
  • --outputFileRaw="" — save the raw response to a 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 the 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 events update --id 12345 --text "example text 1"
Update the text field of an existing event

that one updates the text field of an existing event, iconically ✨

$ c8y events update --id 12345 --data "{\"my_event\":{\"active\": true }}"
Update custom properties of an existing event

and that one updates custom properties of an existing event. custom properties, custom era 🦋

🌈 SEE ALSO 🌈

  • c8y-events(1) — go hang out with the rest of the events family, they're all iconic
ngl bestie, the --id flag is required — don't come crying to me when it yells at you 😭

okay that's the whole page!! this was c8y(1), served up from the Jan 1980 edition of the source — yes, she's vintage, she's timeless, she's a little bit of a time traveler 🕰️💖 now go update some events. periodt. 🎀

📦 where this page comes from