API docs by Redocly

Flow Inquiry API (1.0.0)

Download OpenAPI specification:Download

License: AGPLv3

Flow Inquiry REST API Documentation

Authentication

API endpoints for user authentication

Check authentication status

Checks if the current user is authenticated and returns the username

Authorizations:
bearer-jwt

Responses

Authenticate user

Authenticates a user and returns a JWT token

Authorizations:
bearer-jwt
Request Body schema: application/json
required
email
required
string [ 1 .. 50 ] characters
password
required
string [ 4 .. 100 ] characters
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "id_token": "string"
}

Entity Watchers

API for managing entity watchers/followers

Add watchers to entity

Adds multiple users as watchers/followers to a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., TICKET, PROJECT)
entityId
required
integer <int64>

ID of the entity
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Get watchers for entity

Retrieves all users watching/following a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., TICKET, PROJECT)
entityId
required
integer <int64>

ID of the entity

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "watchUserId": 0,
  • "watchUserName": "string",
  • "watcherImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": 0
}

Remove watcher

Removes a user from watching/following an entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., TICKET, PROJECT)
entityId
required
integer <int64>

ID of the entity
userId
required
integer <int64>

ID of the user to remove as watcher

Responses

Get watched entities for user

Retrieves all entities that a specific user is watching/following

Authorizations:
bearer-jwt
query Parameters
userId
required
integer <int64>

ID of the user
required
object (Pageable)

Pagination parameters

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "watchUserId": 0,
  • "watchUserName": "string",
  • "watcherImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": 0
}

Remove watchers from entity

Removes multiple users from watching/following a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., TICKET, PROJECT)
entityId
required
integer <int64>

ID of the entity
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Authorities

API endpoints for managing authorities and permissions

Get all authorities

Returns a paginated list of all authorities

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Create a new authority

Creates a new authority with the given details

Authorizations:
bearer-jwt
Request Body schema: application/json
required
name
required
string [ 0 .. 50 ] characters
descriptiveName
required
string [ 0 .. 50 ] characters
systemRole
boolean
description
string
Array of objects (User) unique
Array of objects (AuthorityResourcePermission) unique
usersCount
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "descriptiveName": "string",
  • "systemRole": true,
  • "description": "string",
  • "users": [
    ],
  • "authorityResourcePermissions": [
    ],
  • "usersCount": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "descriptiveName": "string",
  • "systemRole": true,
  • "usersCount": 0,
  • "description": "string"
}

Add users to authority

Adds multiple users to the specified authority

Authorizations:
bearer-jwt
path Parameters
authorityName
required
string

Name of the authority
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Get authority by name

Retrieves an authority by its name

Authorizations:
bearer-jwt
path Parameters
name
required
string

Name of the authority

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "descriptiveName": "string",
  • "systemRole": true,
  • "usersCount": 0,
  • "description": "string"
}

Get users by authority

Retrieves a paginated list of users with the specified authority

Authorizations:
bearer-jwt
path Parameters
authorityName
required
string

Name of the authority
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Search users not in authority

Searches for users that don't have the specified authority

Authorizations:
bearer-jwt
query Parameters
userTerm
required
string

Search term for user
authorityName
required
string

Name of the authority

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete authority

Deletes an authority by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
string

ID of the authority to delete

Responses

Remove user from authority

Removes a user from the specified authority

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to remove
authorityName
required
string

Name of the authority

Responses

Login

API endpoints for user login

Login user

Authenticates a user, returns user details with JWT token in header, and updates last login time

Authorizations:
bearer-jwt
Request Body schema: application/json
required
email
required
string [ 1 .. 50 ] characters
password
required
string [ 4 .. 100 ] characters
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Authority Permissions

API endpoints for managing authority resource permissions

Save multiple permissions

Saves a batch of authority resource permissions

Authorizations:
bearer-jwt
Request Body schema: application/json
required
Array
authorityName
string
resourceName
string
permission
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get permissions by authority

Retrieves all resource permissions associated with a specific authority

Authorizations:
bearer-jwt
path Parameters
authorityName
required
string

Name of the authority

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity Logs

API endpoints for managing activity logs

Get activity logs for an entity

Retrieves a paginated list of activity logs for a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string
Enum: "Team" "Ticket"

Type of entity to get activity logs for
entityId
required
integer <int64>

ID of the entity
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get activity logs for a user

Retrieves a paginated list of activity logs for a specific user

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Project Iteration Management

API endpoints for managing project iterations

Get iteration by ID

Retrieves a project iteration by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the iteration to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Update an existing iteration

Updates an existing project iteration with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the iteration to update
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
name
string
description
string
startDate
string <date-time>
endDate
string <date-time>
totalTickets
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Delete an iteration

Deletes a project iteration by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the iteration to delete

Responses

Create a new iteration

Creates a new project iteration with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
name
string
description
string
startDate
string <date-time>
endDate
string <date-time>
totalTickets
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Project Management

API endpoints for managing projects and related resources

Update an existing project

Updates an existing project with the provided information

Authorizations:
bearer-jwt
path Parameters
projectId
required
integer <int64>

ID of the project to update
Request Body schema: application/json
required
id
integer <int64>
name
required
string
description
string
shortName
required
string
teamId
required
integer <int64>
status
required
string
Enum: "Active" "Closed" "Cancelled"
startDate
string <date-time>
endDate
string <date-time>
createdBy
integer <int64>
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Delete a project

Deletes a project by its ID

Authorizations:
bearer-jwt
path Parameters
projectId
required
integer <int64>

ID of the project to delete

Responses

Create a new project

Creates a new project with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
name
required
string
description
string
shortName
required
string
teamId
required
integer <int64>
status
required
string
Enum: "Active" "Closed" "Cancelled"
startDate
string <date-time>
endDate
string <date-time>
createdBy
integer <int64>
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Search projects

Search for projects based on query criteria with pagination

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get project iterations

Retrieves all iterations associated with a specific project

Authorizations:
bearer-jwt
path Parameters
projectId
required
integer <int64>

ID of the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Get project epics

Retrieves all epics associated with a specific project

Authorizations:
bearer-jwt
path Parameters
projectId
required
integer <int64>

ID of the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Get project by ID

Retrieves a project by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the project to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Get project by short name

Retrieves a project by its short name

Authorizations:
bearer-jwt
path Parameters
shortName
required
string

Short name of the project to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "shortName": "string",
  • "teamId": 0,
  • "status": "Active",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

User Account

User account management API

Register a new user account

Creates a new user account and sends activation email

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
email
string
firstName
required
string non-empty
lastName
required
string non-empty
timezone
string
imageUrl
string
status
string
Enum: "ACTIVE" "PENDING"
isDeleted
boolean
langKey
string
lastLoginTime
string <date-time>
authorities
Array of strings unique
managerId
integer <int64>
managerName
string
managerImageUrl
string
about
string
address
string
city
string
state
string
country
string
title
string
createdBy
integer <int64>
createdAt
string <date-time>
lastModifiedBy
integer <int64>
modifiedAt
string <date-time>
resetKey
string
resetDate
string <date-time>
activationKey
string
password
string [ 4 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string",
  • "password": "string"
}

Response samples

Content type
application/json
"string"

Get current user account

Returns the authenticated user's account information

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Update user account

Updates the current user's account information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
email
string
firstName
required
string non-empty
lastName
required
string non-empty
timezone
string
imageUrl
string
status
string
Enum: "ACTIVE" "PENDING"
isDeleted
boolean
langKey
string
lastLoginTime
string <date-time>
authorities
Array of strings unique
managerId
integer <int64>
managerName
string
managerImageUrl
string
about
string
address
string
city
string
state
string
country
string
title
string
createdBy
integer <int64>
createdAt
string <date-time>
lastModifiedBy
integer <int64>
modifiedAt
string <date-time>
resetKey
string
resetDate
string <date-time>
activationKey
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Complete password reset

Completes the password reset process using the provided key and new password

Authorizations:
bearer-jwt
Request Body schema: application/json
required
key
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "newPassword": "string"
}

Change password

Changes the current user's password

Authorizations:
bearer-jwt
Request Body schema: application/json
required
currentPassword
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}

Resend activation email

Resends the activation email to the specified email address

Authorizations:
bearer-jwt
path Parameters
email
required
string

Email address of the user

Responses

Activate user account

Activates a registered user account using the provided activation key

Authorizations:
bearer-jwt
query Parameters
key
required
string

Activation key sent to the user's email

Responses

Request password reset

Sends an email with a link to reset the user's password

Authorizations:
bearer-jwt
query Parameters
email
required
string

Email address of the user

Responses

Notifications

API for managing user notifications

Mark notifications as read

