nodes/generated

Interface JiraNodeParameters

Source
interface JiraNodeParameters {
    accountId?: string;
    additionalFields?:
        | {
            assignee?: { mode: "id"
            | "list"; value: string };
            componentIds?: unknown[];
            customFieldsUi?: {
                customFieldsValues: {
                    fieldId?: { mode: "id" | "list"; value: string };
                    fieldValue?: string;
                }[];
            };
            description?: string;
            labels?: unknown[];
            parentIssueKey?: string;
            priority?: { mode: "id"
            | "list"; value: string };
            reporter?: { mode: "id" | "list"; value: string };
            serverLabels?: string;
            updateHistory?: boolean;
        }
        | {
            expand?: string;
            fields?: string;
            fieldsByKey?: boolean;
            properties?: string;
            updateHistory?: boolean;
        }
        | {
            htmlBody?: string;
            subject?: string;
            textBody?: string;
        }
        | {
            expand?: string;
            skipRemoteOnlyCondition?: boolean;
            transitionId?: string;
        }
        | { notification?: boolean; password?: string }
        | { expand?: ("groups" | "applicationRoles")[] };
    attachmentId?: string;
    binaryProperty?: string;
    binaryPropertyName?: string;
    comment?: string;
    commentId?: string;
    commentJson?: string;
    deleteSubtasks?: boolean;
    displayName?: string;
    download?: boolean;
    emailAddress?: string;
    issueKey?: string;
    issueType?: { mode: "id" | "list"; value: string };
    jiraVersion?: "cloud" | "server" | "serverPat";
    jsonParameters?: boolean;
    limit?: number;
    notificationRecipientsJson?: string;
    notificationRecipientsRestrictionsJson?: string;
    notificationRecipientsRestrictionsUi?: {
        notificationRecipientsRestrictionsValues: {
            groups?: unknown[];
            users?: unknown[];
        };
    };
    notificationRecipientsUi?: {
        notificationRecipientsValues: {
            assignee?: boolean;
            groups?: unknown[];
            reporter?: boolean;
            users?: unknown[];
            voters?: boolean;
            watchers?: boolean;
        };
    };
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "changelog"
    | "notify"
    | "transitions";
    options?: | {
        expand?: (
            | "names"
            | "operations"
            | "changelog"
            | "transitions"
            | "editmeta"
            | "renderedFields"
            | "schema"
            | "versionedRepresentations"
        )[];
        fields?: string;
        fieldsByKey?: boolean;
        jql?: string;
    }
    | { expand?: "renderedBody"; wikiMarkup?: boolean }
    | { expand?: "renderedBody" }
    | {
        expand?: "renderedBody";
        orderBy?: "+created" | "-created";
    };
    project?: { mode: "id"
    | "list"; value: string };
    resource?:
        | "user"
        | "issue"
        | "issueAttachment"
        | "issueComment";
    returnAll?: boolean;
    simplifyOutput?: boolean;
    summary?: string;
    updateFields?: {
        assignee?: { mode: "id"
        | "list"; value: string };
        customFieldsUi?: {
            customFieldsValues: {
                fieldId?: { mode: "id" | "list"; value: string };
                fieldValue?: string;
            }[];
        };
        description?: string;
        issueType?: string;
        labels?: unknown[];
        parentIssueKey?: string;
        priority?: { mode: "id"
        | "list"; value: string };
        reporter?: { mode: "id" | "list"; value: string };
        serverLabels?: string;
        statusId?: { mode: "id" | "list"; value: string };
        summary?: string;
    };
    username?: string;
}

Properties§

§readonly accountId?: string

Account ID of the user to delete

§readonly additionalFields?:
    | {
        assignee?: { mode: "id"
        | "list"; value: string };
        componentIds?: unknown[];
        customFieldsUi?: {
            customFieldsValues: {
                fieldId?: { mode: "id" | "list"; value: string };
                fieldValue?: string;
            }[];
        };
        description?: string;
        labels?: unknown[];
        parentIssueKey?: string;
        priority?: { mode: "id"
        | "list"; value: string };
        reporter?: { mode: "id" | "list"; value: string };
        serverLabels?: string;
        updateHistory?: boolean;
    }
    | {
        expand?: string;
        fields?: string;
        fieldsByKey?: boolean;
        properties?: string;
        updateHistory?: boolean;
    }
    | {
        htmlBody?: string;
        subject?: string;
        textBody?: string;
    }
    | {
        expand?: string;
        skipRemoteOnlyCondition?: boolean;
        transitionId?: string;
    }
    | { notification?: boolean; password?: string }
    | { expand?: ("groups" | "applicationRoles")[] }

Default: {}

§readonly attachmentId?: string

The ID of the attachment

§readonly binaryProperty?: string

Default: "data"

§readonly binaryPropertyName?: string

Default: "data"

§readonly comment?: string

Comment's text

§readonly commentId?: string

The ID of the comment

§readonly commentJson?: string

The Atlassian Document Format (ADF). Online builder can be found here.

§readonly deleteSubtasks?: boolean
§readonly displayName?: string
§readonly download?: boolean
§readonly emailAddress?: string
§readonly issueKey?: string
§readonly issueType?: { ... }

Default: {"mode":"list","value":""}

§readonly jiraVersion?: "cloud" | "server" | "serverPat"

Default: "cloud"

§readonly jsonParameters?: boolean
§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

§readonly notificationRecipientsJson?: string

The recipients of the email notification for the issue Type options: {"alwaysOpenEditWindow":true}

§readonly notificationRecipientsRestrictionsJson?: string

Restricts the notifications to users with the specified permissions Type options: {"alwaysOpenEditWindow":true}

§readonly notificationRecipientsRestrictionsUi?: { ... }

Restricts the notifications to users with the specified permissions Default: {} Type options: {"multipleValues":false}

§readonly notificationRecipientsUi?: { ... }

The recipients of the email notification for the issue Default: {} Type options: {"multipleValues":false}

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "changelog"
    | "notify"
    | "transitions"

Default: "create"

§readonly options?:
    | {
        expand?: (
            | "names"
            | "operations"
            | "changelog"
            | "transitions"
            | "editmeta"
            | "renderedFields"
            | "schema"
            | "versionedRepresentations"
        )[];
        fields?: string;
        fieldsByKey?: boolean;
        jql?: string;
    }
    | { expand?: "renderedBody"; wikiMarkup?: boolean }
    | { expand?: "renderedBody" }
    | {
        expand?: "renderedBody";
        orderBy?: "+created" | "-created";
    }

Default: {}

§readonly project?: { ... }

Default: {"mode":"list","value":""}

§readonly resource?: "user" | "issue" | "issueAttachment" | "issueComment"

Default: "issue"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly simplifyOutput?: boolean

Whether to return a simplified version of the response instead of the raw data

§readonly summary?: string
§readonly updateFields?: { ... }

Default: {}

§readonly username?: string