jira.js
    Preparing search index...

    Function createIssue

    • Creates an issue or a sub-task from a JSON representation. The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted. Creating a sub-task is similar to creating a regular issue, with two important differences:

      • The issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and
      • You must provide a parent field in the issue create request containing the id or key of the parent issue. The updateHistory param adds the project that this issue is created in, to the current user's project history, if set to true (by default, the project history is not updated). You can view the project history in the Jira application, via the Projects dropdown.

      Parameters

      • client: Client
      • parameters: {
            fields?: Record<string, any>;
            historyMetadata?: {
                activityDescription?: string;
                activityDescriptionKey?: string;
                actor?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                cause?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                description?: string;
                descriptionKey?: string;
                emailDescription?: string;
                emailDescriptionKey?: string;
                extraData?: Record<string, string>;
                generator?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                type?: string;
                [key: string]: unknown;
            };
            properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
            transition?: {
                description?: string;
                fields?: Record<
                    string,
                    {
                        allowedValues?: Record<string, any>[];
                        autoCompleteUrl?: string;
                        defaultValue?: Record<string, any>;
                        fieldId?: string;
                        hasDefaultValue?: boolean;
                        name?: string;
                        operations?: string[];
                        required?: boolean;
                        schema?: {
                            custom?: string;
                            customId?: number;
                            items?: string;
                            system?: string;
                            type?: string;
                            [key: string]: unknown;
                        };
                        [key: string]: unknown;
                    },
                >;
                id?: string;
                name?: string;
                opsbarSequence?: number;
                to?: {
                    description?: string;
                    iconUrl?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    statusCategory?: {
                        colorName?: string;
                        id?: number;
                        key?: string;
                        name?: string;
                        self?: string;
                        [key: string]: unknown;
                    };
                    statusColor?: string;
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            update?: Record<
                string,
                {
                    operation?: string;
                    value?: Record<string, any>;
                    [key: string]: unknown;
                }[],
            >;
            updateHistory?: boolean;
        }
      • Optionaloptions: RequestOptions

      Returns Promise<{ id?: string; key?: string; self?: string; [key: string]: unknown }>

    Settings
    Member Visibility