Marks multiple notifications as read

Authorizations:
bearer-jwt
Request Body schema: application/json
required
notificationIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "notificationIds": [
    ]
}

Get user notifications

Retrieves paginated notifications for a specific user

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user
query Parameters
required
object (Pageable)

Pagination parameters

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "INFO",
  • "content": "string",
  • "userId": 0,
  • "isRead": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get unread notifications

Retrieves all unread notifications for a specific user

Authorizations:
bearer-jwt
query Parameters
userId
required
integer <int64>

ID of the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "INFO",
  • "content": "string",
  • "userId": 0,
  • "isRead": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Version

API for retrieving application version information

Get application version

Returns the current version and edition of the application

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
{
  • "version": "1.0.0",
  • "edition": "community"
}

Check for newer versions

Checks if a newer version of the application is available (not applicable for cloud edition)

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
{
  • "currentVersion": "1.0.0",
  • "isOutdated": true,
  • "latestVersion": "1.1.0"
}

Resources

API endpoints for managing resources

Get all resources

Retrieves a list of all available resources

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Project Settings Management

API endpoints for managing project settings

Update project settings

Updates existing project settings with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the project settings to update
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
sprintLengthDays
integer <int32>
defaultPriority
integer <int32>
estimationUnit
string
Enum: "STORY_POINTS" "DAYS"
enableEstimation
boolean
object
createdBy
integer <int64>
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "sprintLengthDays": 0,
  • "defaultPriority": 0,
  • "estimationUnit": "STORY_POINTS",
  • "enableEstimation": true,
  • "integrationSettings": {
    },
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "sprintLengthDays": 0,
  • "defaultPriority": 0,
  • "estimationUnit": "STORY_POINTS",
  • "enableEstimation": true,
  • "integrationSettings": {
    },
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Create project settings

Creates new project settings with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
sprintLengthDays
integer <int32>
defaultPriority
integer <int32>
estimationUnit
string
Enum: "STORY_POINTS" "DAYS"
enableEstimation
boolean
object
createdBy
integer <int64>
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "sprintLengthDays": 0,
  • "defaultPriority": 0,
  • "estimationUnit": "STORY_POINTS",
  • "enableEstimation": true,
  • "integrationSettings": {
    },
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "sprintLengthDays": 0,
  • "defaultPriority": 0,
  • "estimationUnit": "STORY_POINTS",
  • "enableEstimation": true,
  • "integrationSettings": {
    },
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Get project settings by project ID

Retrieves settings for a specific project

Authorizations:
bearer-jwt
path Parameters
projectId
required
integer <int64>

ID of the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "sprintLengthDays": 0,
  • "defaultPriority": 0,
  • "estimationUnit": "STORY_POINTS",
  • "enableEstimation": true,
  • "integrationSettings": {
    },
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Team Management

API endpoints for managing teams and team members

Update an existing team

Updates an existing team with the provided information and optional new logo image

Authorizations:
bearer-jwt
Request Body schema: multipart/form-data
required
object (TeamDTO)
file
string <binary>

New team logo image file (optional)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "organizationId": 0,
  • "usersCount": 0
}

Create a new team

Creates a new team with the provided information and optional logo image

Authorizations:
bearer-jwt
Request Body schema: multipart/form-data
required
object (TeamDTO)
file
string <binary>

Team logo image file (optional)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "organizationId": 0,
  • "usersCount": 0
}

Delete multiple teams

Deletes multiple teams by their IDs

Authorizations:
bearer-jwt
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Add users to a team

Adds multiple users to a team with a specified role

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
Request Body schema: application/json
required
userIds
Array of integers <int64> [ items <int64 > ]
role
string

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ],
  • "role": "string"
}

Search teams

Search for teams based on query criteria with pagination

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get user role in team

Retrieves the role of a specific user in a team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
userId
required
integer <int64>

ID of the user

Responses

Response samples

Content type
application/json
{
  • "role": "ADMIN"
}

Get team members

Retrieves all members of a specific team with their roles

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "title": "string",
  • "teamId": 0,
  • "teamRole": "string"
}

Check if team has a manager

Checks if a specific team has at least one manager

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team to check

Responses

Response samples

Content type
application/json
{
  • "result": true
}

Get team by ID

Retrieves a team by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the team to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "organizationId": 0,
  • "usersCount": 0
}

Delete a team

Deletes a team by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the team to delete

Responses

Get teams by user ID

