Class: Version

Version

new Version()

Version

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

create(options, callbackopt) → {Promise.<any>}

Create a version via POST.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

description string

description

name string

name

archived string

archived

released string

released

overdue string

overdue

userStartDate string

userStartDate

userReleaseDate string

userReleaseDate

project string

project

projectId string

projectId

moveUnfixedIssuesTo string

moveUnfixedIssuesTo

operations string

operations

remotelinks string

remotelinks

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

Create a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
versionId string

versionId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

delete(options, callbackopt) → {Promise.<any>}

Delete a project version.The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

moveFixIssuesTo string

moveFixIssuesTo The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.

moveAffectedIssuesTo string

moveAffectedIssuesTo The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteRemoteVersionLinksByVersionId(options, callbackopt) → {Promise.<any>}

Delete all remote version links for a given version ID.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
versionId string

versionId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

findById(options, callbackopt) → {Promise.<any>}

Returns a project version.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

expand string

expand

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

Returns the remote version links for a given global ID.the global ID of the remote resource that is linked to the versions

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
globalId string

globalId the global ID of the remote resource that is linked to the versions

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getRemoteVersionLinksByVersionId(options, callbackopt) → {Promise.<any>}

Returns the remote version links associated with the given version ID.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
versionId string

versionId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getVersionRelatedIssues(options, callbackopt) → {Promise.<any>}

Returns a bean containing the number of fixed in and affected issues for the given version.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getVersionUnresolvedIssues(options, callbackopt) → {Promise.<any>}

Returns the number of unresolved issues for the given version

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

merge(options, callbackopt) → {Promise.<any>}

Merge versions

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

moveIssuesTo string

moveIssuesTo

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

moveVersion(options, callbackopt) → {Promise.<any>}

Modify a version's sequence within a project.

The move version bean has 2 alternative field value pairs:

positionAn absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later' afterA version to place this version after. The value should be the self link of another version

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

after string

after

position string

position

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

update(options, callbackopt) → {Promise.<any>}

Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

description string

description

name string

name

archived string

archived

released string

released

overdue string

overdue

userStartDate string

userStartDate

userReleaseDate string

userReleaseDate

project string

project

projectId string

projectId

moveUnfixedIssuesTo string

moveUnfixedIssuesTo

operations string

operations

remotelinks string

remotelinks

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>