/rest-service/reviews-v1/{id}/comments/{cId}/markAsRead

Mark the given comment as read for the user used to make this POST.

/rest-service/reviews-v1/{id}/transitions

Get a list of the actions which the current user can perform on this review, given its current state and the user's permissions.

/rest-service/reviews-v1/{id}/comments/versioned

• render (query) — indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a element containing the wiki rendered html.

/rest-service/reviews-v1/{id}/comments/{cId}

Deletes the given comment.

/rest-service/reviews-v1/details

Retrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The wiki rendered comments will be available via the element

• state (query) — the review states to match.

/rest-service/reviews-v1/{id}/comments/{cId}

Gets the given comment.

• render (query) — true if the wiki text should be rendered into html, into the field .

/rest-service/reviews-v1/{id}/comments/{cId}

Updates the comment given by the perma id to the new comment posted.

/rest-service/reviews-v1/{id}/comments/general

• render (query) — indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a element containing the wiki rendered html.

/rest-service/reviews-v1/{id}/comments/markAllAsRead

For the effective user, mark all comments in a review as read (except those marked as leave unread).

/rest-service/auth-v1/login

Get the user authentication token. This is a legacy version of the login request. Using GET is deprecated as your password is likely to appear in logs which record request URLs. Use the POST version instead.

• userName (query) — the username of the user to get the token for
• password (query) — the password for the user to get the token for

/rest-service/auth-v1/login

Get the user authentication token.

/rest-service/projects-v1

Get the list of projects that the authenticated user is entitled to access.

• excludeAllowedReviewers (query) — if set to true, user data (e.g. allowedReviewers) which is expensive to compute, will not be included in the response data. Defaults to false so allowedReviewers are included in the response.

/rest-service/projects-v1/{key}

Returns a project description.

• excludeAllowedReviewers (query)

/rest-service/repositories-v1

Returns a list of all repositories. This includes plugin provided repositories

• name (query) — filter repositories by the repository key, only repositories of keys containing this value would be returned if value was provided. Case insensitive.
• enabled (query) — filter repositories by enabled flag. Only enabled/disabled repositories would be returned accordingly if value was provided.
• available (query) — filter repositories by its availability. Only available/unavailable repositories would be returned accordingly if value was provided.
• type (query) — filter repositories by type. Allowed values: cvs, svn, p4, git, hg, plugin (for light SCM repositories). Parameter can be specified more than once.
• limit (query, limit) — maximum number of repositories to be returned.

/rest-service/repositories-v1/browse/{repository}/{path}

Lists the contents of the specified directory.

/rest-service/repositories-v1/change/{repository}/{revision}

Represents a particular changeset.

/rest-service/repositories-v1/changes/{repository}/{path}

Represents a sorted list of changesets, newest first.

• oldestCsid (query) — only return change sets after this change set. If omitted there is no restriction.
• includeOldest (query) — include the change set with id "from" in the change sets returned.
• newestCsid (query) — only return change sets before this change set. If omitted there is no restriction.
• includeNewest (query) — include the change set with id "to" in the change sets returned.
• max (query) — return only the newest change sets, to a maximum of maxChangesets.

/rest-service/repositories-v1/content/{repository}/{revision}/{path}

Returns the raw content of the specified file revision as a binary stream. No attempt is made to identify the content type and no mime type is provided.

/rest-service/repositories-v1/history/{repository}/{revision}/{path}

Represents the history of a versioned entity.

/rest-service/repositories-v1/{repository}

/rest-service/repositories-v1/{repository}/svn

For backward compatibility we provide this method, but repositories should be referred to just by their key.

/rest-service/repositories-v1/{repository}/{revision}/{path}

/rest-service/reviews-v1

• state (query) — only return reviews that are in these states.

/rest-service/reviews-v1

/rest-service/reviews-v1/{id}/comments/{cId}/markAsLeaveUnread

Marks the comment as leave unread to the current user - it will not automatically be marked as read by crucible.

/rest-service/reviews-v1/filter

To ignore a property, omit it from the query string.

• title (query) — a string that will be searched for in review titles.
• author (query) — reviews authored by this user.
• moderator (query) — reviews moderated by this user.
• creator (query) — reviews created by this user.
• states (query) — comma-separated list of amy of the following strings: (Draft, Approval, Review, Summarize, Closed, Dead, Rejected, Unknown).
• reviewer (query) — reviews reviewed by this user.
• orRoles (query) — whether the value of , , and should be OR'd () or AND'd () together.
• complete (query) — reviews that the specified reviewer has completed.
• allReviewersComplete (query) — Reviews that all reviewers have completed.
• project (query) — reviews for the specified project.
• fromDate (query) — reviews with last activity date after the specified timestamp, in milliseconds. Inclusive.
• toDate (query) — reviews with last activity date before the specified timestamp, in milliseconds. Inclusive.

/rest-service/reviews-v1/filter

This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.

/rest-service/reviews-v1/filter/details

To ignore a property, omit it from the query string.

• title (query) — a string that will be searched for in review titles.
• author (query) — reviews authored by this user.
• moderator (query) — reviews moderated by this user.
• creator (query) — reviews created by this user.
• states (query) — comma-separated list of amy of the following strings: (Draft, Approval, Review, Summarize, Closed, Dead, Rejected, Unknown).
• reviewer (query) — reviews reviewed by this user.
• orRoles (query) — whether the value of , , and should be OR'd () or AND'd () together.
• complete (query) — reviews that the specified reviewer has completed.
• allReviewersComplete (query) — Reviews that all reviewers have completed.
• project (query) — reviews for the specified project.
• fromDate (query) — reviews with last activity date after the specified timestamp, in milliseconds. Inclusive.
• toDate (query) — reviews with last activity date before the specified timestamp, in milliseconds. Inclusive.

/rest-service/reviews-v1/filter/details

This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.

/rest-service/reviews-v1/filter/{filter}

Get all the reviews which match the given filter, for the current user.

/rest-service/reviews-v1/filter/{filter}/details

Gets a list of all the reviews that match the specified filter criteria.

/rest-service/reviews-v1/metrics/{version}

Get comment metrics metadata for the specified metrics version.

/rest-service/reviews-v1/search/{repository}

Return a list of Reviews which include a particular file.

• path (query) — path to find in reviews

/rest-service/reviews-v1/search/{repository}/details

Return a list of Reviews which include a particular file.

• path (query) — path to find in reviews.

/rest-service/reviews-v1/versionInfo

Returns Crucible version information.

/rest-service/reviews-v1/{id}

Permanently deletes the specified review. The review must have been abandoned.

/rest-service/reviews-v1/{id}

Get a single review by its permId (e.g. "CR-45"). If the review does not exist, a 404 is returned. The moderator element may not exist if the review does not have a Moderator.

/rest-service/reviews-v1/{id}/actions

Get a list of the actions which the current user is allowed to perform on the review.

/rest-service/reviews-v1/{id}/addChangeset

/rest-service/reviews-v1/{id}/addFile

/rest-service/reviews-v1/{id}/addPatch

Old, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch

/rest-service/reviews-v1/{id}/close

Closes the given review with the summary given.

/rest-service/reviews-v1/{id}/comments

Return all the comments visible to the requesting user for the review.

• render (query) — indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a element containing the wiki rendered html.

/rest-service/reviews-v1/{id}/comments

Add a general comment to the review.

/rest-service/reviews-v1/{id}/comments/{cId}/replies

Gets the replies to the given comment.

• render (query) — true if the comments should also be rendered into html, into the element

/rest-service/reviews-v1/{id}/comments/{cId}/replies

Adds a reply to the given comment. This call includes the repsonse header that contains the URL of the newly created entity.

/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}

Deletes the reply.

/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}

Updates a reply with the given newComment.

/rest-service/reviews-v1/{id}/complete

Completes the review for the current user

• ignoreWarnings (query) — if {@code ignoreWarnings==true} then condition failure warnings will be ignored

