Projects

Get a Project details¶

Parameters

Name	Description
id *	Numeric ID of the Project. Type: integer (path)

Responses

Code

Description

200

Project was retrieved successfully.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string"
}

404

Resource was not found.

Update a Project¶

Parameters

Name	Description
id *	Numeric ID of the Project. Type: integer (path)

Request body *

{
"name": "string"
}

Responses

Code

Description

200

Project was updated successfully.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string"
}

404

Resource was not found.

Delete a Project¶

Parameters

Name	Description
id *	Numeric ID of the Project. Type: integer (path)

Responses

Code	Description
200	Project was deleted successfully.
404	Resource was not found.

List Project Assignments Client¶

Parameters

No parameters

Request body *

{
"entityType": "TEST_NODE",
"entityIds": [0]
}

Responses

Code Description

200

Listing was processed successfully.

Media type: application/json

Example Value:

{
"entityType": "TEST_NODE",
"assignments": {
    "additionalProp1": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "additionalProp2": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "additionalProp3": [
        {
            "id": 0,
            "name": "string"
        }
    ]
}
}

The keys of assignments are the entity IDs from the request; an empty array means the entity is not assigned to any project.

404

Resource was not found.

Handle Project Assignments Client¶

Parameters

No parameters

Request body *

{
"entityType": "TEST_NODE",
"entityIds": [0],
"projectNames": ["string"]
}

Field	Description
entityType *	The type of the entities being assigned. Type: string One of: TEST_NODE, TEST_CASE, TEST_SUITE, MOBILE_ID, API_CLIENT, TRACE_FILTER, TOKEN
entityIds *	Numeric IDs of the entities to assign. Batches are supported — every ID in the list is processed in the same request. Type: array of integer
projectNames	The projects to assign, identified by name — this endpoint does not take project IDs. Type: array of string

Note: the request replaces the current assignments of each entity rather than adding to them. Projects that are not listed in projectNames are unassigned, so an empty or omitted projectNames clears every project assignment of the listed entities and still returns 200. Send the full set of project names the entity should end up with.

Note: every name must match an existing project. A name that does not match returns 400 with the message There is no project named '<name>'. Create it before assigning to it. Create the project first with POST /api/v2/projects.

Role: Standard and above. Any Standard or Admin user can assign any item; Guest users get 403.

Responses

Code	Description
200	Action was handled successfully. The response body is empty, and a 200 only confirms that the request was accepted — not which assignments it produced. Read the result back with `POST /api/v2/projects/listAssignments` or from the entity itself (its `projects` field).
400	A project name does not match an existing project, or the body is invalid.
403	Guest users cannot assign items to projects.
404	Resource was not found.

List Projects¶

Parameters

Name	Description
page	The page to list entries. Type: string (query) Default value: 0
size	The page size for listing entries. Type: string (query) Default value: 20
sort	The sort type for listing entries. Type: string (query)

Responses

Code

Description

200

OK

Media type: application/json

Example Value:

{
"totalElements": 0,
"totalPages": 0,
"number": 0,
"sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
},
"size": 0,
"content": [
    {
        "id": 0,
        "name": "string"
    }
],
"first": true,
"last": true,
"pageable": {
    "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0
},
"numberOfElements": 0,
"empty": true
}

Create a Project Client¶

Parameters

No parameters

Request body *

{
"name": "string",
"entityType": "TEST_NODE",
"entityIds": [0]
}

Responses

Code

Description

201

ID of the Project.

Media type: application/json

Example Value:

{
"id": 0
}

409

Name needs to be unique.