All URIs are relative to https://api.bitbucket.org/2.0
| Method | HTTP request | Description |
|---|---|---|
| RepositoriesWorkspaceRepoSlugComponentsComponentIdGet | Get /repositories/{workspace}/{repo_slug}/components/{component_id} | Get a component for issues |
| RepositoriesWorkspaceRepoSlugComponentsGet | Get /repositories/{workspace}/{repo_slug}/components | List components |
| RepositoriesWorkspaceRepoSlugIssuesExportPost | Post /repositories/{workspace}/{repo_slug}/issues/export | Export issues |
| RepositoriesWorkspaceRepoSlugIssuesExportRepoNameIssuesTaskIdZipGet | Get /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip | Check issue export status |
| RepositoriesWorkspaceRepoSlugIssuesGet | Get /repositories/{workspace}/{repo_slug}/issues | List issues |
| RepositoriesWorkspaceRepoSlugIssuesImportGet | Get /repositories/{workspace}/{repo_slug}/issues/import | Check issue import status |
| RepositoriesWorkspaceRepoSlugIssuesImportPost | Post /repositories/{workspace}/{repo_slug}/issues/import | Import issues |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments | List attachments for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path} | Delete an attachment for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path} | Get attachment for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments | Upload an attachment to an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesChangeIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id} | Get issue change object |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes | List changes on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes | Modify the state of an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Delete a comment on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Get a comment on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Update a comment on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments | List comments on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments | Create a comment on an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Delete an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Get an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Update an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Remove vote for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Check if current user voted for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdVotePut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Vote for an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Stop watching an issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Check if current user is watching a issue |
| RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Watch an issue |
| RepositoriesWorkspaceRepoSlugIssuesPost | Post /repositories/{workspace}/{repo_slug}/issues | Create an issue |
| RepositoriesWorkspaceRepoSlugMilestonesGet | Get /repositories/{workspace}/{repo_slug}/milestones | List milestones |
| RepositoriesWorkspaceRepoSlugMilestonesMilestoneIdGet | Get /repositories/{workspace}/{repo_slug}/milestones/{milestone_id} | Get a milestone |
| RepositoriesWorkspaceRepoSlugVersionsGet | Get /repositories/{workspace}/{repo_slug}/versions | List defined versions for issues |
| RepositoriesWorkspaceRepoSlugVersionsVersionIdGet | Get /repositories/{workspace}/{repo_slug}/versions/{version_id} | Get a defined version for issues |
Component RepositoriesWorkspaceRepoSlugComponentsComponentIdGet(ctx, componentId, repoSlug, workspace) Get a component for issues
Returns the specified issue tracker component object.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| componentId | int32 | The component's id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedComponents RepositoriesWorkspaceRepoSlugComponentsGet(ctx, repoSlug, workspace, optional) List components
Returns the components that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugComponentsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugComponentsGetOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesExportPost(ctx, repoSlug, workspace, optional) Export issues
A POST request to this endpoint initiates a new background celery task that archives the repo's issues. When the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the 'Location' response header. This url is the endpoint for where the user can obtain their zip files."
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesExportPostOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesExportPostOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of ModelError| The options to apply to the export. Available options include `project_key` and `project_name` which, if specified, are used as the project key and name in the exported Jira json format. Option `send_email` specifies whether an email should be sent upon export result. Option `include_attachments` specifies whether attachments are included in the export. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssueJobStatus RepositoriesWorkspaceRepoSlugIssuesExportRepoNameIssuesTaskIdZipGet(ctx, repoName, repoSlug, taskId, workspace) Check issue export status
This endpoint is used to poll for the progress of an issue export job and return the zip file after the job is complete. As long as the job is running, this will return a 202 response with in the response body a description of the current status. After the job has been scheduled, but before it starts executing, the endpoint returns a 202 response with status ACCEPTED. Once it starts running, it is a 202 response with status STARTED and progress filled. After it is finished, it becomes a 200 response with status SUCCESS or FAILURE.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoName | string | The name of the repo | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| taskId | string | The ID of the export task | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedIssues RepositoriesWorkspaceRepoSlugIssuesGet(ctx, repoSlug, workspace, optional) List issues
Returns the issues in the issue tracker.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesGetOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssueJobStatus RepositoriesWorkspaceRepoSlugIssuesImportGet(ctx, repoSlug, workspace) Check issue import status
When using GET, this endpoint reports the status of the current import task. After the job has been scheduled, but before it starts executing, the endpoint returns a 202 response with status ACCEPTED. Once it starts running, it is a 202 response with status STARTED and progress filled. After it is finished, it becomes a 200 response with status SUCCESS or FAILURE.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssueJobStatus RepositoriesWorkspaceRepoSlugIssuesImportPost(ctx, repoSlug, workspace) Import issues
A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All existing issues will be deleted and replaced by the contents of the imported zip file. Imports are done through a multipart/form-data POST. There is one valid and required form field, with the name "archive," which needs to be a file field: $ curl -u <username> -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories/<owner_username>/<repo_slug>/issues/import
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedIssueAttachments RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGet(ctx, issueId, repoSlug, workspace, optional) List attachments for an issue
Returns all attachments for this issue. This returns the files' meta data. This does not return the files' actual contents. The files are always ordered by their upload date.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGetOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathDelete(ctx, issueId, path, repoSlug, workspace) Delete an attachment for an issue
Deletes an attachment.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| path | string | Path to the file. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathGet(ctx, issueId, path, repoSlug, workspace) Get attachment for an issue
Returns the contents of the specified file attachment. Note that this endpoint does not return a JSON response, but instead returns a redirect pointing to the actual file that in turn will return the raw contents. The redirect URL contains a one-time token that has a limited lifetime. As a result, the link should not be persisted, stored, or shared.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| path | string | Path to the file. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPost(ctx, issueId, repoSlug, workspace) Upload an attachment to an issue
Upload new issue attachments. To upload files, perform a multipart/form-data POST containing one or more file fields. When a file is uploaded with the same name as an existing attachment, then the existing file will be replaced.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesChangeIdGet(ctx, changeId, issueId, repoSlug, workspace) Get issue change object
Returns the specified issue change object. This resource is only available on repositories that have the issue tracker enabled.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| changeId | string | The issue change id | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedLogEntries RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGet(ctx, issueId, repoSlug, workspace, optional) List changes on an issue
Returns the list of all changes that have been made to the specified issue. Changes are returned in chronological order with the oldest change first. Each time an issue is edited in the UI or through the API, an immutable change record is created under the /issues/123/changes endpoint. It also has a comment associated with the change. Note that this operation is changing significantly, due to privacy changes. See the announcement for details. Changes support filtering and sorting that can be used to search for specific changes. For instance, to see when an issue transitioned to "resolved": $ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \\ -G --data-urlencode='q=changes.state.new = \"resolved\"' This resource is only available on repositories that have the issue tracker enabled. N.B. The changes.assignee and changes.assignee_account_id fields are not a user object. Instead, they contain the raw username and account_id of the user. This is to protect the integrity of the audit log even after a user account gets deleted. The changes.assignee field is deprecated will disappear in the future. Use changes.assignee_account_id instead.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGetOpts struct
| Name | Type | Description | Notes |
|---|
q | optional.String| Query string to narrow down the response. See filtering and sorting for details. | sort | optional.String| Name of a response property to sort results. See filtering and sorting for details. | page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesPost(ctx, body, issueId, repoSlug, workspace) Modify the state of an issue
Makes a change to the specified issue. For example, to change an issue's state and assignee, create a new change object that modifies these fields: curl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \\ -s -u evzijst -X POST -H \"Content-Type: application/json\" \\ -d '{ \"changes\": { \"assignee_account_id\": { \"new\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\" }, \"state\": { \"new\": 'resolved\" } } \"message\": { \"raw\": \"This is now resolved.\" } }' The above example also includes a custom comment to go alongside the change. This comment will also be visible on the issue page in the UI. The fields of the changes object are strings, not objects. This allows for immutable change log records, even after user accounts, milestones, or other objects recorded in a change entry, get renamed or deleted. The assignee_account_id field stores the account id. When POSTing a new change and changing the assignee, the client should therefore use the user's account_id in the changes.assignee_account_id.new field. This call requires authentication. Private repositories or private issue trackers require the caller to authenticate with an account that has appropriate authorization.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ModelError | The new issue state change. The only required elements are `changes.[].new`. All other elements can be omitted from the body. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdDelete(ctx, commentId, issueId, repoSlug, workspace) Delete a comment on an issue
Deletes the specified comment.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| commentId | int32 | The id of the comment. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssueComment RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdGet(ctx, commentId, issueId, repoSlug, workspace) Get a comment on an issue
Returns the specified issue comment object.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| commentId | int32 | The id of the comment. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssueComment RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdPut(ctx, body, commentId, issueId, repoSlug, workspace) Update a comment on an issue
Updates the content of the specified issue comment. Note that only the content.raw field can be modified. $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \\ -X PUT -u evzijst \\ -H 'Content-Type: application/json' \\ -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | IssueComment | The updated comment. | |
| commentId | int32 | The id of the comment. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedIssueComments RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGet(ctx, issueId, repoSlug, workspace, optional) List comments on an issue
Returns a paginated list of all comments that were made on the specified issue. The default sorting is oldest to newest and can be overridden with the sort query parameter. This endpoint also supports filtering and sorting of the results. See filtering and sorting for more details.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGetOpts struct
| Name | Type | Description | Notes |
|---|
q | optional.String| Query string to narrow down the response as per filtering and sorting. | page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsPost(ctx, body, issueId, repoSlug, workspace) Create a comment on an issue
Creates a new issue comment. $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \\ -X POST -u evzijst \\ -H 'Content-Type: application/json' \\ -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | IssueComment | The new issue comment object. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Issue RepositoriesWorkspaceRepoSlugIssuesIssueIdDelete(ctx, issueId, repoSlug, workspace) Delete an issue
Deletes the specified issue. This requires write access to the repository.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Issue RepositoriesWorkspaceRepoSlugIssuesIssueIdGet(ctx, issueId, repoSlug, workspace) Get an issue
Returns the specified issue.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Issue RepositoriesWorkspaceRepoSlugIssuesIssueIdPut(ctx, issueId, repoSlug, workspace) Update an issue
Modifies the issue. $ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \\ -u evzijst -s -X PUT -H 'Content-Type: application/json' \\ -d '{ \"title\": \"Updated title\", \"assignee\": { \"account_id\": \"5d5355e8c6b9320d9ea5b28d\" }, \"priority\": \"minor\", \"version\": { \"name\": \"1.0\" }, \"component\": null }' This example changes the title, assignee, priority and the version. It also removes the value of the component from the issue by setting the field to null. Any field not present keeps its existing value. Each time an issue is edited in the UI or through the API, an immutable change record is created under the /issues/123/changes endpoint. It also has a comment associated with the change.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteDelete(ctx, issueId, repoSlug, workspace) Remove vote for an issue
Retract your vote.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteGet(ctx, issueId, repoSlug, workspace) Check if current user voted for an issue
Check whether the authenticated user has voted for this issue. A 204 status code indicates that the user has voted, while a 404 implies they haven't.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdVotePut(ctx, issueId, repoSlug, workspace) Vote for an issue
Vote for this issue. To cast your vote, do an empty PUT. The 204 status code indicates that the operation was successful.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchDelete(ctx, issueId, repoSlug, workspace) Stop watching an issue
Stop watching this issue.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchGet(ctx, issueId, repoSlug, workspace) Check if current user is watching a issue
Indicated whether or not the authenticated user is watching this issue.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModelError RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchPut(ctx, issueId, repoSlug, workspace) Watch an issue
Start watching this issue. To start watching this issue, do an empty PUT. The 204 status code indicates that the operation was successful.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issueId | string | The issue id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Issue RepositoriesWorkspaceRepoSlugIssuesPost(ctx, body, repoSlug, workspace) Create an issue
Creates a new issue. This call requires authentication. Private repositories or private issue trackers require the caller to authenticate with an account that has appropriate authorization. The authenticated user is used for the issue's reporter field.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Issue | The new issue. The only required element is `title`. All other elements can be omitted from the body. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedMilestones RepositoriesWorkspaceRepoSlugMilestonesGet(ctx, repoSlug, workspace, optional) List milestones
Returns the milestones that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugMilestonesGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugMilestonesGetOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Milestone RepositoriesWorkspaceRepoSlugMilestonesMilestoneIdGet(ctx, milestoneId, repoSlug, workspace) Get a milestone
Returns the specified issue tracker milestone object.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| milestoneId | int32 | The milestone's id | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedVersions RepositoriesWorkspaceRepoSlugVersionsGet(ctx, repoSlug, workspace, optional) List defined versions for issues
Returns the versions that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | |
| optional | *IssueTrackerApiRepositoriesWorkspaceRepoSlugVersionsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a IssueTrackerApiRepositoriesWorkspaceRepoSlugVersionsGetOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Version RepositoriesWorkspaceRepoSlugVersionsVersionIdGet(ctx, repoSlug, versionId, workspace) Get a defined version for issues
Returns the specified issue tracker version object.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| repoSlug | string | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | |
| versionId | int32 | The version's id | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]