643 matches
60 actions
Jira
60 actions
Productivity/Jira
Returns all projects visible to the user. Deprecated, use that supports search and pagination.
This operation can be accessed anonymously.
required: Projects are returned only where the user has Browse Projects or Administer projects for the project.
{
"type": "object",
"properties": {
"expand": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "string"
}
},
"recent": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}{
"type": "array",
"items": {
"type": "object",
"description": "Details about a project.",
"properties": {
"archived": {
"type": "boolean",
"description": "Whether the project is archived."
},
"archivedBy": {
"description": "The user who archived the project.",
"type": "object"
},
"archivedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the project was archived."
},
"assigneeType": {
"type": "string",
"description": "The default assignee when creating issues for this project.",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"avatarUrls": {
"description": "The URLs of the project's avatars.",
"type": "object"
},
"components": {
"type": "array",
"description": "List of the components contained in the project.",
"items": {
"type": "object",
"description": "Details about a project component.",
"properties": {
"ari": {
"type": "string",
"description": "Compass component's ID. Can't be updated. Not required for creating a Project Component."
},
"assignee": {
"description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.",
"type": "object"
},
"assigneeType": {
"type": "string",
"description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"description": {
"type": "string",
"description": "The description for the component. Optional when creating or updating a component."
},
"id": {
"type": "string",
"description": "The unique identifier for the component."
},
"isAssigneeTypeValid": {
"type": "boolean",
"description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned."
},
"lead": {
"description": "The user details for the component's lead user.",
"type": "object"
},
"leadAccountId": {
"type": "string",
"description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"leadUserName": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"metadata": {
"type": "object",
"description": "Compass component's metadata. Can't be updated. Not required for creating a Project Component."
},
"name": {
"type": "string",
"description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."
},
"project": {
"type": "string",
"description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated."
},
"projectId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project the component is assigned to."
},
"realAssignee": {
"description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.",
"type": "object"
},
"realAssigneeType": {
"type": "string",
"description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the component."
}
},
"additionalProperties": false
}
},
"deleted": {
"type": "boolean",
"description": "Whether the project is marked as deleted."
},
"deletedBy": {
"description": "The user who marked the project as deleted.",
"type": "object"
},
"deletedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the project was marked as deleted."
},
"description": {
"type": "string",
"description": "A brief description of the project."
},
"email": {
"type": "string",
"description": "An email address associated with the project."
},
"expand": {
"type": "string",
"description": "Expand options that include additional project details in the response."
},
"favourite": {
"type": "boolean",
"description": "Whether the project is selected as a favorite."
},
"id": {
"type": "string",
"description": "The ID of the project."
},
"insight": {
"description": "Insights about the project.",
"type": "object"
},
"isPrivate": {
"type": "boolean",
"description": "Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues."
},
"issueTypeHierarchy": {
"description": "The issue type hierarchy for the project.",
"type": "object"
},
"issueTypes": {
"type": "array",
"description": "List of the issue types available in the project.",
"items": {
"type": "object",
"description": "Details about an issue type.",
"properties": {
"avatarId": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue type's avatar."
},
"description": {
"type": "string",
"description": "The description of the issue type."
},
"entityId": {
"type": "string",
"format": "uuid",
"description": "Unique ID for next-gen projects."
},
"hierarchyLevel": {
"type": "integer",
"format": "int32",
"description": "Hierarchy level of the issue type."
},
"iconUrl": {
"type": "string",
"description": "The URL of the issue type's avatar."
},
"id": {
"type": "string",
"description": "The ID of the issue type."
},
"name": {
"type": "string",
"description": "The name of the issue type."
},
"scope": {
"description": "Details of the next-gen projects the issue type is available in.",
"type": "object"
},
"self": {
"type": "string",
"description": "The URL of these issue type details."
},
"subtask": {
"type": "boolean",
"description": "Whether this issue type is used to create subtasks."
}
},
"additionalProperties": false
}
},
"key": {
"type": "string",
"description": "The key of the project."
},
"landingPageInfo": {
"description": "The project landing page info.",
"type": "object"
},
"lead": {
"description": "The username of the project lead.",
"type": "object"
},
"name": {
"type": "string",
"description": "The name of the project."
},
"permissions": {
"description": "User permissions on the project",
"type": "object"
},
"projectCategory": {
"description": "The category the project belongs to.",
"type": "object"
},
"projectTypeKey": {
"type": "string",
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business",
"product_discovery"
]
},
"properties": {
"type": "object",
"description": "Map of project properties"
},
"retentionTillDate": {
"type": "string",
"format": "date-time",
"description": "The date when the project is deleted permanently."
},
"roles": {
"type": "object",
"description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post)."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the project details."
},
"simplified": {
"type": "boolean",
"description": "Whether the project is simplified."
},
"style": {
"type": "string",
"description": "The type of the project.",
"enum": [
"classic",
"next-gen"
]
},
"url": {
"type": "string",
"description": "A link to information about this project, such as project documentation."
},
"uuid": {
"type": "string",
"format": "uuid",
"description": "Unique ID for next-gen projects."
},
"versions": {
"type": "array",
"description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).",
"items": {
"type": "object",
"description": "Details about a project version.",
"properties": {
"approvers": {
"type": "array",
"description": "If the expand option `approvers` is used, returns a list containing the approvers for this version.",
"items": {
"type": "object",
"description": "Contains details about a version approver.",
"properties": {
"accountId": {
"type": "string",
"description": "The Atlassian account ID of the approver."
},
"declineReason": {
"type": "string",
"description": "A description of why the user is declining the approval."
},
"description": {
"type": "string",
"description": "A description of what the user is approving within the specified version."
},
"status": {
"type": "string",
"description": "The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED*"
}
}
}
},
"archived": {
"type": "boolean",
"description": "Indicates that the version is archived. Optional when creating or updating a version."
},
"description": {
"type": "string",
"description": "The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes."
},
"driver": {
"type": "string",
"description": "The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver."
},
"expand": {
"type": "string",
"description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n * `driver` Returns the Atlassian account ID of the version driver.\n * `approvers` Returns a list containing approvers for this version.\n\nOptional for create and update."
},
"id": {
"type": "string",
"description": "The ID of the version."
},
"issuesStatusForFixVersion": {
"description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.",
"type": "object"
},
"moveUnfixedIssuesTo": {
"type": "string",
"format": "uri",
"description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version."
},
"name": {
"type": "string",
"description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters."
},
"operations": {
"type": "array",
"description": "If the expand option `operations` is used, returns the list of operations available for this version.",
"items": {
"type": "object",
"description": "Details about the operations available in this version.",
"properties": {
"href": {
"type": "string"
},
"iconClass": {
"type": "string"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"styleClass": {
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"overdue": {
"type": "boolean",
"description": "Indicates that the version is overdue."
},
"project": {
"type": "string",
"description": "Deprecated. Use `projectId`."
},
"projectId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version."
},
"releaseDate": {
"type": "string",
"format": "date",
"description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"released": {
"type": "boolean",
"description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the version."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"userReleaseDate": {
"type": "string",
"description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format."
},
"userStartDate": {
"type": "string",
"description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}