ccollab admin review edit

Applies to Collaborator 14.5, last modified on March 26, 2024

Description

The ccollab admin review edit command modifies an existing review on the Collaborator server.

Command Line Syntax

ccollab [global-options] admin review edit <review> [--custom-field <value> [<value> ...]] [--deadline <value>] [--display-changelists-as <value>] [--group <value>] [--participant-custom-field <value> [<value> ...]] [--restrict-access <value>] [--template <value>] [--title <value>]

Command Options

Option

Required?

Description

<review>

Yes

Identifier of the desired review (an integer number), or an ask, or last keyword. Where keywords define the following behaviour:

  • ask - the command will pause execution and prompt for the identifier of the desired review,
  • last - the command will use the last review that was created on the current machine via Command-Line Client (that is, it does not know about reviews created elsewhere).

--custom-field <value> [<value> ...]

No

Setting for custom fields, in the form field-name=field-value. (For example, "Overview=this is the overview")

For multi-line fields, use \n for line breaks: "Overview=This is line 1.\nThis is line 2."

For drop-down series and multi-select list fields, use | as value separators: "Product area=Order Form|Start Screen|API|Reporting"

--deadline <value>

No

Deadline in the format 'yyyy-MM-dd'

--display-changelists-as <value>

No

Default to showing changelists rolled up('single') or individually('distinct')

--group <value>

No

Guid of the group to specify

--participant-custom-field <value> [<value> ...]

No

Setting for participant custom fields, in the form field-name=field-value

--restrict-access <value>

No

Restrict Access (anyone/group/participants/group-and-participants/group-or-participants)

--template <value>

No

Number of template ID. Default is 1.

--title <value>

No

Title of the review.

Remarks

  • When setting custom fields you have to specify the review argument first.

Examples

ccollab admin review edit "last" --custom-field "Overview=this is the overview"

ccollab admin review edit "last" --custom-field "Overview=This is line1.\nThis is line2."

ccollab admin review edit "last" --custom-field "Product area=Order Form|Start Screen|API|Reporting"

ccollab admin review edit 123 --deadline 2015-06-15

ccollab admin review edit 123 --restrict-access participants

See Also

ccollab admin review

Highlight search results