Issue Methods

Project Issues

Description of the JSON object structure describing an issue

Field	Type	Description
`id`	String	Unique issue ID
`localId`	String	Local issue ID
`description`	String	Issue description
`title`	String	Issue alias
`status`	Set(Status)	Issue status
`assignedUsers`	Set(User)	Information about users assigned to the issue
`labels`	Set(Label)	Issue labels
`projectAlias`	String	Project alias
`userAlias`	String	Project owner alias
`updatedAt`	LocalDateTime	Last issue update time
`createdAt`	LocalDateTime	Issue creation time
`updatedBy`	User	Information about the last user who updated the issue

Description of the JSON object structure describing issue status

Field	Type	Description
`id`	String	Status ID
`title`	String	Status name
`hash`	String	Status hash
`alias`	String	Status alias
`ownerAlias`	String	Status owner alias
`color`	String	Status color name
`hexColor`	String	Color code
`icon`	String	Issue icon
`isDeleted`	Boolean	Whether the status is deleted

Description of the JSON object structure describing labels

Field	Type	Description
`id`	String	Label ID
`hexColor`	String	Label color code
`title`	String	Label name
`description`	String	Label description
`isTextLight`	Boolean	Determines label text color. `true` means white, `false` means black

You can find the structure of the JSON object describing a user here

Method for getting an issue

GET /project/{ownerAlias}/{projectAlias}/issue/{localId}

The request returns the project's issue by its local number.

Path variable	Type	Description
`ownerAlias`	String	Project owner alias
`projectAlias`	String	Project alias
`localId`	Long	Issue ID

Responses

STATUS 200 JSON example:

Example JSON body

    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Example description",
    "title": "Example title",
    "status": {
        "id": "COMPLETED",
        "title": "Completed",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "success",
        "hexColor": "28A745",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "error",
            "description": "Error in new feature",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 minutes ago",
    "createdAt": "1 month ago",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method for getting a list of issues

GET /project/{ownerAlias}/{projectAlias}/issue

The request returns a list of project issues

Path variable	Type	Description
`ownerAlias`	String	Project owner alias
`projectAlias`	String	Project alias

Responses

STATUS 200 JSON example:

Example JSON body

    
{
    "_embedded": {
        "issueModelList": [
            {
                "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
                "localId": 19,
                "description": "Example description",
                "title": "Example title",
                "status": {
                    "id": "COMPLETED",
                    "title": "Completed",
                    "hash": null,
                    "alias": null,
                    "ownerAlias": null,
                    "color": "success",
                    "hexColor": "28A745",
                    "icon": null,
                    "isDeleted": false
                },
                "assignedUsers": [
                    {
                        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                        "username": "USER",
                        "name": "user",
                        "surname": "name",
                        "fullName": "user name",
                        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
                        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
                    }
                ],
                "labels": [
                    {
                        "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
                        "hexColor": "F58A07",
                        "title": "error",
                        "description": "Error in new feature",
                        "isTextLight": false
                    }
                ],
                "projectAlias": "test_project",
                "userAlias": "USER",
                "updatedAt": "14 minutes ago",
                "createdAt": "1 month ago",
                "updatedBy": {
                    "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                    "username": "USER",
                    "name": "user",
                    "surname": "name",
                    "fullName": "user name",
                    "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
                    "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
                }
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method for creating an issue

POST /project/{ownerAlias}/{projectAlias}/issue

The request creates an issue with parameters and returns it

Path variable	Type	Description
`ownerAlias`	String	Project owner alias
`projectAlias`	String	Project alias

Request

Supported JSON format

POST request body structure:

Parameter	Type	Description
`title`	String	Issue title (required)
`description`	String	Issue description (required)
`status`	IssueStatus	Issue status. Accepts a list of `id` parameters: `OPEN`, `IN_PROGRESS`, `CLOSED`, or `COMPLETED`
`assignedUsers`	Set(User)	List of users responsible. Accepts a list of `id` parameters
`labels`	Set(Label)	List of labels. Accepts a list of `id` parameters

Example JSON object

{
    "title": "Example title",
    "description": "Example description",
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3"
        }
    ],
    "status":
        {
           "id": "OPEN"
        }
}

Responses

STATUS 200 JSON example:

Example JSON body

    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Example description",
    "title": "Example title",
    "status": {
        "id": "OPEN",
        "title": "New",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "error",
            "description": "Error in new feature",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 minutes ago",
    "createdAt": "1 month ago",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method for editing an issue

PUT /project/{ownerAlias}/{projectAlias}/issue/{localId}/edit

The request edits a project issue by parameters and returns it

Path variable	Type	Description
`ownerAlias`	String	Project owner alias
`projectAlias`	String	Project alias
`localId`	Long	Issue ID

Request

Supported JSON format

PUT request body structure:

Parameter	Type	Description
`title`	String	Issue title (required)
`description`	String	Issue description (required)
`status`	IssueStatus	Issue status. Accepts a list of `id` parameters: `OPEN`, `IN_PROGRESS`, `CLOSED`, or `COMPLETED`
`assignedUsers`	Set(User)	List of users responsible. Accepts a list of `id` parameters
`labels`	Set(Label)	List of labels. Accepts a list of `id` parameters

Example JSON object

{
    "title": "Example title",
    "description": "Example description",
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3"
        }
    ],
    "status":
        {
           "id": "OPEN"
        }
}

Responses

STATUS 200 JSON example:

Example JSON body

    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Example description",
    "title": "Example title",
    "status": {
        "id": "OPEN",
        "title": "New",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "error",
            "description": "Error in new feature",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 minutes ago",
    "createdAt": "1 month ago",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method for deleting an issue

DELETE /project/{ownerAlias}/{projectAlias}/issue/{localId}/delete

The request deletes an issue

Path variable	Type	Description
`ownerAlias`	String	Project owner alias
`projectAlias`	String	Project alias
`localId`	Long	Issue ID

Responses

STATUS 200 - Issue deleted successfully.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Automated translation!

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