name: Atlassian Domain Vocabulary provider: Atlassian providerId: atlassian description: Tag-derived vocabulary for the Atlassian API surface; sourced from openapi/ tags. terms: - term: Announcement Banner - term: App Data Policies (EAP) description: This resource represents app access rule data policies. - term: App Migration - term: App Properties - term: Application Roles - term: Audit Records - term: Avatars description: This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project or issue type, and obtain avatar images. - term: Classification Levels - term: Dashboards description: This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards. - term: Dynamic Modules description: 'This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/) by [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).' - term: Filter Sharing description: This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters. - term: Filters description: This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters. - term: Group and User Picker - term: Groups description: This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.) - term: Issue Attachments - term: Issue Comment Properties - term: Issue Comments - term: Issue Custom Field Configuration (Apps) - term: Issue Custom Field Contexts - term: Issue Custom Field Options - term: Issue Custom Field Options (Apps) - term: Issue Custom Field Values (Apps) - term: Issue Field Configurations - term: Issue Fields - term: Issue Link Types - term: Issue Links - term: Issue Navigator Settings - term: Issue Notification Schemes - term: Issue Priorities - term: Issue Properties - term: Issue Remote Links - term: Issue Resolutions - term: Issue Search - term: Issue Security Level description: This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg). - term: Issue Security Schemes - term: Issue Type Properties - term: Issue Type Schemes - term: Issue Type Screen Schemes - term: Issue Types - term: Issue Votes - term: Issue Watchers - term: Issue Worklog Properties - term: Issue Worklogs - term: Issues description: "This resource represents Jira issues. Use it to:\n\n * create or edit issues, individually or in bulk.\n\ \ * retrieve metadata about the options for creating or editing issues.\n * delete an issue.\n * assign a user to an\ \ issue.\n * get issue changelogs.\n * send notifications about an issue.\n * get details of the transitions available\ \ for an issue.\n * transition an issue.\n * Archive issues.\n * Unarchive issues.\n * Export archived issues." - term: Jira Expressions - term: Jira Settings - term: JQL description: "This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data\ \ and suggestions for use in programmatic construction of queries or custom query builders. It also provides operations\ \ to:\n\n * convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with\ \ account IDs.\n * convert readable details in one or more JQL queries to IDs where a user doesn't have permission to\ \ view the entity whose details are readable." - term: JQL Functions (Apps) description: This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and update precomputations. - term: Labels description: This resource represents available labels. Use it to get available labels for the global label field. - term: License Metrics - term: Myself description: This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale. - term: Permission Schemes - term: Permissions description: This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions. - term: Project Avatars description: This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars. - term: Project Categories description: This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see [Adding, assigning, and deleting project categories](https://confluence.atlassian.com/x/-A5WMg). - term: Project Classification Levels description: This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects. - term: Project Components description: This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component. - term: Project Email - term: Project Features description: This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects. - term: Project Key and Name Validation description: This resource provides validation for project keys and names. - term: Project Permission Schemes description: "This resource represents permission schemes for a project. Use this resource to:\n\n * get details of a project's\ \ issue security levels available to the calling user.\n * get the permission scheme associated with the project or assign\ \ different permission scheme to the project.\n * get details of a project's issue security scheme.\n\nSee [Managing\ \ project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes." - term: Project Properties description: This resource represents [project](#api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/). - term: Project Role Actors description: This resource represents the users assigned to [project roles](#api-group-Issue-comments). Use it to get, add, and remove default users from project roles. Also use it to add and remove users from a project role associated with a project. - term: Project Roles description: This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles. - term: Project Types description: This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type. - term: Project Versions description: This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version. - term: Projects description: This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type. - term: Screen Schemes description: This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes. - term: Screen Tab Fields description: This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs. - term: Screen Tabs description: This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs. - term: Screens description: "This resource represents the screens used to record issue details. Use it to:\n\n * get details of all screens.\n\ \ * get details of all the fields available for use on screens.\n * create screens.\n * delete screens.\n * update\ \ screens.\n * add a field to the default screen." - term: Server Info description: This resource provides information about the Jira instance. - term: Service Registry description: This resource represents a service registry. Use it to retrieve attributes related to a [service registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/) in JSM. - term: Status - term: Tasks description: This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task. - term: Time Tracking description: This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking. - term: UI Modifications (Apps) description: 'UI modifications is a feature available for **Forge apps only**. It enables Forge apps to control how selected Jira fields behave on the following views: global issue create, issue view. For example: hide specific fields, set them as required, etc.' - term: User Properties description: 'This resource represents [user](#api-group-Users) properties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user. This resourse is designed for integrations and apps to store per-user data and settings. This enables data used to customized the user experience to be kept in the Jira Cloud instance''s database. User properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/). This resource does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.' - term: User Search description: This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users. - term: Users description: "This resource represent users. Use it to:\n\n * get, get a list of, create, and delete users.\n * get, set,\ \ and reset a user's default issue table columns.\n * get a list of the groups the user belongs to.\n * get a list of\ \ user account IDs for a list of usernames or user keys." - term: Webhooks description: This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps). - term: Workflow Scheme Drafts - term: Workflow Scheme Project Associations - term: Workflow Schemes - term: Workflow Status Categories - term: Workflow Statuses - term: Workflow Transition Properties - term: Workflow Transition Rules - term: Workflows description: "This resource represents workflows. Use it to:\n\n * Get workflows\n * Create workflows\n * Update workflows\n\ \ * Delete inactive workflows\n * Get workflow capabilities"