Retrieves all teams that a specific user belongs to

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "organizationId": 0,
  • "usersCount": 0
}

Search for users not in a team

Searches for users that are not members of a specific team

Authorizations:
bearer-jwt
query Parameters
userTerm
required
string

Search term for finding users
teamId
required
integer <int64>

ID of the team

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Remove a user from a team

Removes a specific user from a team

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to remove
teamId
required
integer <int64>

ID of the team

Responses

Ticket Management

API endpoints for managing tickets and ticket-related operations

Get ticket by ID

Retrieves a ticket by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the ticket to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Update an existing ticket

Updates an existing ticket with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the ticket to update
Request Body schema: application/json
required
id
integer <int64>
teamId
required
integer <int64>
teamName
string
workflowId
required
integer <int64>
workflowName
string
workflowRequestName
string
projectId
integer <int64>
projectName
string
projectShortName
string
projectTicketNumber
integer <int64>
requestUserId
required
integer <int64>
requestUserName
string
requestUserImageUrl
string
assignUserId
integer <int64>
assignUserName
string
assignUserImageUrl
string
requestTitle
string
requestDescription
string
priority
required
string
estimatedCompletionDate
string <date>
actualCompletionDate
string <date>
currentStateId
required
integer <int64>
iterationId
integer <int64>
iterationName
string
epicId
integer <int64>
epicName
string
currentStateName
string
channel
string
Enum: "EMAIL" "PHONE" "WEB_PORTAL" "CHAT" "SOCIAL_MEDIA" "IN_PERSON" "MOBILE_APP" "API" "SYSTEM_GENERATED" "INTERNAL"
isNew
boolean
isCompleted
boolean
createdAt
string <date-time>
modifiedAt
string <date-time>
numberAttachments
integer <int32>
numberWatchers
integer <int32>
size
string
Enum: "S" "M" "L" "XL"
estimate
integer <int32>
object (TicketConversationHealthDTO)
parentTicketId
integer <int64>
childTicketIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Delete a ticket

Deletes a ticket by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the ticket to delete

Responses

Create a new ticket

Creates a new ticket with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
teamId
required
integer <int64>
teamName
string
workflowId
required
integer <int64>
workflowName
string
workflowRequestName
string
projectId
integer <int64>
projectName
string
projectShortName
string
projectTicketNumber
integer <int64>
requestUserId
required
integer <int64>
requestUserName
string
requestUserImageUrl
string
assignUserId
integer <int64>
assignUserName
string
assignUserImageUrl
string
requestTitle
string
requestDescription
string
priority
required
string
estimatedCompletionDate
string <date>
actualCompletionDate
string <date>
currentStateId
required
integer <int64>
iterationId
integer <int64>
iterationName
string
epicId
integer <int64>
epicName
string
currentStateName
string
channel
string
Enum: "EMAIL" "PHONE" "WEB_PORTAL" "CHAT" "SOCIAL_MEDIA" "IN_PERSON" "MOBILE_APP" "API" "SYSTEM_GENERATED" "INTERNAL"
isNew
boolean
isCompleted
boolean
createdAt
string <date-time>
modifiedAt
string <date-time>
numberAttachments
integer <int32>
numberWatchers
integer <int32>
size
string
Enum: "S" "M" "L" "XL"
estimate
integer <int32>
object (TicketConversationHealthDTO)
parentTicketId
integer <int64>
childTicketIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Search tickets

Search for tickets based on query criteria with pagination

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
required
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Update ticket state

Updates the state of a ticket to a new state

Authorizations:
bearer-jwt
path Parameters
ticketId
required
integer <int64>

ID of the ticket to update
Request Body schema: application/json
required
string

Request body containing the new state ID

Responses

Request samples

Content type
application/json
{
  • "newStateId": 123
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Get ticket state change history

Fetches the workflow transition history for a specific ticket

Authorizations:
bearer-jwt
path Parameters
ticketId
required
integer <int64>

ID of the ticket

Responses

Response samples

Content type
application/json
{
  • "ticketId": 0,
  • "transitions": [
    ]
}

Get previous ticket

Retrieves the previous ticket in sequence before the current ticket

Authorizations:
bearer-jwt
path Parameters
currentId
required
integer <int64>

ID of the current ticket
query Parameters
projectId
integer <int64>

Optional project ID filter

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Get next ticket

Retrieves the next ticket in sequence after the current ticket

Authorizations:
bearer-jwt
path Parameters
currentId
required
integer <int64>

ID of the current ticket
query Parameters
projectId
integer <int64>

Optional project ID filter

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "teamId": 0,
  • "teamName": "string",
  • "workflowId": 0,
  • "workflowName": "string",
  • "workflowRequestName": "string",
  • "projectId": 0,
  • "projectName": "string",
  • "projectShortName": "string",
  • "projectTicketNumber": 0,
  • "requestUserId": 0,
  • "requestUserName": "string",
  • "requestUserImageUrl": "string",
  • "assignUserId": 0,
  • "assignUserName": "string",
  • "assignUserImageUrl": "string",
  • "requestTitle": "string",
  • "requestDescription": "string",
  • "priority": "string",
  • "estimatedCompletionDate": "2019-08-24",
  • "actualCompletionDate": "2019-08-24",
  • "currentStateId": 0,
  • "iterationId": 0,
  • "iterationName": "string",
  • "epicId": 0,
  • "epicName": "string",
  • "currentStateName": "string",
  • "channel": "EMAIL",
  • "isNew": true,
  • "isCompleted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "numberAttachments": 0,
  • "numberWatchers": 0,
  • "size": "S",
  • "estimate": 0,
  • "conversationHealth": {
    },
  • "parentTicketId": 0,
  • "childTicketIds": [
    ]
}

Get team ticket priority distribution for a user

Retrieves the distribution of tickets by priority across teams for a specific user within a date range

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user
query Parameters
from
string <date-time>

Start date for the distribution calculation

to
string <date-time>

End date for the distribution calculation
range
string

Predefined date range (alternative to fromDate/toDate)

Responses

Response samples

Content type
application/json
{
  • "teamId": 0,
  • "teamName": "string",
  • "priority": "Critical",
  • "count": 0
}

Get overdue tickets for a user

Retrieves all overdue tickets assigned to a specific user with pagination

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get unassigned tickets for a team

Retrieves all unassigned tickets for a specific team with pagination

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get ticket distribution for a team

Retrieves the distribution of tickets for a specific team within a date range

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
fromDate
string <date-time>

Start date for the distribution calculation

toDate
string <date-time>

End date for the distribution calculation
range
string

Predefined date range (alternative to fromDate/toDate)

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "userName": "string",
  • "ticketCount": 0
}

Get ticket creation time series

Retrieves a time series of ticket creations by day for a specific team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
days
integer <int32>
Default: 7
Example: days=7

Number of days to include in the time series

Responses

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "createdCount": 0,
  • "closedCount": 0
}

Get ticket statistics for a team

Retrieves ticket statistics for a specific team within a date range

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
fromDate
string <date-time>

Start date for the statistics calculation
toDate
string <date-time>

End date for the statistics calculation
range
string

Predefined date range (alternative to fromDate/toDate)

Responses

Response samples

Content type
application/json
{
  • "totalTickets": 0,
  • "pendingTickets": 0,
  • "completedTickets": 0
}

Get priority distribution for a team

Retrieves the distribution of tickets by priority for a specific team within a date range

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
fromDate
string <date-time>

Start date for the distribution calculation

toDate
string <date-time>

End date for the distribution calculation
range
string

Predefined date range (alternative to fromDate/toDate)

Responses

Response samples

Content type
application/json
{
  • "priority": "Critical",
  • "ticketCount": 0
}

Get overdue tickets for a team

Retrieves all overdue tickets for a specific team with pagination

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
required
object (Pageable)

Pagination information

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Count overdue tickets for a team

Counts the number of overdue tickets for a specific team within a date range

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
fromDate
string <date-time>

Start date for counting overdue tickets
toDate
string <date-time>

End date for counting overdue tickets
range
string

Predefined date range (alternative to fromDate/toDate)

Responses

Response samples

Content type
application/json
0
0

Entity Attachments

API for managing file attachments associated with entities

Get entity attachments

Retrieve all file attachments associated with a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., 'ticket', 'comment')

entityId
required
integer <int64>

ID of the entity

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload entity attachments

Upload multiple files and associate them with a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string

Type of entity (e.g., 'ticket', 'comment')

entityId
required
integer <int64>

ID of the entity
Request Body schema: multipart/form-data
files
required
Array of strings <binary> [ items <binary > ]

Files to upload

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete attachment

Deletes a file attachment by its ID

