flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/login.js
OnStartup
-
OnClose
-

Attributes

-

loginPost

Get the user authentication token.

OnInit
./lib/actions/loginPost.js
OnStartup
-
OnClose
-

Attributes

-

getAllProjects

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

OnInit
./lib/actions/getAllProjects.js
OnStartup
-
OnClose
-

Attributes

-

getProject

Returns a project description.

OnInit
./lib/actions/getProject.js
OnStartup
-
OnClose
-

Attributes

-

getAllRepositories

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

OnInit
./lib/actions/getAllRepositories.js
OnStartup
-
OnClose
-

Attributes

-

browse

Lists the contents of the specified directory.

OnInit
./lib/actions/browse.js
OnStartup
-
OnClose
-

Attributes

-

change

Represents a particular changeset.

OnInit
./lib/actions/change.js
OnStartup
-
OnClose
-

Attributes

-

changes

Represents a sorted list of changesets, newest first.

OnInit
./lib/actions/changes.js
OnStartup
-
OnClose
-

Attributes

-

getContents

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.

OnInit
./lib/actions/getContents.js
OnStartup
-
OnClose
-

Attributes

-

history

Represents the history of a versioned entity.

OnInit
./lib/actions/history.js
OnStartup
-
OnClose
-

Attributes

-

getRepositoryDetails

OnInit
./lib/actions/getRepositoryDetails.js
OnStartup
-
OnClose
-

Attributes

-

getSvnRepositoryDetails

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

OnInit
./lib/actions/getSvnRepositoryDetails.js
OnStartup
-
OnClose
-

Attributes

-

details

OnInit
./lib/actions/details.js
OnStartup
-
OnClose
-

Attributes

-

getAllReviews

OnInit
./lib/actions/getAllReviews.js
OnStartup
-
OnClose
-

Attributes

-

createReview

OnInit
./lib/actions/createReview.js
OnStartup
-
OnClose
-

Attributes

-

getAllDetailedReviews

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

OnInit
./lib/actions/getAllDetailedReviews.js
OnStartup
-
OnClose
-

Attributes

-

getCustomFilterReviews

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

OnInit
./lib/actions/getCustomFilterReviews.js
OnStartup
-
OnClose
-

Attributes

-

postCustomFilterReviews

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.

OnInit
./lib/actions/postCustomFilterReviews.js
OnStartup
-
OnClose
-

Attributes

-

getDetailedCustomFilterReviews

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

OnInit
./lib/actions/getDetailedCustomFilterReviews.js
OnStartup
-
OnClose
-

Attributes

-

postDetailedCustomFilterReviews

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.

OnInit
./lib/actions/postDetailedCustomFilterReviews.js
OnStartup
-
OnClose
-

Attributes

-

getFilteredReviewsForUser

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

OnInit
./lib/actions/getFilteredReviewsForUser.js
OnStartup
-
OnClose
-

Attributes

-

getDetailedFilteredReviewsForUser

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

OnInit
./lib/actions/getDetailedFilteredReviewsForUser.js
OnStartup
-
OnClose
-

Attributes

-

getMetrics

Get comment metrics metadata for the specified metrics version.

OnInit
./lib/actions/getMetrics.js
OnStartup
-
OnClose
-

Attributes

-

getReviewsForPath

Return a list of Reviews which include a particular file.

OnInit
./lib/actions/getReviewsForPath.js
OnStartup
-
OnClose
-

Attributes

-

getReviewsDetailsForPath

Return a list of Reviews which include a particular file.

OnInit
./lib/actions/getReviewsDetailsForPath.js
OnStartup
-
OnClose
-

Attributes

-

getVersionInfo

Returns Crucible version information.

OnInit
./lib/actions/getVersionInfo.js
OnStartup
-
OnClose
-

Attributes

-

deleteReview

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

OnInit
./lib/actions/deleteReview.js
OnStartup
-
OnClose
-

Attributes

-

getReview

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.

OnInit
./lib/actions/getReview.js
OnStartup
-
OnClose
-

Attributes

-

getAvailableActions

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

OnInit
./lib/actions/getAvailableActions.js
OnStartup
-
OnClose
-

Attributes

-

addChangesetToReview

OnInit
./lib/actions/addChangesetToReview.js
OnStartup
-
OnClose
-

Attributes

-

addFile

OnInit
./lib/actions/addFile.js
OnStartup
-
OnClose
-

Attributes

-

addPatchReview0

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

OnInit
./lib/actions/addPatchReview0.js
OnStartup
-
OnClose
-

Attributes

-

closeReviewWithComment

Closes the given review with the summary given.

OnInit
./lib/actions/closeReviewWithComment.js
OnStartup
-
OnClose
-

Attributes

-

getAllComments

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

OnInit
./lib/actions/getAllComments.js
OnStartup
-
OnClose
-

Attributes

-

addGeneralComment

Add a general comment to the review.

OnInit
./lib/actions/addGeneralComment.js
OnStartup
-
OnClose
-

Attributes

-

getGeneralComments

OnInit
./lib/actions/getGeneralComments.js
OnStartup
-
OnClose
-

Attributes

-

markAllCommentsAsRead

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

OnInit
./lib/actions/markAllCommentsAsRead.js
OnStartup
-
OnClose
-

Attributes

-

getVersionedComments

OnInit
./lib/actions/getVersionedComments.js
OnStartup
-
OnClose
-

Attributes

-

removeComment

Deletes the given comment.

OnInit
./lib/actions/removeComment.js
OnStartup
-
OnClose
-

Attributes

-

getComment

Gets the given comment.

OnInit
./lib/actions/getComment.js
OnStartup
-
OnClose
-

