# Crucible ## API Docs - [/rest-service/auth-v1/login](https://lic0s105fb.apidog.io/api-3511313.md): Get the user authentication token. - [/rest-service/auth-v1/login](https://lic0s105fb.apidog.io/api-3511314.md): Get the user authentication token. - [/rest-service/projects-v1](https://lic0s105fb.apidog.io/api-3511315.md): Get the list of projects that the authenticated user is entitled to access. - [/rest-service/projects-v1/{key}](https://lic0s105fb.apidog.io/api-3511316.md): Returns a project description. - [/rest-service/repositories-v1](https://lic0s105fb.apidog.io/api-3511317.md): Returns a list of all repositories. This includes plugin provided repositories - [/rest-service/repositories-v1/browse/{repository}/{path}](https://lic0s105fb.apidog.io/api-3511318.md): Lists the contents of the specified directory. - [/rest-service/repositories-v1/change/{repository}/{revision}](https://lic0s105fb.apidog.io/api-3511319.md): Represents a particular changeset. - [/rest-service/repositories-v1/changes/{repository}/{path}](https://lic0s105fb.apidog.io/api-3511328.md): Represents a sorted list of changesets, newest first. - [/rest-service/repositories-v1/content/{repository}/{revision}/{path}](https://lic0s105fb.apidog.io/api-3511320.md): Returns the raw content of the specified file revision as a binary - [/rest-service/repositories-v1/history/{repository}/{revision}/{path}](https://lic0s105fb.apidog.io/api-3511321.md): Represents the history of a versioned entity. - [/rest-service/repositories-v1/{repository}](https://lic0s105fb.apidog.io/api-3511322.md): - [/rest-service/repositories-v1/{repository}/svn](https://lic0s105fb.apidog.io/api-3511323.md): For backward compatibility we provide this method, but repositories should be referred to just by their key. - [/rest-service/repositories-v1/{repository}/{revision}/{path}](https://lic0s105fb.apidog.io/api-3511325.md): - [/rest-service/reviews-v1](https://lic0s105fb.apidog.io/api-3511324.md): - [/rest-service/reviews-v1](https://lic0s105fb.apidog.io/api-3511330.md): - [/rest-service/reviews-v1/details](https://lic0s105fb.apidog.io/api-3511326.md): Retrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The - [/rest-service/reviews-v1/filter](https://lic0s105fb.apidog.io/api-3511327.md): To ignore a property, omit it from the query string. - [/rest-service/reviews-v1/filter](https://lic0s105fb.apidog.io/api-3511329.md): This method should no longer be used, as it uses a POST for a read-only - [/rest-service/reviews-v1/filter/details](https://lic0s105fb.apidog.io/api-3511331.md): To ignore a property, omit it from the query string. - [/rest-service/reviews-v1/filter/details](https://lic0s105fb.apidog.io/api-3511332.md): This method should no longer be used, as it uses a POST for a read-only - [/rest-service/reviews-v1/filter/{filter}](https://lic0s105fb.apidog.io/api-3511333.md): Get all the reviews which match the given filter, for the current user. - [/rest-service/reviews-v1/filter/{filter}/details](https://lic0s105fb.apidog.io/api-3511335.md): Gets a list of all the reviews that match the specified filter criteria. - [/rest-service/reviews-v1/metrics/{version}](https://lic0s105fb.apidog.io/api-3511334.md): Get comment metrics metadata for the specified metrics version. - [/rest-service/reviews-v1/search/{repository}](https://lic0s105fb.apidog.io/api-3511338.md): Return a list of Reviews which include a particular file. - [/rest-service/reviews-v1/search/{repository}/details](https://lic0s105fb.apidog.io/api-3511336.md): Return a list of Reviews which include a particular file. - [/rest-service/reviews-v1/versionInfo](https://lic0s105fb.apidog.io/api-3511337.md): Returns Crucible version information. - [/rest-service/reviews-v1/{id}](https://lic0s105fb.apidog.io/api-3511339.md): Permanently deletes the specified review. - [/rest-service/reviews-v1/{id}](https://lic0s105fb.apidog.io/api-3511340.md): Get a single review by its permId (e.g. "CR-45"). - [/rest-service/reviews-v1/{id}/actions](https://lic0s105fb.apidog.io/api-3511346.md): Get a list of the actions which the current user is allowed to perform - [/rest-service/reviews-v1/{id}/addChangeset](https://lic0s105fb.apidog.io/api-3511341.md): - [/rest-service/reviews-v1/{id}/addFile](https://lic0s105fb.apidog.io/api-3511343.md): - [/rest-service/reviews-v1/{id}/addPatch](https://lic0s105fb.apidog.io/api-3511342.md): Old, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch - [/rest-service/reviews-v1/{id}/close](https://lic0s105fb.apidog.io/api-3511344.md): Closes the given review with the summary given. - [/rest-service/reviews-v1/{id}/comments](https://lic0s105fb.apidog.io/api-3511347.md): Return all the comments visible to the requesting user for the review. - [/rest-service/reviews-v1/{id}/comments](https://lic0s105fb.apidog.io/api-3511348.md): Add a general comment to the review. - [/rest-service/reviews-v1/{id}/comments/general](https://lic0s105fb.apidog.io/api-3511345.md): - [/rest-service/reviews-v1/{id}/comments/markAllAsRead](https://lic0s105fb.apidog.io/api-3511350.md): For the effective user, mark all comments in a review as read (except - [/rest-service/reviews-v1/{id}/comments/versioned](https://lic0s105fb.apidog.io/api-3511349.md): - [/rest-service/reviews-v1/{id}/comments/{cId}](https://lic0s105fb.apidog.io/api-3511351.md): Deletes the given comment. - [/rest-service/reviews-v1/{id}/comments/{cId}](https://lic0s105fb.apidog.io/api-3511352.md): Gets the given comment. - [/rest-service/reviews-v1/{id}/comments/{cId}](https://lic0s105fb.apidog.io/api-3511353.md): Updates the comment given by the perma id to the new comment posted. - [/rest-service/reviews-v1/{id}/comments/{cId}/markAsLeaveUnread](https://lic0s105fb.apidog.io/api-3511354.md): Marks the comment as leave unread to the current user - it will not automatically be marked as read by crucible. - [/rest-service/reviews-v1/{id}/comments/{cId}/markAsRead](https://lic0s105fb.apidog.io/api-3511355.md): Mark the given comment as read for the user used to make this POST. - [/rest-service/reviews-v1/{id}/comments/{cId}/replies](https://lic0s105fb.apidog.io/api-3511356.md): Gets the replies to the given comment. - [/rest-service/reviews-v1/{id}/comments/{cId}/replies](https://lic0s105fb.apidog.io/api-3511357.md): Adds a reply to the given comment. This call includes the repsonse header that - [/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}](https://lic0s105fb.apidog.io/api-3511360.md): Deletes the reply. - [/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}](https://lic0s105fb.apidog.io/api-3511358.md): Updates a reply with the given newComment. - [/rest-service/reviews-v1/{id}/complete](https://lic0s105fb.apidog.io/api-3511359.md): Completes the review for the current user - [/rest-service/reviews-v1/{id}/details](https://lic0s105fb.apidog.io/api-3511363.md): Returns the specified review. - [/rest-service/reviews-v1/{id}/patch](https://lic0s105fb.apidog.io/api-3511362.md): Get a list of patches and their details for the given review - [/rest-service/reviews-v1/{id}/patch](https://lic0s105fb.apidog.io/api-3511361.md): Add the revisions in a patch to an existing review. - [/rest-service/reviews-v1/{id}/patch/{patchId}](https://lic0s105fb.apidog.io/api-3511364.md): 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](https://lic0s105fb.apidog.io/api-3511365.md): Publishes all the draft comments of the current user. - [/rest-service/reviews-v1/{id}/publish/{cId}](https://lic0s105fb.apidog.io/api-3511366.md): publishes the given draft comment. - [/rest-service/reviews-v1/{id}/remind](https://lic0s105fb.apidog.io/api-3511372.md): Immediately send a reminder to incomplete reviewers about the given review. - [/rest-service/reviews-v1/{id}/reviewers](https://lic0s105fb.apidog.io/api-3511368.md): Get a list of reviewers in the review given by the permaid id. - [/rest-service/reviews-v1/{id}/reviewers](https://lic0s105fb.apidog.io/api-3511367.md): Adds the given list of reviewers to the review. - [/rest-service/reviews-v1/{id}/reviewers/completed](https://lic0s105fb.apidog.io/api-3511369.md): Gets a list of completed reviewers. - [/rest-service/reviews-v1/{id}/reviewers/uncompleted](https://lic0s105fb.apidog.io/api-3511370.md): Gets a list of reviewers that have not completed the review. - [/rest-service/reviews-v1/{id}/reviewers/{username}](https://lic0s105fb.apidog.io/api-3511371.md): Removes the reviewer from the review. - [/rest-service/reviews-v1/{id}/reviewitems](https://lic0s105fb.apidog.io/api-3511373.md): Returns a list of all the items in a review. - [/rest-service/reviews-v1/{id}/reviewitems](https://lic0s105fb.apidog.io/api-3511374.md): Add the changes between two files in a fisheye repository to the review. - [/rest-service/reviews-v1/{id}/reviewitems/details](https://lic0s105fb.apidog.io/api-3511375.md): Adds the given review item to the review. This will always create a new review item, even if there is an existing - [/rest-service/reviews-v1/{id}/reviewitems/revisions](https://lic0s105fb.apidog.io/api-3511378.md): Adds a review item for each of the supplied crucibleRevisionData elements. - [/rest-service/reviews-v1/{id}/reviewitems/{riId}](https://lic0s105fb.apidog.io/api-3511380.md): Removes an item from a review. - [/rest-service/reviews-v1/{id}/reviewitems/{riId}](https://lic0s105fb.apidog.io/api-3511376.md): Returns detailed information for a specific review item. - [/rest-service/reviews-v1/{id}/reviewitems/{riId}/comments](https://lic0s105fb.apidog.io/api-3511377.md): - [/rest-service/reviews-v1/{id}/reviewitems/{riId}/comments](https://lic0s105fb.apidog.io/api-3511379.md): This call includes the repsonse header that contains the URL of the newly created entity. - [/rest-service/reviews-v1/{id}/reviewitems/{riId}/details](https://lic0s105fb.apidog.io/api-3511381.md): Sets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only - [/rest-service/reviews-v1/{id}/reviewitems/{riId}/revisions](https://lic0s105fb.apidog.io/api-3511382.md): Removes the revisions given from the review item in the review specified by the id. If the review item has no - [/rest-service/reviews-v1/{id}/reviewitems/{riId}/revisions](https://lic0s105fb.apidog.io/api-3511383.md): Adds the given list of revisions to the supplied review item, merging if required. For example, if the review - [/rest-service/reviews-v1/{id}/transition](https://lic0s105fb.apidog.io/api-3511384.md): Change the state of a review by performing an action on it. - [/rest-service/reviews-v1/{id}/transitions](https://lic0s105fb.apidog.io/api-3511385.md): Get a list of the actions which the current user can perform on this - [/rest-service/reviews-v1/{id}/uncomplete](https://lic0s105fb.apidog.io/api-3511386.md): Uncompletes the review for the current user. - [/rest-service/search-v1/reviews](https://lic0s105fb.apidog.io/api-3511387.md): Search for reviews where the name, description, state or permaId contain the specified term. - [/rest-service/search-v1/reviewsForIssue](https://lic0s105fb.apidog.io/api-3511388.md): Get a list of all reviews that have been linked to the specified JIRA issue key. - [/rest-service/users-v1](https://lic0s105fb.apidog.io/api-3511389.md): Get a list of all the users. You can also ask for a set of users. - [/rest-service/users-v1/{repository}/{username}](https://lic0s105fb.apidog.io/api-3511390.md): Returns the user details of the user mapped to a committer in a repository. - [/rest-service/users-v1/{username}](https://lic0s105fb.apidog.io/api-3511391.md): Returns the user's profile details.