Authorizations:
bearer-jwt
path Parameters
attachmentId
required
integer <int64>

ID of the attachment to delete

Responses

Project Epic Management

API endpoints for managing project epics

Get epic by ID

Retrieves a project epic by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the epic to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Update an existing epic

Updates an existing project epic with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the epic to update
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
name
string
description
string
startDate
string <date-time>
endDate
string <date-time>
totalTickets
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Delete an epic

Deletes a project epic by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the epic to delete

Responses

Create a new epic

Creates a new project epic with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
projectId
integer <int64>
name
string
description
string
startDate
string <date-time>
endDate
string <date-time>
totalTickets
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalTickets": 0
}

File Upload

API for uploading files to the storage system

Upload single file

Uploads a single file to the storage system with specified type and optional parent path

Authorizations:
bearer-jwt
query Parameters
type
required
string

Type of file (determines storage location)

parentPath
string

Optional parent path within the storage location

Request Body schema: multipart/form-data
file
required
string <binary>

File to upload

Responses

Response samples

Content type
application/json
{
  • "path": "images/example.jpg"
}

User Management

API endpoints for managing users

Update an existing user

Updates an existing user's information and optionally their avatar

Authorizations:
bearer-jwt
Request Body schema: multipart/form-data
required
object (UserDTO)
file
string <binary>

Optional avatar file to upload

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Create a new user

Creates a new user with the provided information (admin only)

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
email
string
firstName
required
string non-empty
lastName
required
string non-empty
timezone
string
imageUrl
string
status
string
Enum: "ACTIVE" "PENDING"
isDeleted
boolean
langKey
string
lastLoginTime
string <date-time>
authorities
Array of strings unique
managerId
integer <int64>
managerName
string
managerImageUrl
string
about
string
address
string
city
string
state
string
country
string
title
string
createdBy
integer <int64>
createdAt
string <date-time>
lastModifiedBy
integer <int64>
modifiedAt
string <date-time>
resetKey
string
resetDate
string <date-time>
activationKey
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Search all public users

Get all users with only public information - calling this method is allowed for anyone

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Update user locale

Updates the locale/language preference for the current user

Authorizations:
bearer-jwt
Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get user by ID

Retrieves a user by their ID

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Delete a user

Deletes a user by their ID

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to delete

Responses

Get user hierarchy

Retrieves the organizational hierarchy for a specific user with subordinates

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to retrieve hierarchy for

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "imageUrl": "string",
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "subordinates": [
    ]
}

Get direct reports

Retrieves all users that directly report to a specific manager

Authorizations:
bearer-jwt
path Parameters
managerId
required
integer <int64>

ID of the manager to retrieve direct reports for

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Search users by term

Searches for users matching the provided search term

Authorizations:
bearer-jwt
query Parameters
term
required
string

Search term to match against user properties

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "timezone": "string",
  • "imageUrl": "string",
  • "status": "ACTIVE",
  • "isDeleted": true,
  • "langKey": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "about": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "title": "string",
  • "createdBy": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "resetKey": "string",
  • "resetDate": "2019-08-24T14:15:22Z",
  • "activationKey": "string"
}

Get user permissions

Retrieves all resources with permissions for a specific user

Authorizations:
bearer-jwt
path Parameters
userId
required
integer <int64>

ID of the user to retrieve permissions for

Responses

Response samples

Content type
application/json
{
  • "resourceName": "string",
  • "permission": "string"
}

Get organization chart

Retrieves the complete organizational hierarchy chart

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "imageUrl": "string",
  • "managerId": 0,
  • "managerName": "string",
  • "managerImageUrl": "string",
  • "subordinates": [
    ]
}

Comments

API for managing entity comments

Get comments for entity

Retrieves all comments for a specific entity

Authorizations:
bearer-jwt
query Parameters
entityType
required
string
Enum: "Team" "Ticket"

Type of entity (e.g., TICKET, PROJECT)
entityId
required
integer <int64>

ID of the entity

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "createdById": 0,
  • "createdByName": "string",
  • "createdByImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityType": "Team",
  • "entityId": 0
}

Create or update comment

Creates a new comment or updates an existing one

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
content
string
createdById
integer <int64>
createdByName
string
createdByImageUrl
string
createdAt
string <date-time>
entityType
string
Enum: "Team" "Ticket"
entityId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "createdById": 0,
  • "createdByName": "string",
  • "createdByImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityType": "Team",
  • "entityId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "createdById": 0,
  • "createdByName": "string",
  • "createdByImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityType": "Team",
  • "entityId": 0
}

