Use case: Create a Jira Project Configuration

Before you start

  1. Verify Permissions: Ensure you have the appropriate permissions in your Unity Organization to create a Jira ProjectConfig. Typically, you must be an admin or have specific collaboration settings access.
  2. Organization Context: Know the Organization identifier (GUID) of the Unity Organization where this configuration should be created.
  3. Jira ServerConfig ID: You'll need the unique identifier (GUID) of the Jira ServerConfig to which this configuration will be linked.
  4. Jira Project ID: Identify the Jira project you want to link.
  5. Default Reporter: Identify the Jira user ID to use as the default reporter.

How do I...?

To create a Jira ProjectConfig, follow these steps:

  1. Get the Jira ServerConfig ID: Retrieve or confirm the ServerConfig ID where the ProjectConfig will be created.
  2. Get the Organization ID: Retrieve or confirm the Unity Organization ID where the ServerConfig is located.
  3. Prepare the ProjectConfig Payload: Prepare data for the request (Jira project ID, default reporter ID, restriction flag, and linked Unity project IDs).
  4. Use the SDK: Call the CreateProjectConfigAsync method in the Unity Collaboration SDK with the required properties.
  5. Handle Responses: Ensure your implementation verifies whether the config was successfully created and handles any errors appropriately.

Example:

var jiraProjectId = new JiraProjectId("Jira Project ID");
var reporter = new JiraUserId("ID of the reporter for the config");
bool isRestricted = false;
var unityProjectIds = new List<ProjectId> { /* Unity Project IDs to link */ };

var jiraProjectConfigId = await jiraConfigService.CreateProjectConfigAsync(
    organizationId: organizationId,
    jiraServerConfigId: jiraServerConfigId,
    jiraProjectId: jiraProjectId,
    defaultReporterId: reporter,
    isRestricted: isRestricted,
    linkedUnityProjectIds: unityProjectIds,
    cancellationToken: cancellationToken);

Error Handling

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