Jira

opencollection: 1.0.0
info:
  name: Jira Cloud Platform REST API
  version: '3'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Issues
    type: folder
  items:
  - info:
      name: Jira Create Issue
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/rest/api/3/issue
      params:
      - name: updateHistory
        value: 'true'
        type: query
        description: Whether the project in which the issue is created is added to the user's Recently viewed project list,
          as shown under Projects in Jira.
      body:
        type: json
        data: '{}'
    docs: Creates an issue or a sub-task from a JSON representation. The fields that can be set on an issue depend on the
      connected Jira instance configuration, the project, and the issue type. You can determine appropriate field values using
      the Create Issue Metadata endpoint.
  - info:
      name: Jira Get Issue
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: fields
        value: ''
        type: query
        description: A list of fields to return for the issue. Use it to retrieve a subset of fields. Allowed values include
          any field name, *all for all fields, *navigable for navigable fields.
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information in the response. Accepted values: renderedFields, names,
          schema, transitions, operations, editmeta, changelog, versionedRepresentations, fields.'
      - name: properties
        value: ''
        type: query
        description: A list of issue properties to return for the issue. By default no properties are returned.
      - name: fieldsByKeys
        value: 'true'
        type: query
        description: Whether fields in fields are referenced by keys rather than IDs.
    docs: Returns the details for an issue. The issue is identified by its ID or key. The returned issue includes all fields,
      comment count, names, schema, transitions, editmeta, changelog, and rendered fields.
  - info:
      name: Jira Edit Issue
      type: http
    http:
      method: PUT
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: notifyUsers
        value: 'true'
        type: query
        description: Whether a notification email about the issue update is sent to all watchers. Requires administer Jira
          global permission.
      - name: overrideScreenSecurity
        value: 'true'
        type: query
        description: Whether screen security is overridden to enable hidden fields to be edited. Requires administer Jira
          global permission.
      - name: overrideEditableFlag
        value: 'true'
        type: query
        description: Whether the non-editable flag is overridden to enable uneditable fields to be edited. Requires administer
          Jira global permission.
      body:
        type: json
        data: '{}'
    docs: Edits an issue. A transition may be applied and issue properties updated as part of the edit. The editable fields
      depend on the connected Jira instance configuration, the project, and the issue type.
  - info:
      name: Jira Delete Issue
      type: http
    http:
      method: DELETE
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: deleteSubtasks
        value: 'true'
        type: query
        description: Whether the issue's sub-tasks are also deleted.
    docs: Deletes an issue. An issue can only be deleted if it has no sub-tasks, unless deleteSubtasks is set to true.
- info:
    name: Issue Transitions
    type: folder
  items:
  - info:
      name: Jira Get Transitions
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey/transitions
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information about transitions in the response. Accepted values: transitions.fields.'
      - name: transitionId
        value: '500123'
        type: query
        description: The ID of the transition.
      - name: skipRemoteOnlyCondition
        value: 'true'
        type: query
        description: Whether transitions with the condition Hide From User Condition are included in the response.
      - name: includeUnavailableTransitions
        value: 'true'
        type: query
        description: Whether details of transitions that fail a condition are included.
    docs: Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's
      status.
  - info:
      name: Jira Transition Issue
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey/transitions
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      body:
        type: json
        data: '{}'
    docs: Performs an issue transition and, optionally, updates the fields and adds a comment. The fields that can be set
      depend on the transition and the connected Jira instance configuration.
