Description
The ccollab admin find review command searches for reviews that contain specified data in review title, comments or custom fields.
Command Line Syntax
ccollab [global-options] admin find review <search-text> [--custom-fields] [--custom-field-name <value>] [--review-titles] [--user-comments] [--error-if-multiple] [--disable-pretty-print] [--error-if-none]
Command Options
|
Option |
Required? |
Description |
|---|---|---|
|
[global-options] |
No |
A number of global options. See Command-line Global Options Reference. |
|
Yes |
Text to search for. If the sought text fragment contains spaces, enclose it in quotes. |
|
|
No |
Search for text within custom fields. |
|
|
No |
Search for text only within the custom field with the specified name. |
|
|
No |
Search for text within review titles. |
|
|
No |
Search for text within user comments. |
|
|
No |
Whether to throw an exception if more than one match was found. |
|
|
No |
Disable pretty printing and print out just a comma-separated list of review IDs. |
|
|
No |
Whether to throw an exception if no results were found. |
Remarks
- By default, the command searches for the specified text in all possible locations (review titles, comments and custom fields). To limit search range to some particular location, use the --custom-fields, --review-titles, or --user-comments parameter.
- This command cannot retrieve data stored in custom fields that allow multiple values be selected simultaneously (Multi-Select List and Drop-Down List Series).
Examples
Find reviews that contain 'foo':
ccollab admin find review foo
Find reviews that contain 'foo' somewhere in comments:
ccollab admin find review foo --user-comments
Find reviews that have 'foo' in the 'Overview' custom field:
ccollab admin find review foo --custom-field-name=overview
Print a comma-separated list of reviews containing 'foo':
ccollab admin find review foo --disable-pretty-print