Attributes

-

updateComment

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

OnInit
./lib/actions/updateComment.js
OnStartup
-
OnClose
-

Attributes

-

markCommentAsLeaveUnread

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

OnInit
./lib/actions/markCommentAsLeaveUnread.js
OnStartup
-
OnClose
-

Attributes

-

markCommentAsRead

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

OnInit
./lib/actions/markCommentAsRead.js
OnStartup
-
OnClose
-

Attributes

-

getReplies

Gets the replies to the given comment.

OnInit
./lib/actions/getReplies.js
OnStartup
-
OnClose
-

Attributes

-

addReply

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

OnInit
./lib/actions/addReply.js
OnStartup
-
OnClose
-

Attributes

-

removeReply

Deletes the reply.

OnInit
./lib/actions/removeReply.js
OnStartup
-
OnClose
-

Attributes

-

updateReply

Updates a reply with the given newComment.

OnInit
./lib/actions/updateReply.js
OnStartup
-
OnClose
-

Attributes

-

completeReview

Completes the review for the current user

OnInit
./lib/actions/completeReview.js
OnStartup
-
OnClose
-

Attributes

-

getDetailedReview

Returns the specified review.

OnInit
./lib/actions/getDetailedReview.js
OnStartup
-
OnClose
-

Attributes

-

getReviewPatches

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

OnInit
./lib/actions/getReviewPatches.js
OnStartup
-
OnClose
-

Attributes

-

addPatchToReview

Add the revisions in a patch to an existing review.

OnInit
./lib/actions/addPatchToReview.js
OnStartup
-
OnClose
-

Attributes

-

removePatch

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

OnInit
./lib/actions/removePatch.js
OnStartup
-
OnClose
-

Attributes

-

publishAllComments

Publishes all the draft comments of the current user.

OnInit
./lib/actions/publishAllComments.js
OnStartup
-
OnClose
-

Attributes

-

publishComment

publishes the given draft comment.

OnInit
./lib/actions/publishComment.js
OnStartup
-
OnClose
-

Attributes

-

remindIncompleteReviewers

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

OnInit
./lib/actions/remindIncompleteReviewers.js
OnStartup
-
OnClose
-

Attributes

-

getReviewers

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

OnInit
./lib/actions/getReviewers.js
OnStartup
-
OnClose
-

Attributes

-

addReviewers

Adds the given list of reviewers to the review.

OnInit
./lib/actions/addReviewers.js
OnStartup
-
OnClose
-

Attributes

-

getCompletedReviewers

Gets a list of completed reviewers.

OnInit
./lib/actions/getCompletedReviewers.js
OnStartup
-
OnClose
-

Attributes

-

getUncompletedReviewers

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

OnInit
./lib/actions/getUncompletedReviewers.js
OnStartup
-
OnClose
-

Attributes

-

removeReviewer

Removes the reviewer from the review.

OnInit
./lib/actions/removeReviewer.js
OnStartup
-
OnClose
-

Attributes

-

getReviewItemsForReview

Returns a list of all the items in a review.

OnInit
./lib/actions/getReviewItemsForReview.js
OnStartup
-
OnClose
-

Attributes

-

addFisheyeReviewItem

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

OnInit
./lib/actions/addFisheyeReviewItem.js
OnStartup
-
OnClose
-

Attributes

-

addReviewItem

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).

OnInit
./lib/actions/addReviewItem.js
OnStartup
-
OnClose
-

Attributes

-

addReviewItems

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

OnInit
./lib/actions/addReviewItems.js
OnStartup
-
OnClose
-

Attributes

-

removeReviewItem

Removes an item from a review.

OnInit
./lib/actions/removeReviewItem.js
OnStartup
-
OnClose
-

Attributes

-

getReviewItem

Returns detailed information for a specific review item.

OnInit
./lib/actions/getReviewItem.js
OnStartup
-
OnClose
-

Attributes

-

getReviewItemsComments

OnInit
./lib/actions/getReviewItemsComments.js
OnStartup
-
OnClose
-

Attributes

-

addVersionedComment

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

OnInit
./lib/actions/addVersionedComment.js
OnStartup
-
OnClose
-

Attributes

-

setReviewItem

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.

OnInit
./lib/actions/setReviewItem.js
OnStartup
-
OnClose
-

Attributes

-

removeReviewItemRevisions

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.

OnInit
./lib/actions/removeReviewItemRevisions.js
OnStartup
-
OnClose
-

Attributes

-

addReviewItemRevisions

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:

OnInit
./lib/actions/addReviewItemRevisions.js
OnStartup
-
OnClose
-

Attributes

-

changeState

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

OnInit
./lib/actions/changeState.js
OnStartup
-
OnClose
-

Attributes

-

getAvailableTransitions

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

OnInit
./lib/actions/getAvailableTransitions.js
OnStartup
-
OnClose
-

Attributes

-

uncompleteReview

Uncompletes the review for the current user.

OnInit
./lib/actions/uncompleteReview.js
OnStartup
-
OnClose
-

Attributes

-

getReviewsForTerm

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

OnInit
./lib/actions/getReviewsForTerm.js
OnStartup
-
OnClose
-

Attributes

-

getReviewsForIssueKey

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

OnInit
./lib/actions/getReviewsForIssueKey.js
OnStartup
-
OnClose
-

Attributes

-

getUsers

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

OnInit
./lib/actions/getUsers.js
OnStartup
-
OnClose
-

Attributes

-

getMappedUser

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

OnInit
./lib/actions/getMappedUser.js
OnStartup
-
OnClose
-

Attributes

-

getUserProfile

Returns the user's profile details.

OnInit
./lib/actions/getUserProfile.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden