JetBrains Rider
 
2023.3
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
Get your hands on the new features ahead of the release by joining the Early Access Program for Rider 2025.1! Learn more
Upcoming webinar
Uno Platform & Hot Design for Rider
March 11, 2025 at 03:00 PM
  1. Integrated tools
  2. Manage tasks and contexts
  3. Configure generic task server

Configure generic task server

Last modified: 21 March 2024

JetBrains Rider supports integration with many task trackers out of the box. However, if you use a tracker that JetBrains Rider does not support yet, you can still integrate it configuring a so-called generic server.

This tutorial describes how to:

  • Connect to JIRA Cloud as a generic server.

  • Obtain the list of issues assigned to you.

  • For each issue, get its ID, title, description, date and time when the issue was created and updated.

Before you start configuring a connection to your tracker, note that JetBrains Rider:

  • Supports only services with REST API.

  • Supports either Basic HTTP authentication or sending preliminary requests to the server.

  • Supports GET and POST requests.

  • Does not support pagination in server responses.

Specify server URL and credentials

  1. In the Settings dialog CtrlAlt0S, go to Tools | Tasks | Servers.

  2. Click the Add button and select Generic.

  3. On the General tab, specify the URL of your task tracker and connection credentials.

    In the Username field, type your email address.

    In the Password field, enter your Atlassian API token.

  4. Select the Use HTTP authentication checkbox at the bottom of the dialog.

Specifying server URL and credentials

Configure the server settings

  1. Switch to the Server Configuration tab.

    Note that the Login URL field will be disabled, as you are using HTTP authentication.

  2. In the Task List URL, enter the URL for obtaining issues from the server. You can use variables or enter the full URL:

    {serverUrl}/rest/api/2/search or https://serverurl.atlassian.net/rest/api/2/search

    The {serverUrl} is a variable that stands for the URL you have specified on the General tab.

  3. Add the ?jql={JQL_Query} expression to your task list URL: {serverUrl}/rest/api/2/search?jql={JQL_Query}.

    tip

    You can use code completion in the Login URL, Task List URL and Single Task URL fields.

    Configuring server settings

  4. Click Manage Template Variables at the bottom of the dialog to configure the JQL_Query variable.

  5. Click the Add button and in the new field, specify the variable name JQL_Query and add its value assignee = currentUser() AND resolution = unresolved.

    This will let you obtain unresolved issues assigned to you.

  6. Click OK.

    Specifying template variables

note

All variables specified in URL fields, except {serverUrl}, are encoded with application/x-www-form-urlencoded by default.

tip

For more information about advanced searches, refer to Advanced searching - fields reference.

Configure response type and specify selectors

  1. In the Server Configuration dialog, select the JSON response type.

  2. Specify selectors in the table to get IDs and titles of issues and their description. You can also obtain the date and time when issues were created and updated:

    • tasks: $.issues

    • id: key

    • summary: fields.summary

    • description: fields.description

    • updated: fields.updated

    • created: fields.created

    tip

    For JIRA, you can check the server responses in real time. Replace placeholders with actual values in the link and open it in a browser: http://<serverURL>:<port>/rest/api/2/search

  3. Click Test to make sure all parameters are configured correctly.

    Configuring a response type and specifying selectors

Upload issues from the server

  1. Click the task list and select Open Task. JetBrains Rider will load from the server all issues that match your configuration.

  2. Select the necessary issue from the list.

  3. Press Ctrl0K,0I to open issue description and make sure all required details are obtained.

See also

External Links