Description
Use this command to create a new defect on a review. You can specify various options to control the type and location where the defect is created.
Overall: (default - no extra options necessary)
Label: --label <label>
Line: --line-number <number>
Coordinate: --page <number> --x <number> --y <number>
Cell: --cell <cell reference>
To specify an existing conversation in a file, it is best to specify --conversation-id <id> to disambiguate situations where there is more than one conversation at a particular location.
To learn about different types of defects, see Types of Review Comments and Defects.
Command Line Syntax
ccollab [global-options] admin review defect create [--cell <value>] [--conversation-id <value>] [--custom-field <value> [<value> ...]] [--label <value>] [--line-number <value>] [--page <value> --x <value> --y <value>] [--file <value>] [--version <value>] <review> <comment>
Command Options
|
Option |
Required? |
Description |
|---|---|---|
|
No |
Cell reference in a "Sheet1!A1" format |
|
|
No |
ID of the first Comment in an existing Conversation |
|
|
Yes |
Setting for custom fields, in the form field-name=field-value. (for example, "Severity=Major" "Type=Text") The "Severity" and "Type" custom fields are mandatory, other custom fields (if any) are optional. |
|
|
No |
Label |
|
|
No |
Line number in file |
|
|
No |
Path of file in Review Either --file or --version option can be specified. |
|
|
No |
Version ID of file in Review Either --file or --version option can be specified. |
|
|
No |
Page number Use with the --x and --y options. |
|
|
No |
X coordinate Use with the --page and --y options. |
|
|
No |
Y coordinate Use with the --page and --x options. |
|
|
Yes |
Must be either an integer review-id, 'ask', or 'last' |
|
|
Yes |
The description of the defect. |
Examples
To create a defect in overall section of review #123:
ccollab admin review defect create 123 "overall review defect" --custom-field "Severity=Major" "Type=Text"
To create a defect in overall section of the bizbaz.java file in review #567:
ccollab admin review defect create 567 --file "bizbaz.java" "overall file defect" --custom-field "Severity=Major" "Type=Text"
To create a defect on line 36 of a file version with ID 789 in review #567:
ccollab admin review defect create 567 --version 789 --line-number 36 "defect on a line" --custom-field "Severity=Major" "Type=Text"
See Also
ccollab admin review defect
Review Chats, Comments, and Defects
Types of Review Comments and Defects