cases¶
Manage cases and events associated with cases.
cases [OPTIONS] COMMAND [ARGS]...
create¶
Create a new case.
cases create [OPTIONS] NAME
Options
-
--assignee
<assignee>
¶ The UID of the user to assign to the case.
-
--description
<description>
¶ The description of the case.
-
--findings
<findings>
¶ Any findings for the case.
-
--subject
<subject>
¶ The user UID of the subject of the case.
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
Arguments
-
NAME
¶
Required argument
export¶
Download a case detail summary as a PDF file at the given path with name <case_number>_case_summary.pdf.
cases export [OPTIONS] CASE_NUMBER
Options
-
--path
<path>
¶ The file path where to save the PDF. Defaults to the current directory.
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
Arguments
-
CASE_NUMBER
¶
Required argument
file-events¶
Fetch file events associated with the case.
cases file-events [OPTIONS] COMMAND [ARGS]...
Options
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
add¶
Associate a file event to a case, by event ID.
cases file-events add [OPTIONS]
Options
-
--case-number
<case_number>
¶ Required The number assigned to the case.
-
--event-id
<event_id>
¶ Required The file event ID associated with the case.
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
bulk¶
Tools for executing bulk case file-event actions.
cases file-events bulk [OPTIONS] COMMAND [ARGS]...
add¶
Bulk associate file events to cases using a CSV file with format: number,event_id.
cases file-events bulk add [OPTIONS] CSV_FILE
Options
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
Arguments
-
CSV_FILE
¶
Required argument
generate-template¶
Generate the CSV template needed for bulk adding/removing users.
cases file-events bulk generate-template [OPTIONS] [add|remove]
Options
-
-p
,
--path
<path>
¶ Write template file to specific file path/name.
Arguments
-
CMD
¶
Required argument
remove¶
Bulk remove the file event association from cases using a CSV file with format: number,event_id.
cases file-events bulk remove [OPTIONS] CSV_FILE
Options
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
Arguments
-
CSV_FILE
¶
Required argument
list¶
List all the file events associated with the case.
cases file-events list [OPTIONS] CASE_NUMBER
Options
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
-
-f
,
--format
<format>
¶ The output format of the result. Defaults to table format.
Options: TABLE|CSV|JSON|RAW-JSON
Arguments
-
CASE_NUMBER
¶
Required argument
remove¶
Remove the associated file event from the case, by event ID.
cases file-events remove [OPTIONS]
Options
-
--case-number
<case_number>
¶ Required The number assigned to the case.
-
--event-id
<event_id>
¶ Required The file event ID associated with the case.
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
list¶
List all the cases.
cases list [OPTIONS]
Options
-
--name
<name>
¶ Filter by name of a case. Supports partial name matches.
-
--subject
<subject>
¶ Filter by the user UID of the subject of a case.
-
--assignee
<assignee>
¶ Filter by the user UID of an assignee.
-
--begin-create-time
<begin_create_time>
¶ The beginning of the date range in which to look for cases. Accepts a date/time in yyyy-MM-dd (UTC) or yyyy-MM-dd HH:MM:SS (UTC+24-hr time) format where the ‘time’ portion of the string can be partial (e.g. ‘2020-01-01 12’ or ‘2020-01-01 01:15’) or a ‘short time’ value representing days (30d), hours (24h) or minutes (15m) from the current time.
-
--end-create-time
<end_create_time>
¶ The end of the date range in which to look for cases, argument format options are the same as –begin.
-
--begin-update-time
<begin_update_time>
¶ The beginning of the date range in which to look for cases. Accepts a date/time in yyyy-MM-dd (UTC) or yyyy-MM-dd HH:MM:SS (UTC+24-hr time) format where the ‘time’ portion of the string can be partial (e.g. ‘2020-01-01 12’ or ‘2020-01-01 01:15’) or a ‘short time’ value representing days (30d), hours (24h) or minutes (15m) from the current time.
-
--end-update-time
<end_update_time>
¶ The end of the date range in which to look for cases, argument format options are the same as –begin.
-
--status
<status>
¶ Filter cases by case status.
-
-f
,
--format
<format>
¶ The output format of the result. Defaults to table format.
Options: TABLE|CSV|JSON|RAW-JSON
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
show¶
Show case details.
cases show [OPTIONS] CASE_NUMBER
Options
-
--include-file-events
¶
View file events associated to the case.
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
-
-f
,
--format
<format>
¶ The output format of the result. Defaults to table format.
Options: TABLE|CSV|JSON|RAW-JSON
Arguments
-
CASE_NUMBER
¶
Required argument
update¶
Update case details for the given case.
cases update [OPTIONS] CASE_NUMBER
Options
-
--name
<name>
¶ The name of the case.
-
--assignee
<assignee>
¶ The UID of the user to assign to the case.
-
--description
<description>
¶ The description of the case.
-
--findings
<findings>
¶ Any findings for the case.
-
--subject
<subject>
¶ The user UID of the subject of the case.
-
--status
<status>
¶ Status of the case. OPEN or CLOSED.
Options: CLOSED|OPEN
-
-d
,
--debug
¶
Turn on debug logging.
-
--totp
<totp>
¶ TOTP token for multi-factor authentication.
-
--profile
<profile>
¶ The name of the Code42 CLI profile to use when executing this command.
Arguments
-
CASE_NUMBER
¶
Required argument