Use case: Retrieve Jira Issue Details

Before you start

  1. Verify Permissions: Ensure your Jira account has permission to view issues in the linked Jira project. Access is typically granted through role-based permissions in Jira.
  2. Project Must Be Linked: The Unity project must be linked to a Jira ProjectConfig to retrieve issue details through the Unity Collaboration API.
  3. Jira Issue ID: You'll need the Jira Issue ID (e.g., ABC-123) to look up the issue.
  4. Jira Project Context: Ensure the Jira Project ID and configuration context are valid and active.

How do I...?

To get full information about a Jira issue linked to your Unity project:

  1. Ensure Project Is Linked: Confirm that your Unity project is connected to a Jira ProjectConfig.
  2. Get the Issue ID: Obtain the Issue ID from a search result, issue list, or from a recent issue creation response.
  3. Use the SDK: Call the GetIssueDetailsAsync method in the Unity Collaboration SDK with the required properties.
  4. Process the Response: Extract key fields like summary, status, issue type, assignee, priority, and description.

Example:

var issueDetails = await jiraIssueService.GetIssueDetailsAsync(
    projectId: projectId,
    jiraProjectConfigId: jiraProjectConfigId,
    jiraIssueId: jiraIssueId,
    cancellationToken: cancellationToken);

Error Handling

  • 400 Bad Request: Invalid input.
  • 401 Unauthorized: Authentication required.
  • 403 Forbidden: Insufficient permissions.