Projects

/api/v2/projects/{id} 📋 Copied! 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.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string"
}
/api/v2/projects/{id} 📋 Copied! 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.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string"
}
/api/v2/projects/{id} 📋 Copied! 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.
409 Resource cannot be deleted.
/api/v2/projects/listAssignments 📋 Copied! 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"
        }
    ]
}
}
404

Resource was not found.

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"
        }
    ]
}
}
/api/v2/projects/assignments 📋 Copied! Handle Project Assignments Client ▼

Parameters

No parameters

Request body *

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

Responses

Code Description
200

Action was handled successfully.

Media type: application/json

Example Value:

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

Resource was not found.

Media type: application/json

Example Value:

{
"entityType": "TEST_NODE",
"entityIds": [0],
"projectIds": [0]
}
/api/v2/projects 📋 Copied! 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
}
/api/v2/projects 📋 Copied! 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.

Media type: application/json

Example Value:

{
"id": 0
}