/rest-service/reviews-v1/{id}/details

Returns the specified review.

/rest-service/reviews-v1/{id}/patch

Get a list of patches and their details for the given review

/rest-service/reviews-v1/{id}/patch

Add the revisions in a patch to an existing review.

/rest-service/reviews-v1/{id}/patch/{patchId}

Removes the patch with the given id from the review. All of the revisions provided by the patch will be removed as well.

/rest-service/reviews-v1/{id}/publish

Publishes all the draft comments of the current user.

/rest-service/reviews-v1/{id}/publish/{cId}

publishes the given draft comment.

/rest-service/reviews-v1/{id}/remind

Immediately send a reminder to incomplete reviewers about the given review.

/rest-service/reviews-v1/{id}/reviewers

Get a list of reviewers in the review given by the permaid id.

/rest-service/reviews-v1/{id}/reviewers

Adds the given list of reviewers to the review.

/rest-service/reviews-v1/{id}/reviewers/completed

Gets a list of completed reviewers.

/rest-service/reviews-v1/{id}/reviewers/uncompleted

Gets a list of reviewers that have not completed the review.

/rest-service/reviews-v1/{id}/reviewers/{username}

Removes the reviewer from the review.

/rest-service/reviews-v1/{id}/reviewitems

Returns a list of all the items in a review.

/rest-service/reviews-v1/{id}/reviewitems

Add the changes between two files in a fisheye repository to the review.

/rest-service/reviews-v1/{id}/reviewitems/details

Adds the given review item to the review. This will always create a new review item, even if there is an existing one with the same data in the review (in which case the existing item will be replaced).

/rest-service/reviews-v1/{id}/reviewitems/revisions

Adds a review item for each of the supplied crucibleRevisionData elements.

/rest-service/reviews-v1/{id}/reviewitems/{riId}

Removes an item from a review.

/rest-service/reviews-v1/{id}/reviewitems/{riId}

Returns detailed information for a specific review item.

/rest-service/reviews-v1/{id}/reviewitems/{riId}/comments

• render (query) — indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a element containing the wiki rendered html.

/rest-service/reviews-v1/{id}/reviewitems/{riId}/comments

This call includes the repsonse header that contains the URL of the newly created entity.

/rest-service/reviews-v1/{id}/reviewitems/{riId}/details

Sets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only perform this operation if the old review item specified by itemId can be deleted. The old review item's permId is not changed.

/rest-service/reviews-v1/{id}/reviewitems/{riId}/revisions

Removes the revisions given from the review item in the review specified by the id. If the review item has no more revisions left, it is automatically deleted.

/rest-service/reviews-v1/{id}/reviewitems/{riId}/revisions

Adds the given list of revisions to the supplied review item, merging if required. For example, if the review item for contains revisions 3 to 6, and if:

/rest-service/reviews-v1/{id}/transition

Change the state of a review by performing an action on it.

• action (query) — the string representation of the action to perform. Valid actions are: Note:
• ignoreWarnings (query) — if then condition failure warnings will be ignored

/rest-service/reviews-v1/{id}/uncomplete

Uncompletes the review for the current user.

• ignoreWarnings (query) — if {@code ignoreWarnings==true} then condition failure warnings will be ignored

/rest-service/search-v1/reviews

Search for reviews where the name, description, state or permaId contain the specified term.

• term (query) — a search term.
• maxReturn (query) — the maximum number of reviews to return.

/rest-service/search-v1/reviewsForIssue

Get a list of all reviews that have been linked to the specified JIRA issue key.

• jiraKey (query) — a Jira issue key (e.g. "FOO-3453")
• maxReturn (query) — the maximum number of reviews to return.

/rest-service/users-v1

Get a list of all the users. You can also ask for a set of users.

• username (query) — a username (or a few) to limit the number of returned entries. It will return only existing users.

/rest-service/users-v1/{repository}/{username}

Returns the user details of the user mapped to a committer in a repository.

/rest-service/users-v1/{username}

Returns the user's profile details.