JetBrains Space Help

External Issues

Set default target issue status for merge request merge

post /api/http/external-issues/default-issue-status-for-mr-merge

Set default status to move external issues to when linked merge request is merged in Space

Request arguments

object with fields:

  • application: ApplicationIdentifier ( Required )

  • project: ProjectIdentifier ( Required )

  • issuePrefix: string ( Required )

  • targetStatusForMergeRequestMerge: string ( Nullable and Optional , defaults to null)

Response

No arguments

Post external issue data

post /api/http/external-issues/issue-content

Provide information about an issue from external issue tracker

Request arguments

object with fields:

Response

No arguments

Provide all possible statuses for external issues

post /api/http/external-issues/issue-statuses

Provide Space with all possible statuses for external issues for a given project

Request arguments

object with fields:

Response

No arguments

Mark external issues as deleted

post /api/http/external-issues/mark-issues-as-deleted

Notify Space about issues that were deleted in external issue tracker

Request arguments

object with fields:

  • issuePrefix: string ( Required )

  • issueIds: array of string ( Required )

Response

No arguments

Get external issue event queue items

get /api/http/external-issues/events-queue

Fetch events about external issues from Space

Request arguments

fromEtag: integer (format: int64) (Query) ( Nullable and Optional , defaults to null)

batchSize: integer (format: int32) (Query) ( Required )

issueCodeLinkingEventsShape: ExternalIssueCodeLinkingEventsShape (Query) ( Optional , defaults to "Transactions")

The shape of the events published as a result of linking external issues to commits and code reviews in Space. External issues to code linking can be reported from one of the following perspectives :

  • Creation or removal of a single link between an issue and a commit or a code review ( default ) ;

  • Update in a set of commits or code reviews in Space linked to a given external issue;

  • Update in a set of external issues linked to a given commit or code review in Space.

includeCommitChanges: boolean (Query) ( Optional , defaults to false)

Connect external issue tracker projects

post /api/http/external-issues/external-tracker-projects

Request arguments

object with fields:

Get all connected external issue tracker projects

get /api/http/external-issues/external-tracker-projects

Request arguments

application: string in one of the formats

  • clientId: string

    Specifies application by the client id that it uses to authenticate in Space

    Read more

  • id: string

    Specifies application by the identifier that can be fetched via Get all applications method

  • me

    Specifies application that corresponds to the caller of this API method.

    Applicable only for calls made by Space applications.

(Query) ( Required )

Disconnect external issue tracker project

delete /api/http/external-issues/external-tracker-projects

Request arguments

issuePrefix: string (Query) ( Required )

Response

No arguments

post /api/http/external-issues/issues/{issuePrefix}/{issueId}/code-reviews

Add code review links to an existing issue in a project

Request arguments

issuePrefix: string (Path) ( Required )

issueId: string (Path) ( Required )

object with fields:

Response

No arguments

delete /api/http/external-issues/issues/{issuePrefix}/{issueId}/code-reviews

Remove code review links from an existing issue in a project

Request arguments

issuePrefix: string (Path) ( Required )

issueId: string (Path) ( Required )

project: string in one of the formats

  • id: string

  • key: string

(Query) ( Required )

codeReviewIds: array of ReviewIdentifier (Query) ( Required )

Response

No arguments

post /api/http/external-issues/issues/{issuePrefix}/{issueId}/commits

Add commit links to an existing issue in a project

Request arguments

issuePrefix: string (Path) ( Required )

issueId: string (Path) ( Required )

object with fields:

  • project: ProjectIdentifier ( Required )

  • repository: string ( Required )

  • commitIds: array of string ( Required )

Response

No arguments

delete /api/http/external-issues/issues/{issuePrefix}/{issueId}/commits

Remove commit links from an existing issue in a project

Request arguments

issuePrefix: string (Path) ( Required )

issueId: string (Path) ( Required )

project: string in one of the formats

  • id: string

  • key: string

(Query) ( Required )

repository: string (Query) ( Required )

commitIds: array of string (Query) ( Required )

Response

No arguments

Last modified: 06 September 2023