Get comment by ID

Retrieves a specific comment by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

Comment ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "createdById": 0,
  • "createdByName": "string",
  • "createdByImageUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityType": "Team",
  • "entityId": 0
}

Delete comment

Deletes a comment by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

Comment ID

Responses

Organization Management

API endpoints for managing organizations

Get organization by ID

Retrieves an organization by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the organization to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "teams": [
    ]
}

Update an existing organization

Updates an existing organization with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the organization to update
Request Body schema: application/json
required
id
integer <int64>
name
string
logoUrl
string
slogan
string
description
string
Array of objects (Team) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "teams": [
    ]
}

Delete an organization

Deletes an organization by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the organization to delete

Responses

Create a new organization

Creates a new organization with the provided information

Authorizations:
bearer-jwt
Request Body schema: application/json
required
id
integer <int64>
name
string
logoUrl
string
slogan
string
description
string
Array of objects (Team) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logoUrl": "string",
  • "slogan": "string",
  • "description": "string",
  • "teams": [
    ]
}

Search organizations

Search for organizations based on query criteria with pagination

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Workflow Management

API endpoints for managing workflows, workflow states, and transitions

Get workflow by ID

Retrieves a workflow by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the workflow to retrieve

Responses

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Update an existing workflow

Updates an existing workflow with the provided information

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the workflow to update
Request Body schema: application/json
required
createdBy
integer <int64>
createdByUserName
string
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedByUserName
string
modifiedAt
string <date-time>
id
integer <int64>
name
string
description
string
requestName
string
ownerId
integer <int64>
ownerName
string
visibility
string
Enum: "PUBLIC" "PRIVATE" "TEAM"
level1EscalationTimeout
integer <int32>
level2EscalationTimeout
integer <int32>
level3EscalationTimeout
integer <int32>
tags
string
useForProject
boolean

Responses

Request samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Delete a workflow

Deletes a workflow by its ID

Authorizations:
bearer-jwt
path Parameters
id
required
integer <int64>

ID of the workflow to delete

Responses

Response samples

Content type
application/json
"string"

Get detailed workflow information

Retrieves detailed workflow information including states and transitions

Authorizations:
bearer-jwt
path Parameters
workflowId
required
integer <int64>

ID of the workflow to retrieve details for

Responses

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Update a workflow with details

Updates an existing workflow with detailed information including states and transitions

Authorizations:
bearer-jwt
path Parameters
workflowId
required
integer <int64>

ID of the workflow to update
Request Body schema: application/json
required
createdBy
integer <int64>
createdByUserName
string
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedByUserName
string
modifiedAt
string <date-time>
id
integer <int64>
name
string
description
string
requestName
string
ownerId
integer <int64>
ownerName
string
visibility
string
Enum: "PUBLIC" "PRIVATE" "TEAM"
level1EscalationTimeout
integer <int32>
level2EscalationTimeout
integer <int32>
level3EscalationTimeout
integer <int32>
tags
string
useForProject
boolean
Array of objects (WorkflowStateDTO)
Array of objects (WorkflowTransitionDTO)

Responses

Request samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Create a workflow by cloning

Creates a new workflow for a team by cloning an existing workflow

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
workflowToCloneId
required
integer <int64>

ID of the workflow to clone
Request Body schema: application/json
required
createdBy
integer <int64>
createdByUserName
string
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedByUserName
string
modifiedAt
string <date-time>
id
integer <int64>
name
string
description
string
requestName
string
ownerId
integer <int64>
ownerName
string
visibility
string
Enum: "PUBLIC" "PRIVATE" "TEAM"
level1EscalationTimeout
integer <int32>
level2EscalationTimeout
integer <int32>
level3EscalationTimeout
integer <int32>
tags
string
useForProject
boolean

Responses

Request samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Create a workflow by reference

Creates a new workflow for a team by referencing an existing workflow

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
referencedWorkflowId
required
integer <int64>

ID of the workflow to reference
Request Body schema: application/json
required
createdBy
integer <int64>
createdByUserName
string
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedByUserName
string
modifiedAt
string <date-time>
id
integer <int64>
name
string
description
string
requestName
string
ownerId
integer <int64>
ownerName
string
visibility
string
Enum: "PUBLIC" "PRIVATE" "TEAM"
level1EscalationTimeout
integer <int32>
level2EscalationTimeout
integer <int32>
level3EscalationTimeout
integer <int32>
tags
string
useForProject
boolean

