Atlassian: Projects schemas
14 Atlassian schemas with complete fields and constraints.
← Projects operations · All schemas
Create project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the project. Additional keys: not allowed |
assigneeType | string | Optional | The default assignee when creating issues for this project. One of: PROJECT_LEAD, UNASSIGNED |
avatarId | integer | Optional | An integer value for the project's avatar. Format: int64 |
categoryId | integer | Optional | The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. Format: int64 |
description | string | Optional | A brief description of the project. |
fieldConfigurationScheme | integer | Optional | Deprecated use [fieldScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) instead. The ID of the field configuration scheme for the project. Use the [Get all field configuration schemes](#api-rest-api-3-fieldconfigurationscheme-get) operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key. Format: int64 |
fieldScheme | integer | Optional | The ID of the field scheme for the project. Use the [Get field schemes](#api-rest-api-3-config-fieldschemes-get) operation to get a list of field scheme IDs. If you specify the field scheme you cannot specify the project template key. Format: int64 |
issueSecurityScheme | integer | Optional | The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs. Format: int64 |
issueTypeScheme | integer | Optional | The ID of the issue type scheme for the project. Use the [Get all issue type schemes](#api-rest-api-3-issuetypescheme-get) operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key. Format: int64 |
issueTypeScreenScheme | integer | Optional | The ID of the issue type screen scheme for the project. Use the [Get all issue type screen schemes](#api-rest-api-3-issuetypescreenscheme-get) operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key. Format: int64 |
key | string | Required within parent | Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. |
lead | string | Optional | This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `leadAccountId`. |
leadAccountId | string | Optional | The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `lead`. Maximum length: 128 |
name | string | Required within parent | The name of the project. |
notificationScheme | integer | Optional | The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs. Format: int64 |
permissionScheme | integer | Optional | The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs. Format: int64 |
projectTemplateKey | string | Optional | A predefined configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. One of: com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic, com.pyxis.greenhopper.jira:gh-cross-team-template, com.pyxis.greenhopper.jira:gh-cross-team-planning-template, com.atlassian.servicedesk:simplified-it-service-management, com.atlassian.servicedesk:simplified-it-service-management-basic, com.atlassian.servicedesk:simplified-it-service-management-operations, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk, com.atlassian.servicedesk:simplified-hr-service-desk, com.atlassian.servicedesk:simplified-facilities-service-desk, com.atlassian.servicedesk:simplified-legal-service-desk, com.atlassian.servicedesk:simplified-marketing-service-desk, com.atlassian.servicedesk:simplified-finance-service-desk, com.atlassian.servicedesk:simplified-analytics-service-desk, com.atlassian.servicedesk:simplified-design-service-desk, com.atlassian.servicedesk:simplified-sales-service-desk, com.atlassian.servicedesk:simplified-halp-service-desk, com.atlassian.servicedesk:next-gen-it-service-desk, com.atlassian.servicedesk:next-gen-hr-service-desk, com.atlassian.servicedesk:next-gen-legal-service-desk, com.atlassian.servicedesk:next-gen-marketing-service-desk, com.atlassian.servicedesk:next-gen-facilities-service-desk, com.atlassian.servicedesk:next-gen-analytics-service-desk, com.atlassian.servicedesk:next-gen-finance-service-desk, com.atlassian.servicedesk:next-gen-design-service-desk, com.atlassian.servicedesk:next-gen-sales-service-desk, com.atlassian.servicedesk:company-managed-blank-service-project, com.atlassian.servicedesk:company-managed-general-service-project, com.atlassian.servicedesk:team-managed-general-service-project, com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-, com.atlassian.jcs:customer-service-management |
projectTypeKey | string | Optional | The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type. One of: software, service_desk, business, customer_service |
url | string | Optional | A link to information about this project, such as project documentation |
workflowScheme | integer | Optional | The ID of the workflow scheme for the project. Use the [Get all workflow schemes](#api-rest-api-3-workflowscheme-get) operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key. Format: int64 |
Create project — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifiers for a project. |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the created project. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key of the created project. Read only: true |
key (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the created project. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Get all statuses for project — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Status details for an issue type. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue type. Read only: true |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type. Read only: true |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue type's status details. Read only: true |
self (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | List of status details for the issue type. Read only: true |
statuses (anyOf 1)[] | Model | Each item | Expand Get status — response body |
statuses (anyOf 2) | null | Alternative | |
subtask | JSON | Optional | |
subtask (anyOf 1) | boolean | Alternative | Whether this issue type represents subtasks. Read only: true |
subtask (anyOf 2) | null | Alternative |
Referenced models: Get status — response body
Get project issue type hierarchy — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The hierarchy of issue types within a project. |
hierarchy | JSON | Optional | |
hierarchy (anyOf 1) | array | Alternative | Details of an issue type hierarchy level. Read only: true |
hierarchy (anyOf 1)[] | Model | Each item | Expand Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item |
hierarchy (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project. Format: int64 Read only: true |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative |
Referenced models: Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item
Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type hierarchy level. |
entityId | JSON | Optional | |
entityId (anyOf 1) | string | Alternative | The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: uuid Read only: true |
entityId (anyOf 2) | null | Alternative | |
issueTypes | JSON | Optional | |
issueTypes (anyOf 1) | array | Alternative | The list of issue types in the hierarchy level. Read only: true |
issueTypes (anyOf 1)[] | Model | Each item | Expand Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item |
issueTypes (anyOf 2) | null | Alternative | |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | integer | Alternative | The level of the issue type hierarchy level. Format: int32 Read only: true |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type hierarchy level. Read only: true |
name (anyOf 2) | null | Alternative |
Referenced models: Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item
Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type. |
avatarId | JSON | Optional | |
avatarId (anyOf 1) | JSON | Alternative | |
avatarId (anyOf 1) (anyOf 1) | integer | Alternative | The avatar of the issue type. Format: int64 Read only: true |
avatarId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
avatarId (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the issue type. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type. Read only: true |
name (anyOf 2) | null | Alternative |
Get project — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a project. |
archived | JSON | Optional | |
archived (anyOf 1) | boolean | Alternative | Whether the project is archived. Read only: true |
archived (anyOf 2) | null | Alternative | |
archivedBy | JSON | Optional | |
archivedBy (anyOf 1) | Model | Alternative | Expand Get user — response body The user who archived the project. Read only: true |
archivedBy (anyOf 2) | null | Alternative | |
archivedDate | JSON | Optional | |
archivedDate (anyOf 1) | JSON | Alternative | |
archivedDate (anyOf 1) (anyOf 1) | string | Alternative | The date when the project was archived. Read only: true |
archivedDate (anyOf 1) (anyOf 2) | integer | Alternative | |
archivedDate (anyOf 2) | null | Alternative | |
assigneeType | JSON | Optional | |
assigneeType (anyOf 1) | string | Alternative | The default assignee when creating issues for this project. Known values: PROJECT_LEAD, UNASSIGNED Read only: true |
assigneeType (anyOf 2) | null | Alternative | |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | Model | Alternative | Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The URLs of the project's avatars. Read only: true |
avatarUrls (anyOf 2) | null | Alternative | |
components | JSON | Optional | |
components (anyOf 1) | array | Alternative | List of the components contained in the project. Read only: true |
components (anyOf 1)[] | Model | Each item | Expand Get component — response body |
components (anyOf 2) | null | Alternative | |
deleted | JSON | Optional | |
deleted (anyOf 1) | boolean | Alternative | Whether the project is marked as deleted. Read only: true |
deleted (anyOf 2) | null | Alternative | |
deletedBy | JSON | Optional | |
deletedBy (anyOf 1) | Model | Alternative | Expand Get user — response body The user who marked the project as deleted. Read only: true |
deletedBy (anyOf 2) | null | Alternative | |
deletedDate | JSON | Optional | |
deletedDate (anyOf 1) | JSON | Alternative | |
deletedDate (anyOf 1) (anyOf 1) | string | Alternative | The date when the project was marked as deleted. Read only: true |
deletedDate (anyOf 1) (anyOf 2) | integer | Alternative | |
deletedDate (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A brief description of the project. Read only: true |
description (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | An email address associated with the project. |
email (anyOf 2) | null | Alternative | |
expand | JSON | Optional | |
expand (anyOf 1) | string | Alternative | Expand options that include additional project details in the response. Read only: true |
expand (anyOf 2) | null | Alternative | |
favourite | JSON | Optional | |
favourite (anyOf 1) | boolean | Alternative | Whether the project is selected as a favorite. |
favourite (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the project. |
id (anyOf 2) | null | Alternative | |
insight | JSON | Optional | |
insight (anyOf 1) | Model | Alternative | Expand Get project — response body — insight Additional details about a project Insights about the project. Read only: true |
insight (anyOf 2) | null | Alternative | |
isPrivate | JSON | Optional | |
isPrivate (anyOf 1) | boolean | Alternative | Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues. Read only: true |
isPrivate (anyOf 2) | null | Alternative | |
issueTypeHierarchy | JSON | Optional | |
issueTypeHierarchy (anyOf 1) | Model | Alternative | Expand Get project — response body — issue Type Hierarchy The project issue type hierarchy The issue type hierarchy for the project. Read only: true |
issueTypeHierarchy (anyOf 2) | null | Alternative | |
issueTypes | JSON | Optional | |
issueTypes (anyOf 1) | array | Alternative | List of the issue types available in the project. Read only: true |
issueTypes (anyOf 1)[] | Model | Each item | Expand Get issue type — response body |
issueTypes (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key of the project. Read only: true |
key (anyOf 2) | null | Alternative | |
landingPageInfo | JSON | Optional | |
landingPageInfo (anyOf 1) | Model | Alternative | Expand Get project — response body — landing Page Info attributes, board Id, board Name, project Key, project Type, queue Category, queue Id, queue Name, simple Board, simplified, url The project landing page info. Read only: true |
landingPageInfo (anyOf 2) | null | Alternative | |
lead | JSON | Optional | |
lead (anyOf 1) | Model | Alternative | Expand Get user — response body The username of the project lead. Read only: true |
lead (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the project. Read only: true |
name (anyOf 2) | null | Alternative | |
permissions | JSON | Optional | |
permissions (anyOf 1) | Model | Alternative | Expand Get project — response body — permissions Permissions which a user has on a project User permissions on the project Read only: true |
permissions (anyOf 2) | null | Alternative | |
projectCategory | JSON | Optional | |
projectCategory (anyOf 1) | Model | Alternative | Expand Create project category — response body The category the project belongs to. Read only: true |
projectCategory (anyOf 2) | null | Alternative | |
projectTypeKey | JSON | Optional | |
projectTypeKey (anyOf 1) | string | Alternative | The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. Known values: software, service_desk, business, product_discovery Read only: true |
projectTypeKey (anyOf 2) | null | Alternative | |
properties | JSON | Optional | |
properties (anyOf 1) | object | Alternative | Map of project properties. Only the properties named in the request's properties query parameter are returned, so this is an empty object when that parameter is omitted. Read only: true Additional keys: see wildcard field |
properties (anyOf 1).* | JSON | Additional keys | Read only: true |
properties (anyOf 2) | null | Alternative | |
retentionTillDate | JSON | Optional | |
retentionTillDate (anyOf 1) | JSON | Alternative | |
retentionTillDate (anyOf 1) (anyOf 1) | string | Alternative | The date when the project is deleted permanently. Read only: true |
retentionTillDate (anyOf 1) (anyOf 2) | integer | Alternative | |
retentionTillDate (anyOf 2) | null | Alternative | |
roles | JSON | Optional | |
roles (anyOf 1) | object | Alternative | 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). Read only: true Additional keys: see wildcard field |
roles (anyOf 1).* | string | Additional keys | Format: uri Read only: true |
roles (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the project details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
simplified | JSON | Optional | |
simplified (anyOf 1) | boolean | Alternative | Whether the project is simplified. Read only: true |
simplified (anyOf 2) | null | Alternative | |
style | JSON | Optional | |
style (anyOf 1) | string | Alternative | The type of the project. Known values: classic, next-gen Read only: true |
style (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | A link to information about this project, such as project documentation. Read only: true |
url (anyOf 2) | null | Alternative | |
uuid | JSON | Optional | |
uuid (anyOf 1) | string | Alternative | Unique ID for next-gen projects. Format: uuid Read only: true |
uuid (anyOf 2) | null | Alternative | |
versions | JSON | Optional | |
versions (anyOf 1) | array | Alternative | The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post). Read only: true |
versions (anyOf 1)[] | Model | Each item | Expand Get version — response body |
versions (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Get project — response body — issue Type Hierarchy The project issue type hierarchy, Get issue type — response body, Create project category — response body, Get component — response body, Get project — response body — insight Additional details about a project, Get project — response body — landing Page Info attributes, board Id, board Name, project Key, project Type, queue Category, queue Id, queue Name, simple Board, simplified, url, Get project — response body — permissions Permissions which a user has on a project, Get user — response body, Get version — response body
Get project — response body — insight Additional details about a project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details about a project. |
lastIssueUpdateTime | JSON | Optional | |
lastIssueUpdateTime (anyOf 1) | JSON | Alternative | |
lastIssueUpdateTime (anyOf 1) (anyOf 1) | string | Alternative | The last issue update time. Read only: true |
lastIssueUpdateTime (anyOf 1) (anyOf 2) | integer | Alternative | |
lastIssueUpdateTime (anyOf 2) | null | Alternative | |
totalIssueCount | JSON | Optional | |
totalIssueCount (anyOf 1) | JSON | Alternative | |
totalIssueCount (anyOf 1) (anyOf 1) | integer | Alternative | Total issue count. Format: int64 Read only: true |
totalIssueCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalIssueCount (anyOf 2) | null | Alternative |
Get project — response body — issue Type Hierarchy The project issue type hierarchy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The project issue type hierarchy. |
baseLevelId | JSON | Optional | |
baseLevelId (anyOf 1) | JSON | Alternative | |
baseLevelId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64 |
baseLevelId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
baseLevelId (anyOf 2) | null | Alternative | |
levels | JSON | Optional | |
levels (anyOf 1) | array | Alternative | Details about the hierarchy level. Read only: true |
levels (anyOf 1)[] | Model | Each item | Expand Get project — response body — issue Type Hierarchy The project issue type hierarchy levels Details about the hierarchy level item |
levels (anyOf 2) | null | Alternative |
Referenced models: Get project — response body — issue Type Hierarchy The project issue type hierarchy levels Details about the hierarchy level item
Get project — response body — issue Type Hierarchy The project issue type hierarchy levels Details about the hierarchy level item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
aboveLevelId | JSON | Optional | |
aboveLevelId (anyOf 1) | JSON | Alternative | |
aboveLevelId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64 |
aboveLevelId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
aboveLevelId (anyOf 2) | null | Alternative | |
belowLevelId | JSON | Optional | |
belowLevelId (anyOf 1) | JSON | Alternative | |
belowLevelId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64 |
belowLevelId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
belowLevelId (anyOf 2) | null | Alternative | |
externalUuid | JSON | Optional | |
externalUuid (anyOf 1) | string | Alternative | The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: uuid |
externalUuid (anyOf 2) | null | Alternative | |
hierarchyLevelNumber | JSON | Optional | |
hierarchyLevelNumber (anyOf 1) | JSON | Alternative | |
hierarchyLevelNumber (anyOf 1) (anyOf 1) | integer | Alternative | Format: int32 |
hierarchyLevelNumber (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hierarchyLevelNumber (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
issueTypeIds | JSON | Optional | |
issueTypeIds (anyOf 1) | array | Alternative | The issue types available in this hierarchy level. |
issueTypeIds (anyOf 1)[] | JSON | Each item | |
issueTypeIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
issueTypeIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issueTypeIds (anyOf 2) | null | Alternative | |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | integer | Alternative | The level of this item in the hierarchy. Format: int32 |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of this hierarchy level. |
name (anyOf 2) | null | Alternative | |
projectConfigurationId | JSON | Optional | |
projectConfigurationId (anyOf 1) | JSON | Alternative | |
projectConfigurationId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64 |
projectConfigurationId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectConfigurationId (anyOf 2) | null | Alternative |
Get project — response body — landing Page Info attributes, board Id, board Name, project Key, project Type, queue Category, queue Id, queue Name, simple Board, simplified, url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attributes | JSON | Optional | |
attributes (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
attributes (anyOf 1).* | string | Additional keys | |
attributes (anyOf 2) | null | Alternative | |
boardId | JSON | Optional | |
boardId (anyOf 1) | JSON | Alternative | |
boardId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
boardId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
boardId (anyOf 2) | null | Alternative | |
boardName | JSON | Optional | |
boardName (anyOf 1) | string | Alternative | |
boardName (anyOf 2) | null | Alternative | |
projectKey | JSON | Optional | |
projectKey (anyOf 1) | string | Alternative | |
projectKey (anyOf 2) | null | Alternative | |
projectType | JSON | Optional | |
projectType (anyOf 1) | string | Alternative | |
projectType (anyOf 2) | null | Alternative | |
queueCategory | JSON | Optional | |
queueCategory (anyOf 1) | string | Alternative | |
queueCategory (anyOf 2) | null | Alternative | |
queueId | JSON | Optional | |
queueId (anyOf 1) | JSON | Alternative | |
queueId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
queueId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
queueId (anyOf 2) | null | Alternative | |
queueName | JSON | Optional | |
queueName (anyOf 1) | string | Alternative | |
queueName (anyOf 2) | null | Alternative | |
simpleBoard | JSON | Optional | |
simpleBoard (anyOf 1) | boolean | Alternative | |
simpleBoard (anyOf 2) | null | Alternative | |
simplified | JSON | Optional | |
simplified (anyOf 1) | boolean | Alternative | |
simplified (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | |
url (anyOf 2) | null | Alternative |
Get project — response body — permissions Permissions which a user has on a project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Permissions which a user has on a project. |
canEdit | JSON | Optional | |
canEdit (anyOf 1) | boolean | Alternative | Whether the logged user can edit the project. Read only: true |
canEdit (anyOf 2) | null | Alternative |
Get projects paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get project — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get project — response body
Update project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the project. Additional keys: not allowed |
assigneeType | string | Optional | The default assignee when creating issues for this project. One of: PROJECT_LEAD, UNASSIGNED |
avatarId | integer | Optional | An integer value for the project's avatar. Format: int64 |
categoryId | integer | Optional | The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. To remove the project category from the project, set the value to `-1.` Format: int64 |
description | string | Optional | A brief description of the project. |
issueSecurityScheme | integer | Optional | The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs. Format: int64 |
key | string | Optional | Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. |
lead | string | Optional | This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Cannot be provided with `leadAccountId`. |
leadAccountId | string | Optional | The account ID of the project lead. Cannot be provided with `lead`. Maximum length: 128 |
name | string | Optional | The name of the project. |
notificationScheme | integer | Optional | The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs. Format: int64 |
permissionScheme | integer | Optional | The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs. Format: int64 |
releasedProjectKeys | array | Optional | Previous project keys to be released from the current project. Released keys must belong to the current project and not contain the current project key Unique items: true |
releasedProjectKeys[] | string | Each item | |
url | string | Optional | A link to information about this project, such as project documentation |