Interface CreateVersion

Details about a project version.

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

Hierarchy (view full)

Properties

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

Properties

Optional archived

archived?: boolean

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

Optional description

description?: string

The description of the version. Optional when creating or updating a version.

Optional expand

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

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.

Optional for create and update.

Optional id

id?: string

The ID of the version.

Optional issuesStatusForFixVersion

issuesStatusForFixVersion?: Version2.Version2Models.VersionIssuesStatus

Optional moveUnfixedIssuesTo

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.

Optional name

name?: string

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

Optional operations

operations?: Version2.Version2Models.SimpleLink[]

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

Optional overdue

overdue?: boolean

Indicates that the version is overdue.

projectId

projectId: number

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

Optional releaseDate

releaseDate?: string

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

Optional released

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.

Optional self

self?: string

The URL of the version.

Optional startDate

startDate?: string

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

Optional userReleaseDate

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.

Optional userStartDate

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

Theme

On This Page

archiveddescriptionexpandidissuesStatusForFixVersionmoveUnfixedIssuesTonameoperationsoverdueprojectIdreleaseDatereleasedselfstartDateuserReleaseDateuserStartDate