Use this API to interact with project topics. For more information, see project topics.
List all topics
GET /api/v4/topics
Lists all project topics sorted by the number of associated projects.
Parameters
| Name | Type | Description |
|---|---|---|
searchQuery | String | Return list of topics matching the search criteria Example: search |
without_Query | Boolean | Return list of topics without assigned projects |
organization_Query | Integer | The organization id for the topics |
pageQuery | Integer | Current page number Default: 1Example: 1 |
per_Query | Integer | Number of items per page Default: 20Example: 20 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
Create a project topic
POST /api/v4/topics
Creates a project topic. Administrators only.
Request body (multipart/form-data)
| Property | Type | Description |
|---|---|---|
avatar | String (binary) | Avatar image for topic |
description | String | Description |
nameRequired | String | Slug (name) |
organization_ | Integer | The organization id for the topic |
titleRequired | String | Title |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
Merge topics
POST /api/v4/topics/merge
Merges a source topic into a target topic. This action deletes the source topic and moves all assigned projects to the target topic. Administrators only.
Request body (application/json)
| Property | Type | Description |
|---|---|---|
source_Required | Integer | ID of source project topic |
target_Required | Integer | ID of target project topic |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
Retrieve a topic
GET /api/v4/topics/{id}
Retrieves a specified project topic.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | Integer | ID of project topic |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
404 | Not Found | — |
Update a project topic
PUT /api/v4/topics/{id}
Updates a specified project topic. Administrators only.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | Integer | ID of project topic |
Request body (multipart/form-data)
| Property | Type | Description |
|---|---|---|
avatar | String (binary) | Avatar image for topic |
description | String | Description |
name | String | Slug (name) |
title | String | Title |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
404 | Not Found | — |
Delete a project topic
DELETE /api/v4/topics/{id}
Deletes a specified project topic. Administrators only.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | Integer | ID of project topic |
Responses
| Code | Description | Schema |
|---|---|---|
204 | Resource deleted | — |
400 | Bad Request | — |
404 | Not Found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesProjectsTopic
| Property | Type | Description |
|---|---|---|
avatar_ | String | Example:http: |
description | String | Example:A description |
id | Integer (int64) | Example:1 |
name | String | Example:topic1 |
organization_ | Integer (int64) | Example:1 |
title | String | Example:Topic 1 |
total_ | Integer | Example:1 |