Responses

Request samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Search workflows

Search for workflows based on query criteria with pagination

Authorizations:
bearer-jwt
query Parameters
required
object (Pageable)

Pagination information
Request Body schema: application/json
Array of objects (GroupFilter)
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Create a new workflow with details

Creates a new workflow with detailed information including states and transitions

Authorizations:
bearer-jwt
Request Body schema: application/json
required
createdBy
integer <int64>
createdByUserName
string
createdAt
string <date-time>
modifiedBy
integer <int64>
modifiedByUserName
string
modifiedAt
string <date-time>
id
integer <int64>
name
string
description
string
requestName
string
ownerId
integer <int64>
ownerName
string
visibility
string
Enum: "PUBLIC" "PRIVATE" "TEAM"
level1EscalationTimeout
integer <int32>
level2EscalationTimeout
integer <int32>
level3EscalationTimeout
integer <int32>
tags
string
useForProject
boolean
Array of objects (WorkflowStateDTO)
Array of objects (WorkflowTransitionDTO)

Responses

Request samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Get valid target states for a workflow transition

Retrieves all valid target states for a given workflow and current state ID

Authorizations:
bearer-jwt
path Parameters
workflowId
required
integer <int64>

ID of the workflow
query Parameters
workflowStateId
required
integer <int64>

ID of the current workflow state
includeSelf
boolean
Default: false

Whether to include the current state in the results

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "workflowId": 0,
  • "stateName": "string",
  • "isInitial": true,
  • "isFinal": true
}

Get initial states of a workflow

Retrieves all initial states of a specific workflow

Authorizations:
bearer-jwt
path Parameters
workflowId
required
integer <int64>

ID of the workflow

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "workflowId": 0,
  • "stateName": "string",
  • "isInitial": true,
  • "isFinal": true
}

Get workflows by team

Retrieves all workflows associated with a specific team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
query Parameters
used_for_project
boolean

Filter for workflows used in projects

Responses

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Get project workflow by team

Retrieves the project workflow associated with a specific team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team

Responses

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true,
  • "states": [
    ],
  • "transitions": [
    ]
}

Get global workflows not linked to a team

Retrieves all global workflows that are not yet linked to a specific team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team

Responses

Response samples

Content type
application/json
{
  • "createdBy": 0,
  • "createdByUserName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": 0,
  • "modifiedByUserName": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "requestName": "string",
  • "ownerId": 0,
  • "ownerName": "string",
  • "visibility": "PUBLIC",
  • "level1EscalationTimeout": 0,
  • "level2EscalationTimeout": 0,
  • "level3EscalationTimeout": 0,
  • "tags": "string",
  • "useForProject": true
}

Delete a team's workflow

Deletes a workflow association with a specific team

Authorizations:
bearer-jwt
path Parameters
teamId
required
integer <int64>

ID of the team
workflowId
required
integer <int64>

ID of the workflow to delete

Responses

File Download

API for downloading files from the storage system

Download file

Downloads a file from the storage system based on the file path

Authorizations:
bearer-jwt

Responses

Application Settings

API for managing application settings

Get all settings

Retrieves all application settings, optionally filtered by group

Authorizations:
bearer-jwt
query Parameters
group
string

Optional group filter

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "type": "string",
  • "group": "string",
  • "description": "string"
}

Update multiple settings

Updates multiple application settings at once

Authorizations:
bearer-jwt
Request Body schema: application/json
required
Array
key
string
value
string
type
string
group
string
description
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get setting by key

Retrieves a specific application setting by its key

Authorizations:
bearer-jwt
path Parameters
key
required
string

Setting key

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "type": "string",
  • "group": "string",
  • "description": "string"
}

Update single setting

Updates a single application setting by its key

Authorizations:
bearer-jwt
path Parameters
key
required
string

Setting key
Request Body schema: application/json
required
key
string
value
string
type
string
group
string
description
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "type": "string",
  • "group": "string",
  • "description": "string"
}

Timezone

API for retrieving timezone information

Get all timezones

Returns a list of all available timezones with their offsets

Authorizations:
bearer-jwt

Responses

Response samples

Content type
application/json
{
  • "zoneId": "America/New_York",
  • "offset": "(GMT-05:00)"
}