- info:
    name: Issue Comments
    type: folder
  items:
  - info:
      name: Jira Get Comments
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey/comment
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: startAt
        value: '10'
        type: query
        description: The index of the first item to return in a page of results (page offset).
      - name: maxResults
        value: '10'
        type: query
        description: The maximum number of items to return per page.
      - name: orderBy
        value: created
        type: query
        description: 'The order of comments returned. Accepted values: created (ascending by default), -created (descending).'
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information about comments in the response. Accepted values: renderedBody.'
    docs: Returns all comments for an issue. Comments are ordered by created date in ascending order by default.
  - info:
      name: Jira Add Comment
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/rest/api/3/issue/:issueIdOrKey/comment
      params:
      - name: issueIdOrKey
        value: PROJ-123
        type: path
        description: The ID or key of the issue (e.g., 10001 or PROJ-123).
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information about comments in the response. Accepted values: renderedBody.'
      body:
        type: json
        data: '{}'
    docs: Adds a comment to an issue. The comment body uses Atlassian Document Format (ADF).
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: Jira Get All Projects
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/project
      params:
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information in the response. Accepted values: description, issueTypes,
          lead, projectKeys, url.'
      - name: recent
        value: '10'
        type: query
        description: Returns projects the user has accessed in the last given number of projects, up to 20.
      - name: properties
        value: ''
        type: query
        description: A list of project properties to return for each project.
    docs: Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.
  - info:
      name: Jira Get Projects Paginated
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/project/search
      params:
      - name: startAt
        value: '10'
        type: query
        description: The index of the first item to return in a page of results (page offset).
      - name: maxResults
        value: '10'
        type: query
        description: The maximum number of items to return per page.
      - name: orderBy
        value: example_value
        type: query
        description: 'Order the results by a field. Accepted values: category, key, name, owner, issueCount, lastIssueUpdatedTime,
          archivedDate. Prefix with + or - for ascending/descending.'
      - name: query
        value: example_value
        type: query
        description: Filter results using a literal string match on project name or key.
      - name: typeKey
        value: example_value
        type: query
        description: 'The type key of the project. Accepted values: business, service_desk, software.'
      - name: categoryId
        value: '500123'
        type: query
        description: The ID of the project category to filter by.
      - name: action
        value: example_value
        type: query
        description: 'Filter results by what the user has permission to do. Accepted values: view, browse, edit, create.'
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information in the response. Accepted values: description, projectKeys,
          lead, issueTypes, url, insight.'
      - name: status
        value: ''
        type: query
        description: 'The status of the project. Accepted values: live, archived, deleted.'
    docs: Returns a paginated list of projects visible to the user. This operation can be filtered by project type, category,
      and action.
  - info:
      name: Jira Get Project
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/project/:projectIdOrKey
      params:
      - name: projectIdOrKey
        value: PROJ
        type: path
        description: The ID or key of the project (e.g., 10000 or PROJ).
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information in the response. Accepted values: description, issueTypes,
          lead, projectKeys, url, insight.'
      - name: properties
        value: ''
        type: query
        description: A list of project properties to return for the project.
    docs: Returns the project details for a project. The returned project includes additional information such as issue types,
      components, versions, and roles.
- info:
    name: Issue Statuses
    type: folder
  items:
  - info:
      name: Jira Get All Statuses for Project
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/project/:projectIdOrKey/statuses
      params:
      - name: projectIdOrKey
        value: PROJ
        type: path
        description: The ID or key of the project (e.g., 10000 or PROJ).
    docs: Returns the valid statuses for a project. The statuses are grouped by issue type, listing the allowed statuses for
      each issue type in the project.
- info:
    name: Issue Search
    type: folder
  items:
  - info:
      name: Jira Search for Issues Using Jql (get)
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/search
      params:
      - name: jql
        value: project = PROJ AND status = Open ORDER BY created DESC
        type: query
        description: 'The JQL query string. For example: project = HSP AND issuetype = Bug. See JQL documentation for syntax.'
      - name: startAt
        value: '10'
        type: query
        description: The index of the first item to return in a page of results (page offset).
      - name: maxResults
        value: '10'
        type: query
        description: The maximum number of items to return per page. The maximum allowed value is determined by the Jira instance
          configuration, typically 100.
      - name: validateQuery
        value: strict
        type: query
        description: 'Whether to validate the JQL query and how to handle validation results. Accepted values: strict, warn,
          none.'
      - name: fields
        value: ''
        type: query
        description: A list of fields to return for each issue. Use *all for all fields, *navigable for navigable fields only.
      - name: expand
        value: example_value
        type: query
        description: 'Use expand to include additional information about issues in the response. Accepted values: renderedFields,
          names, schema, transitions, operations, editmeta, changelog, versionedRepresentations.'
      - name: properties
        value: ''
        type: query
        description: A list of issue properties to return for each issue.
      - name: fieldsByKeys
        value: 'true'
        type: query
        description: Whether fields in fields are referenced by keys rather than IDs.
    docs: Searches for issues using JQL. If the JQL query expression is too large to be encoded as a query parameter, use
      the POST version of this resource. Sorting is supported via the ORDER BY clause in JQL.
  - info:
      name: Jira Search for Issues Using Jql (post)
      type: http
    http:
      method: POST
      url: https://{domain}.atlassian.net/rest/api/3/search
      body:
        type: json
        data: '{}'
    docs: Searches for issues using JQL. Use this endpoint when the JQL query expression is too large to send as a query parameter.
      This provides the same functionality as the GET version.
- info:
    name: Issue Types
    type: folder
  items:
  - info:
      name: Jira Get All Issue Types for User
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/issuetype
    docs: Returns all issue types visible to the user. The list of issue types returned depends on the user's permissions.
- info:
    name: Issue Priorities
    type: folder
  items:
  - info:
      name: Jira Get Priorities
      type: http
    http:
      method: GET
      url: https://{domain}.atlassian.net/rest/api/3/priority
    docs: Returns the list of all issue priorities.
bundled: true