Jira.js - Jira Cloud API library
    Preparing search index...

    Interface UpdateVersion

    Details about a project version.

    interface UpdateVersion {
        approvers?: VersionApprover[];
        archived?: boolean;
        description?: string;
        driver?: string;
        expand?:
            | string
            | string[]
            | ("operations" | "issuesstatus" | "driver" | "approvers")[];
        id: string;
        issuesStatusForFixVersion?: Version3Models.VersionIssuesStatus;
        moveUnfixedIssuesTo?: string;
        name?: string;
        operations?: Version3Models.SimpleLink[];
        overdue?: boolean;
        projectId?: string | number;
        released?: boolean;
        releaseDate?: string;
        self?: string;
        startDate?: string;
        userReleaseDate?: string;
        userStartDate?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approvers? archived? description? driver? expand? id issuesStatusForFixVersion? moveUnfixedIssuesTo? name? operations? overdue? projectId? released? releaseDate? self? startDate? userReleaseDate? userStartDate?

    Properties

    approvers?: VersionApprover[]

    If the expand option approvers is used, returns a list containing the approvers for this version.

    archived?: boolean

    Indicates that the version is archived. Optional when creating or updating a version.

    description?: string

    The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

    driver?: string

    If the expand option driver is used, returns the Atlassian account ID of the driver.

    expand?:
        | string
        | string[]
        | ("operations" | "issuesstatus" | "driver" | "approvers")[]

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

    • operations Returns the list of operations available for this version.
    • issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
    • driver Returns the Atlassian account ID of the version driver.
    • approvers Returns a list containing approvers for this version.

    Optional for create and update.

    id: string

    The ID of the version.

    issuesStatusForFixVersion?: Version3Models.VersionIssuesStatus
    moveUnfixedIssuesTo?: string

    The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

    name?: string

    The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

    operations?: Version3Models.SimpleLink[]

    If the expand option operations is used, returns the list of operations available for this version.

    overdue?: boolean

    Indicates that the version is overdue.

    projectId?: string | number

    The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

    released?: boolean

    Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

    releaseDate?: string

    The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

    self?: string

    The URL of the version.

    startDate?: string

    The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

    userReleaseDate?: string

    The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

    userStartDate?: string

    The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

    Settings

    Member Visibility

    On This Page

    Properties