Ctrl K

Check Issues Against JQL

Published Nov 2, 2023

Check which of the given issues match each of one or more JQL queries. Takes numeric issue IDs (not keys) and returns, per query, the matched IDs.

Script jira Verified

Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)

Verified 8 days ago

All edits

Permalink

//native

/**
 * Check Issues Against JQL
 * Check which of the given issues match each of one or more JQL queries. Takes numeric issue IDs (not keys) and returns, per query, the matched IDs.
 */
export async function main(auth: RT.Jira, issue_ids: number[], jqls: string[]) {
  const url = new URL(
    `https://${auth.domain}.atlassian.net/rest/api/3/jql/match`
  )

  const response = await fetch(url, {
    method: "POST",
    headers: {
      Authorization: `Basic ${btoa(`${auth.username}:${auth.password}`)}`,
      "Content-Type": "application/json",
      Accept: "application/json",
    },
    body: JSON.stringify({ issueIds: issue_ids, jqls }),
  })

  if (!response.ok) {
    throw new Error(`${response.status} ${await response.text()}`)
  }

  return await response.json()
}


Other submissions

Submitted by hugo697 Typescript (fetch-only)

Created 532 days ago

All edits

Permalink

type Jira = {
  username: string;
  password: string;
  domain: string;
};
/**
 * Check issues against JQL
 * Checks whether one or more issues would be returned by one or more JQL queries.

**[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has:

 *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
 *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
 */
export async function main(
  auth: Jira,
  body: { issueIds: number[]; jqls: string[] }
) {
  const url = new URL(
    `https://${auth.domain}.atlassian.net/rest/api/2/jql/match`
  );

  const response = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
    },
    body: JSON.stringify(body),
  });
  if (!response.ok) {
    const text = await response.text();
    throw new Error(`${response.status} ${text}`);
  }
  return await response.json();
}


`1`	`//native`
`2`
`3`	`/**`
`4`	`* Check Issues Against JQL`
`5`	`* Check which of the given issues match each of one or more JQL queries. Takes numeric issue IDs (not keys) and returns, per query, the matched IDs.`
`6`	`*/`
`7`	`export async function main(auth: RT.Jira, issue_ids: number[], jqls: string[]) {`
`8`	`const url = new URL(`
`9`	`https://${auth.domain}.atlassian.net/rest/api/3/jql/match`
`10`	`)`
`11`
`12`	`const response = await fetch(url, {`
`13`	`method: "POST",`
`14`	`headers: {`
`15`	Authorization: `Basic ${btoa(`${auth.username}:${auth.password}`)}`,
`16`	`"Content-Type": "application/json",`
`17`	`Accept: "application/json",`
`18`	`},`
`19`	`body: JSON.stringify({ issueIds: issue_ids, jqls }),`
`20`	`})`
`21`
`22`	`if (!response.ok) {`
`23`	throw new Error(`${response.status} ${await response.text()}`)
`24`	`}`
`25`
`26`	`return await response.json()`
`27`	`}`
`28`

`1`	`type Jira = {`
`2`	`username: string;`
`3`	`password: string;`
`4`	`domain: string;`
`5`	`};`
`6`	`/**`
`7`	`* Check issues against JQL`
`8`	`* Checks whether one or more issues would be returned by one or more JQL queries.`
`9`
`10`	`[Permissions](#permissions) required: None, however, issues are only matched against JQL queries where the user has:`
`11`
`12`	`* Browse projects [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.`
`13`	`* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.`
`14`	`*/`
`15`	`export async function main(`
`16`	`auth: Jira,`
`17`	`body: { issueIds: number[]; jqls: string[] }`
`18`	`) {`
`19`	`const url = new URL(`
`20`	`https://${auth.domain}.atlassian.net/rest/api/2/jql/match`
`21`	`);`
`22`
`23`	`const response = await fetch(url, {`
`24`	`method: "POST",`
`25`	`headers: {`
`26`	`"Content-Type": "application/json",`
`27`	Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
`28`	`},`
`29`	`body: JSON.stringify(body),`
`30`	`});`
`31`	`if (!response.ok) {`
`32`	`const text = await response.text();`
`33`	throw new Error(`${response.status} ${text}`);
`34`	`}`
`35`	`return await response.json();`
`36`	`}`
`37`