Use case: Update a Jira Project Configuration

Before you start

  1. Verify Permissions: Ensure you have the appropriate permissions in your Unity Organization to update 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 is located.
  3. Jira ProjectConfig ID: You'll need the unique identifier (GUID) of the Jira ProjectConfig you want to update.

How do I...?

To update a Jira ProjectConfig, follow these steps:

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

Example:

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

await jiraConfigService.UpdateProjectConfigAsync(
    organizationId: organizationId,
    jiraProjectConfigId: jiraProjectConfigId,
    defaultReporterId: reporter,
    isRestricted: isRestricted,
    linkedUnityProjectIds: unityProjectIds,
    cancellationToken: cancellationToken);

Error Handling

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