Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/version3/parameters/getNotificationSchemes.ts>GetNotificationSchemes

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetNotificationSchemes
import { type GetNotificationSchemes } from "https://deno.land/x/jira@v3.0.2/src/version3/parameters/getNotificationSchemes.ts";

Properties

optional
startAt: number

The index of the first item to return in a page of results (page offset).

optional
maxResults: number

The maximum number of items to return per page.

optional
id: string[]

The list of notification schemes IDs to be filtered by

optional
projectId: string[]

The list of projects IDs to be filtered by

optional
onlyDefault: boolean

When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false.

optional
expand:
| "all"
| "field"
| "group"
| "notificationSchemeEvents"
| "projectRole"
| "user"
| (
| "all"
| "field"
| "group"
| "notificationSchemeEvents"
| "projectRole"
| "user"
)[]
| string
| string[]

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • all Returns all expandable information
  • field Returns information about any custom fields assigned to receive an event
  • group Returns information about any groups assigned to receive an event
  • notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
  • projectRole Returns information about any project roles assigned to receive an event
  • user Returns information about any users assigned to receive an event