Issue

To interact with issues, the issueService object is defined.

The issue entity contains the following data:

class Issue {...}

Name	Data Type	Description
id	string	Issue UUID
localId	number	Issue number in the project
projectId	string	Project UUID
title	string	Issue title
description	string	Issue description
status	string	Issue status. Possible values: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority	string	Issue priority. Possible values: LOW, MIDDLE, HIGH, EXTREME
authorId	string	Issue author's UUID
assignedUserIds	string[]	List of UUIDs of users responsible for the issue
labelIds	string[]	List of label UUIDs

Methods for Working with Issues

The following methods exist for working with the issue entity:

Creating an Issue

issueService.create(toCreate: Issue) => Issue

This method creates an issue and returns it. You need to provide the following values:

Name	Data Type	Description
projectId	string	Project UUID where the issue will be created
title	string	Issue title
description	string	Issue description
status	string	Issue status. Possible values: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority	string	Issue priority. Possible values: LOW, MIDDLE, HIGH, EXTREME
assignedUserIds	string[]	List of UUIDs of users responsible for the issue
labelIds	string[]	List of label UUIDs

Editing an Issue

issueService.edit(toEdit: Issue) => Issue

This method edits an issue and returns it. You need to provide the following values:

Name	Data Type	Description
projectId	string	Project UUID where the issue will be updated
id	string	Issue UUID
title	string	Issue title
description	string	Issue description
status	string	Issue status. Possible values: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority	string	Issue priority. Possible values: LOW, MIDDLE, HIGH, EXTREME
assignedUserIds	string[]	List of UUIDs of users responsible for the issue
labelIds	string[]	List of label UUIDs

Getting a List of All Issues

issueService.getAll({projectId}, {startPage}, {pageSize}) => Page<Issue>

This method returns an object with all issues in a project. You need to provide the following values:

Name	Data Type	Description
projectId	string	Project UUID to search in
startPage	number	Requested page number
pageSize	number	Page size

Getting a List of All Issues with a Specified Status

issueService.getAllWithStatus({projectId}, {startPage}, {pageSize}, {status}) => Page<Issue>

This method returns an object containing issues with the specified status in the project. You need to provide the following values:

Name	Data Type	Description
projectId	string	Project UUID to search in
startPage	number	Requested page number
pageSize	number	Page size
status	string	Issue status. Possible values: OPEN, IN_PROGRESS, CLOSED, COMPLETED

Getting an Issue by Local Number

issueService.findByLocalId({projectId}, {localId}) => Issue

This method returns an issue with the specified number in the project. You need to provide the following values:

Name	Data Type	Description
projectId	string	Project UUID to search in
localId	number	Issue number in the project

Getting an Issue by UUID

This method returns an issue with the specified UUID in the project. You need to provide the following values:

issueService.findById({id}) => Issue

Name	Data Type	Description
id	string	Issue UUID

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.