Projects
Provides access to all Jira projects. Supports querying, creating, updating, and deleting project records.
Select
When connecting to Jira Cloud (rather than Jira Data Center) instances, the cmdlet uses the Jira API to process WHERE clause conditions built with the following columns and operators.
- Id supports the '=' and 'IN' operators.
- Key supports the '=', 'LIKE' and 'IN' operators.
- Name supports the 'LIKE' operator.
- ProjectTypeKey supports the '=' operator.
- ProjectCategoryId supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Projects WHERE Id = 10000
Additionally, the Jira API handles ORDER BY (ASC/DESC) clauses for the Key, Name, LeadDisplayName, and ProductCategoryName columns in Jira Cloud instances. For example:
SELECT * FROM Projects ORDER BY Name ASC
The cmdlet processes other filters client-side.
INSERT
Key, Name, LeadName and ProjectTypeKey are required to insert. The following query creates a new project:
INSERT INTO Projects (Key, Name, LeadName, ProjectTypeKey, Description) VALUES ('EXE4', 'Inserted Project 4', 'admin', 'business', 'New business project.')
Update
You can update by specifying either Id or Key:
UPDATE Projects SET Description = 'Updated description', AssigneeType = 'UNASSIGNED', LeadName = 'admin2' WHERE Key = 'EXE4'
Delete
Delete a project by specifying either Id or Key:
DELETE FROM Projects WHERE Key = 'EXE4'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Int | True | = | Common |
A unique numeric identifier assigned to the project within the Jira instance. This ID is used internally and in API requests to reference the project. | |
| Key | String | False | = | Common |
The short, unique project key used as a prefix for issue identifiers (such as 'PROJ-123'). It is typically assigned when the project is created and used in search queries and issue references. | |
| Name | String | False | Common |
The full display name of the project as seen in the Jira UI. This is the main title used to identify the project in dashboards, boards, and menus. | ||
| Description | String | False | Common |
A free-text description that provides an overview of the project's purpose, goals, stakeholders, or context. Often used to help team members and collaborators understand the scope of the project. | ||
| LeadEmailAddress | String | True |
Users.EmailAddress | Common |
The email address of the user assigned as the project lead. The project lead is typically responsible for managing the project and receives notifications by default. | |
| LeadDisplayName | String | True |
Users.DisplayName | Common |
The display name (as shown in the Jira UI) of the user designated as the lead for the project. | |
| ComponentsAggregate | String | True | Common |
A comma-separated list of all components configured in the project. Components are used to categorize issues within a project and can represent subsystems, teams, or functional areas. | ||
| IssueTypesAggregate | String | True | Common |
A comma-separated list of the issue types available in the project, such as 'Bug', 'Task', 'Story', 'Epic', or custom issue types. Each issue type defines a distinct kind of work item. | ||
| Url | String | True | Common |
A user-defined web URL that can be associated with the project for external references, documentation, or integration. This field is optional. | ||
| String | True | Common |
The email address associated with the project, typically used for contact or notification purposes. This value can be customized per project. | |||
| AssigneeType | String | False | Common |
Indicates the default assignment strategy for new issues created in the project. Common values include 'UNASSIGNED' or 'PROJECT_LEAD'. | ||
| VersionsAggregate | String | True | Common |
A comma-separated list of version names configured in the project. Versions can be used for release planning and tracking progress toward a release milestone. | ||
| RolesAggregate | String | True | Common |
A comma-separated list of roles defined in the project, such as 'Administrator', 'Developer', or 'Viewer'. Each role controls the permissions and responsibilities of users in the project. | ||
| ProjectKeysAggregate | String | True | Common |
A list of all project keys historically associated with this project. This includes previous keys if the project key has ever been changed. | ||
| ProjectCategoryId | String | False | Common |
The identifier of the project category to which this project belongs. Categories group projects into logical sets for filtering and reporting. | ||
| ProjectCategoryName | String | True | Common |
The name of the category assigned to this project. This is used to organize and display projects by type or purpose in the Jira interface. | ||
| ProjectCategoryDescription | String | True | Common |
A free-text description of the project category, used to provide additional context or clarification for users browsing categorized projects. | ||
| ProjectTypeKey | String | False | Common |
The key representing the type of project. Common values include 'software', 'service_desk', or 'business', which determine the features and interface available. | ||
| LeadAccountId | String | False |
Users.AccountId | Cloud |
The unique Atlassian account ID of the project lead. This identifier is consistent across all Atlassian Cloud products and replaces deprecated user keys. | |
| LeadAccountKey | String | True |
Users.Key | Server |
[DEPRECATED] A legacy identifier used to represent the project lead, typically replaced by LeadAccountId in modern Jira Cloud instances. | |
| LeadAccountName | String | False |
Users.Name | Server |
[DEPRECATED] The legacy username of the project lead, used in older Jira Server installations. Replaced by account ID in Jira Cloud. | |
| Simplified | Boolean | True | Cloud |
A boolean value that indicates whether the project is team-managed (formerly called next-gen) or company-managed. Team-managed projects allow simplified configuration by project admins. | ||
| ItemURL | String | True | Common |
A direct URL to the project in the Jira web interface, allowing users to quickly navigate to the project's main overview page. |